Skip to content

Commit 6080fb2

Browse files
authored
Merge pull request #1619 from wso2/revert-1615-revert-1613-ws-patch-1
Revert "Revert "Remove WS""
2 parents 97305aa + 9fce302 commit 6080fb2

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

en/docs/develop-components/manage-component-source-configurations.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ endpoints:
4040
# +required Service section has the user service endpoint details
4141
service:
4242
# +optional Base path of the API that gets exposed via the endpoint.
43-
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
43+
# This is mandatory if the endpoint type is set to REST or GraphQL.
4444
basePath: /greeting-service
4545
# +required Numeric port value that gets exposed via the endpoint
4646
port: 9090
4747
# +required Type of traffic that the endpoint is accepting.
48-
# Allowed values: REST, GraphQL, GRPC, TCP, UDP, WS.
48+
# Allowed values: REST, GraphQL, GRPC, TCP, UDP.
4949
type: REST
5050
# +optional Network level visibilities of the endpoint.
5151
# Accepted values: Project|Organization|Public(Default).
5252
networkVisibilities:
5353
- Public
5454
- Organization
5555
# +optional Path to the schema definition file. Defaults to wild card route if not provided
56-
# This is only applicable to REST and WS endpoint types.
56+
# This is only applicable to REST endpoint types.
5757
# The path should be relative to the docker context.
5858
schemaFilePath: openapi.yaml
5959

@@ -96,7 +96,7 @@ In the `endpoints` section of the `component.yaml` file, you can define multiple
9696
| **service** | Required | Service details for the endpoint. |
9797
|       **.basePath** | Required | The base path of the API exposed via this endpoint. |
9898
|       **.port** | Required | The numeric port value exposed via this endpoint. |
99-
| **type** | Required | The type of traffic the endpoint accepts. For example, `REST`, `GraphQL`, `gRPC`, `WS`, `UDP`, or `TCP`.|
99+
| **type** | Required | The type of traffic the endpoint accepts. For example, `REST`, `GraphQL`, `gRPC`, `UDP`, or `TCP`.|
100100
| **networkVisibilities** | Required | The network-level visibility of the endpoint. For example, project, organization, or public. |
101101
| **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. |
102102

@@ -139,16 +139,16 @@ spec:
139139
# +required Numeric port value that gets exposed via the endpoint
140140
port: 9090
141141
# +required Type of traffic that the endpoint is accepting.
142-
# Allowed values: REST, GraphQL, GRPC, TCP, UDP, WS.
142+
# Allowed values: REST, GraphQL, GRPC, TCP, UDP.
143143
type: REST
144144
# +optional Network level visibility of the endpoint. Defaults to Public
145145
# Accepted values: Project|Organization|Public.
146146
networkVisibility: Public
147147
# +optional Context (base path) of the API that gets exposed via the endpoint.
148-
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
148+
# This is mandatory if the endpoint type is set to REST or GraphQL.
149149
context: /greeting
150150
# +optional The path to the schema definition file. Defaults to wildcard route if not specified.
151-
# This is only applicable to REST and WS endpoint types.
151+
# This is only applicable to REST endpoint type.
152152
# The path should be relative to the Docker context.
153153
schemaFilePath: greeting_openapi.yaml
154154
# +optional Outgoing connection details for the component.
@@ -218,16 +218,16 @@ endpoints:
218218
# +required Numeric port value that gets exposed via this endpoint
219219
port: 9090
220220
# +required Type of the traffic this endpoint is accepting.
221-
# Allowed values: REST, GraphQL, GRPC, UDP, TCP, WS.
221+
# Allowed values: REST, GraphQL, GRPC, UDP, TCP.
222222
type: REST
223223
# +optional Network level visibility of this endpoint. Defaults to Public
224224
# Accepted values: Project|Organization|Public.
225225
networkVisibility: Project
226226
# +optional Context (base path) of the API that is exposed via this endpoint.
227-
# This is mandatory if the endpoint type is set to REST, GraphQL or WS.
227+
# This is mandatory if the endpoint type is set to REST or GraphQL.
228228
context: /greeting
229229
# +optional Path to the schema definition file. Defaults to wild card route if not provided
230-
# This is only applicable to REST and WS endpoint types.
230+
# This is only applicable to REST endpoint type.
231231
# The path should be relative to the docker context.
232232
schemaFilePath: greeting_openapi.yaml
233233
```
@@ -241,7 +241,7 @@ You can define the following root-level configurations via the `endpoints.yaml`
241241
| **version** | Required | The version of the `endpoints.yaml` file. |
242242
| **name** | Required | A unique name for the endpoint, which Choreo will use to generate the managed API.|
243243
| **port** | Required | The numeric port value that gets exposed via this endpoint. |
244-
| **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. |
244+
| **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. |
245245
| **networkVisibility**| Required | The network level visibility of this endpoint, which defaults to `Public` if not specified. Accepted values are `Project`, `Organization`, or `Public`.|
246246
| **context** | Required | The context (base path) of the API that Choreo exposes via this endpoint. |
247247
| **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.|

0 commit comments

Comments
 (0)