You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# +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.
57
57
# The path should be relative to the docker context.
58
58
schemaFilePath: openapi.yaml
59
59
@@ -96,7 +96,7 @@ In the `endpoints` section of the `component.yaml` file, you can define multiple
96
96
| **service** | Required | Service details for the endpoint. |
97
97
| **.basePath** | Required | The base path of the API exposed via this endpoint. |
98
98
| **.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`.|
100
100
| **networkVisibilities** | Required | The network-level visibility of the endpoint. For example, project, organization, or public. |
101
101
| **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. |
102
102
@@ -139,16 +139,16 @@ spec:
139
139
# +required Numeric port value that gets exposed via the endpoint
140
140
port: 9090
141
141
# +required Type of traffic that the endpoint is accepting.
# +optional Network level visibility of this endpoint. Defaults to Public
224
224
# Accepted values: Project|Organization|Public.
225
225
networkVisibility: Project
226
226
# +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 RESTor GraphQL.
228
228
context: /greeting
229
229
# +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.
231
231
# The path should be relative to the docker context.
232
232
schemaFilePath: greeting_openapi.yaml
233
233
```
@@ -241,7 +241,7 @@ You can define the following root-level configurations via the `endpoints.yaml`
241
241
| **version** | Required | The version of the `endpoints.yaml` file. |
242
242
| **name** | Required | A unique name for the endpoint, which Choreo will use to generate the managed API.|
243
243
| **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. |
245
245
| **networkVisibility**| Required | The network level visibility of this endpoint, which defaults to `Public` if not specified. Accepted values are `Project`, `Organization`, or `Public`.|
246
246
| **context** | Required | The context (base path) of the API that Choreo exposes via this endpoint. |
247
247
| **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