Merge pull request #1620 from wso2/revert-1560-dev

Revert "Add documentation for WebSocket Endpoints"
wso2 · Oct 24, 2024 · 5078999 · 5078999
2 parents 6080fb2 + a7e4446
commit 5078999
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 176 deletions.
diff --git a/en/.spelling b/en/.spelling
@@ -699,10 +699,6 @@ headerName
 fooValue
 authzHeaderValue
 myResourcePath
-WebSocket
-WebSockets
-expose-a-nodejs-websocket-endpoint-via-a-service
-test-websocket-endpoints-via-the-websocket-console
 schemaVersion
 displayName
 basePath

diff --git a/en/docs/assets/img/testing/websocket-console.png b/en/docs/assets/img/testing/websocket-console.png
diff --git a/en/docs/develop-components/configure-endpoints-body.md b/en/docs/develop-components/configure-endpoints-body.md
@@ -7,7 +7,7 @@ Choreo defines endpoints by combining port binding, protocol, endpoint name, net
 | ----- | ----------- |
 | Name | A unique identifier for the endpoint within the service component. |
 | Port | The network port on which the endpoint is accessible. |
-| Type | The endpoint protocol. Supported protocols: REST, GraphQL, gRPC, WS, UDP, and TCP. |
+| Type | The endpoint protocol. Supported protocols: REST, GraphQL, gRPC, UDP, and TCP. |
 | Network Visibility | Determines the level of visibility of an endpoint. Possible values are: <ul><li>Project: Allows components within the same project to access the endpoint.</li><li>Organization: Allows any component within the same organization to access the endpoint but restricts access to components outside the organization.</li><li>Public: Allows any client to access the endpoint, regardless of location or organization.</li></ul> |
 | Schema | Specifies the structure and format of the data exchanged through the endpoint. |
 | Context (HTTP and GraphQL only) | A context path that you add to the endpoint's URL for routing purposes. |

diff --git a/...components/develop-services/expose-a-nodejs-websocket-endpoint-via-a-service.md b/...components/develop-services/expose-a-nodejs-websocket-endpoint-via-a-service.md
diff --git a/en/docs/develop-components/develop-services/service-component-overview.md b/en/docs/develop-components/develop-services/service-component-overview.md
@@ -4,7 +4,7 @@ Explore how to create, deploy, manage, and observe service components in Choreo.
 
 ## What is a service component?
 
-A service component in Choreo lets you deploy and expose REST, GraphQL, gRPC, UDP, WS or TCP services. It is a fundamental building block for creating cloud-native applications in Choreo. They provide a simple and effective way to expose functionality as a service to other components within Choreo or to the outside world.
+A service component in Choreo lets you deploy and expose REST, GraphQL, gRPC, UDP, or TCP services. It is a fundamental building block for creating cloud-native applications in Choreo. They provide a simple and effective way to expose functionality as a service to other components within Choreo or to the outside world.
 
 Service components encapsulate business logic and provide standardized interfaces, called endpoints, for communicating with other components or systems. You can deploy and scale services independently, which makes them highly flexible and adaptable to changing workloads.
 

diff --git a/en/docs/references/choreo-limitations.md b/en/docs/references/choreo-limitations.md
@@ -8,19 +8,17 @@ Below are key limitations when working with APIs in Choreo:
 
 |Resource                             |  Limit                                                                                      |
 |-------------------------------------|---------------------------------------------------------------------------------------------|
-| Maximum request payload             |  10 MB                                                                                      |
-| URL size                            |  2 KB                                                                                       |
-| Request header                      | <ul><li>Request Headers total: 40 KB</li><li>Max Single Request header: 10 KB</li></ul>     |
-| Total request duration              | <ul><li>Minimum: 10 seconds</li><li>Default: 1 minute</li><li>Maximum: 5 minutes</li></ul>  |
-| Maximum connection duration (WebSocket APIs)  |  15  minutes                                                                      |
-| Connection idle timeout (WebSocket APIs)                            |  5 minutes                                                  |
-| Size for API definition (OpenAPI document)| 10 Mb                                                                                 |
+| Maximum request payload             |  10 MB                                                                                       |
+| URL size                            |  2 KB                                                                                         |
+| Request header                      | <ul><li>Request Headers total: 40 KB</li><li>Max Single Request header: 10 KB</li></ul>       |
+| Total request duration              | <ul><li>Minimum: 10 seconds</li><li>Default: 1 minute</li><li>Maximum: 5 minutes</li></ul>             |
+| Size for API Definition (OpenAPI document)| 10 Mb                                                                                  |
 | Number of APIs for PDP                 | 1000 API deployments                                                                     |
-| Number of APIs per organization (free tier)                 | 5 APIs for free users                                               |
-| Number of Developer Portal applications per organization (free tier)  | 10 applications for free users                            |
+| Number of APIs per organization (free tier)                 | 5 APIs for free users                                                                    |
+| Number of Developer Portal applications per organization (free tier)  | 10 applications for free users                                                          |
 
 
-## Choreo cloud data plane limits
+## Choreo Cloud Data Plane limits
 
 Below are key limitations when working with web applications in the Choreo cloud data plane:
 

diff --git a/en/docs/testing/test-websocket-endpoints-via-the-websocket-console.md b/en/docs/testing/test-websocket-endpoints-via-the-websocket-console.md
diff --git a/en/mkdocs.yml b/en/mkdocs.yml
@@ -104,7 +104,6 @@ nav:
           - Expose a UDP Server via a Service: develop-components/develop-services/expose-a-udp-server-via-a-service.md
           - Expose a Ballerina GraphQL Endpoint via a Service: develop-components/develop-services/expose-a-ballerina-graphql-endpoint-via-a-service.md
           - Expose a Prism-Based Mock Server Using an OpenAPI Specification: develop-components/develop-services/expose-a-prism-based-mock-server-using-an-openapi-specification.md
-          - Expose a WebSocket Endpoint via a NodeJS Service: develop-components/develop-services/expose-a-nodejs-websocket-endpoint-via-a-service.md
       - Develop an API Proxy: develop-components/develop-an-api-proxy.md
       - Develop Web Applications: 
           - Build and Deploy a Single-Page Web Application: develop-components/develop-web-applications/build-and-deploy-a-single-page-web-application.md
@@ -169,7 +168,6 @@ nav:
   - Testing: 
       - Test REST Endpoints via the OpenAPI Console: testing/test-rest-endpoints-via-the-openapi-console.md
       - Test GraphQL Endpoints via the GraphQL Console: testing/test-graphql-endpoints-via-the-graphql-console.md
-      - Test WebSocket Endpoints via the WebSocket Console: testing/test-websocket-endpoints-via-the-websocket-console.md
       - Test APIs with cURL: testing/test-apis-with-curl.md
       - Test APIs with Choreo API Chat: testing/test-apis-with-choreo-apichat.md
       - Test Components with Test Runner: testing/test-components-with-test-runner.md