Skip to content

Commit

Permalink
Merge pull request #1619 from wso2/revert-1615-revert-1613-ws-patch-1
Browse files Browse the repository at this point in the history
Revert "Revert "Remove WS""
  • Loading branch information
Nashaath authored Oct 24, 2024
2 parents 97305aa + 9fce302 commit 6080fb2
Showing 1 changed file with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,20 @@ endpoints:
# +required Service section has the user service endpoint details
service:
# +optional Base path of the API that gets exposed via the endpoint.
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
# This is mandatory if the endpoint type is set to REST or GraphQL.
basePath: /greeting-service
# +required Numeric port value that gets exposed via the endpoint
port: 9090
# +required Type of traffic that the endpoint is accepting.
# Allowed values: REST, GraphQL, GRPC, TCP, UDP, WS.
# Allowed values: REST, GraphQL, GRPC, TCP, UDP.
type: REST
# +optional Network level visibilities of the endpoint.
# Accepted values: Project|Organization|Public(Default).
networkVisibilities:
- Public
- Organization
# +optional Path to the schema definition file. Defaults to wild card route if not provided
# This is only applicable to REST and WS endpoint types.
# This is only applicable to REST endpoint types.
# The path should be relative to the docker context.
schemaFilePath: openapi.yaml

Expand Down Expand Up @@ -96,7 +96,7 @@ In the `endpoints` section of the `component.yaml` file, you can define multiple
| **service** | Required | Service details for the endpoint. |
|       **.basePath** | Required | The base path of the API exposed via this endpoint. |
|       **.port** | Required | The numeric port value exposed via this endpoint. |
| **type** | Required | The type of traffic the endpoint accepts. For example, `REST`, `GraphQL`, `gRPC`, `WS`, `UDP`, or `TCP`.|
| **type** | Required | The type of traffic the endpoint accepts. For example, `REST`, `GraphQL`, `gRPC`, `UDP`, or `TCP`.|
| **networkVisibilities** | Required | The network-level visibility of the endpoint. For example, project, organization, or public. |
| **schemaFilePath** | Required | The file path to the swagger definition file. Defaults to the wildcard route if not specified. This field should be a relative path to the project path when using **Java**, **Python**, **NodeJS**, **Go**, **PHP**, **Ruby**, or **WSO2 MI** buildpacks. For REST endpoint types, when using the **Ballerina** or **Dockerfile** buildpack, the path should be relative to the component root or Docker context. |

Expand Down Expand Up @@ -139,16 +139,16 @@ spec:
# +required Numeric port value that gets exposed via the endpoint
port: 9090
# +required Type of traffic that the endpoint is accepting.
# Allowed values: REST, GraphQL, GRPC, TCP, UDP, WS.
# Allowed values: REST, GraphQL, GRPC, TCP, UDP.
type: REST
# +optional Network level visibility of the endpoint. Defaults to Public
# Accepted values: Project|Organization|Public.
networkVisibility: Public
# +optional Context (base path) of the API that gets exposed via the endpoint.
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
# This is mandatory if the endpoint type is set to REST or GraphQL.
context: /greeting
# +optional The path to the schema definition file. Defaults to wildcard route if not specified.
# This is only applicable to REST and WS endpoint types.
# This is only applicable to REST endpoint type.
# The path should be relative to the Docker context.
schemaFilePath: greeting_openapi.yaml
# +optional Outgoing connection details for the component.
Expand Down Expand Up @@ -218,16 +218,16 @@ endpoints:
# +required Numeric port value that gets exposed via this endpoint
port: 9090
# +required Type of the traffic this endpoint is accepting.
# Allowed values: REST, GraphQL, GRPC, UDP, TCP, WS.
# Allowed values: REST, GraphQL, GRPC, UDP, TCP.
type: REST
# +optional Network level visibility of this endpoint. Defaults to Public
# Accepted values: Project|Organization|Public.
networkVisibility: Project
# +optional Context (base path) of the API that is exposed via this endpoint.
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
# This is mandatory if the endpoint type is set to REST or GraphQL.
context: /greeting
# +optional Path to the schema definition file. Defaults to wild card route if not provided
# This is only applicable to REST and WS endpoint types.
# This is only applicable to REST endpoint type.
# The path should be relative to the docker context.
schemaFilePath: greeting_openapi.yaml
```
Expand All @@ -241,7 +241,7 @@ You can define the following root-level configurations via the `endpoints.yaml`
| **version** | Required | The version of the `endpoints.yaml` file. |
| **name** | Required | A unique name for the endpoint, which Choreo will use to generate the managed API.|
| **port** | Required | The numeric port value that gets exposed via this endpoint. |
| **type** | Required | The type of traffic this endpoint accepts, such as `REST`, `GraphQL`, `gRPC`, `WS`, `UDP`, or `TCP`. Currently, the MI preset supports only the `REST` type. |
| **type** | Required | The type of traffic this endpoint accepts, such as `REST`, `GraphQL`, `gRPC`, `UDP`, or `TCP`. Currently, the MI preset supports only the `REST` type. |
| **networkVisibility**| Required | The network level visibility of this endpoint, which defaults to `Public` if not specified. Accepted values are `Project`, `Organization`, or `Public`.|
| **context** | Required | The context (base path) of the API that Choreo exposes via this endpoint. |
| **schemaFilePath** | Required | The swagger definition file path. Defaults to the wildcard route if not provided. This field should be a relative path to the project path when using the **Java**, **Python**, **NodeJS**, **Go**, **PHP**, **Ruby**, and **WSO2 MI** buildpacks. For REST endpoint types, when using the **Ballerina** or **Dockerfile** buildpack, this field should be a relative path to the component root or Docker context.|
Expand Down

0 comments on commit 6080fb2

Please sign in to comment.