From 128f6b0d1c1406aa403d5be57cf9cab4daa9a8b6 Mon Sep 17 00:00:00 2001 From: Luana Dos Santos Date: Mon, 4 May 2026 20:55:32 -0300 Subject: [PATCH 1/3] Add GraphQL and WebSocket asset type docs. Update API instance creation docs to include GraphQL and WebSocket (AsyncAPI) options in asset type guidance and overview so supported protocols are clearly documented for Flex and Mule flows. Co-authored-by: Cursor --- .../ROOT/pages/_partials/task-add-api-instance.adoc | 12 ++++++++++++ modules/ROOT/pages/getting-started-proxy.adoc | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index d003434b..3be1eb88 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -139,6 +139,12 @@ Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. +** **GraphQL API:** Select this option if you have a GraphQL schema definition file you want to include for your asset. ++ +Upload the GraphQL schema definition for your GraphQL API. +** **WebSocket API (AsyncAPI):** Select this option if you have a WebSocket API definition file you want to include for your asset. ++ +Upload an AsyncAPI YAML or JSON file for your WebSocket API. .. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version. + @@ -158,6 +164,12 @@ Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. +** **GraphQL API:** Select this option if you have a GraphQL schema definition file you want to include for your asset. ++ +Upload the GraphQL schema definition for your GraphQL API. +** **WebSocket API (AsyncAPI):** Select this option if you have a WebSocket API definition file you want to include for your asset. ++ +Upload an AsyncAPI YAML or JSON file for your WebSocket API. .. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version. + diff --git a/modules/ROOT/pages/getting-started-proxy.adoc b/modules/ROOT/pages/getting-started-proxy.adoc index 20bac415..d1fce0e6 100644 --- a/modules/ROOT/pages/getting-started-proxy.adoc +++ b/modules/ROOT/pages/getting-started-proxy.adoc @@ -13,7 +13,7 @@ You can manage your instance using the following steps: . xref:exchange::to-create-an-asset.adoc#create-an-api-asset[Create an API asset in Exchange] + -You can create a REST, HTTP, SOAP, or gRPC API asset in Exchange and manage it as an API instance +You can create a REST, HTTP, SOAP, gRPC, GraphQL, or AsyncAPI (WebSocket) API asset in Exchange and manage it as an API instance in API Manager. . xref:create-instance-task.adoc[Add an API Instance in API Manager] + From e45288c7d10d0c2bf31de9ca55f0cafda91f82ea Mon Sep 17 00:00:00 2001 From: Luana Dos Santos Date: Thu, 7 May 2026 15:42:24 -0300 Subject: [PATCH 2/3] fix websocket http type --- .../ROOT/pages/_partials/task-add-api-instance.adoc | 10 ++-------- modules/ROOT/pages/getting-started-proxy.adoc | 2 +- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index 3be1eb88..800a00e8 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -135,16 +135,13 @@ For more information about versions in Exchange, see xref:exchange::asset-versio ** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. + Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML. -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. +** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. ** **GraphQL API:** Select this option if you have a GraphQL schema definition file you want to include for your asset. + Upload the GraphQL schema definition for your GraphQL API. -** **WebSocket API (AsyncAPI):** Select this option if you have a WebSocket API definition file you want to include for your asset. -+ -Upload an AsyncAPI YAML or JSON file for your WebSocket API. .. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version. + @@ -160,16 +157,13 @@ For more information about versions in Exchange, see xref:exchange::asset-versio ** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. + Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML. -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. +** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. ** **GraphQL API:** Select this option if you have a GraphQL schema definition file you want to include for your asset. + Upload the GraphQL schema definition for your GraphQL API. -** **WebSocket API (AsyncAPI):** Select this option if you have a WebSocket API definition file you want to include for your asset. -+ -Upload an AsyncAPI YAML or JSON file for your WebSocket API. .. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version. + diff --git a/modules/ROOT/pages/getting-started-proxy.adoc b/modules/ROOT/pages/getting-started-proxy.adoc index d1fce0e6..e4bf175c 100644 --- a/modules/ROOT/pages/getting-started-proxy.adoc +++ b/modules/ROOT/pages/getting-started-proxy.adoc @@ -13,7 +13,7 @@ You can manage your instance using the following steps: . xref:exchange::to-create-an-asset.adoc#create-an-api-asset[Create an API asset in Exchange] + -You can create a REST, HTTP, SOAP, gRPC, GraphQL, or AsyncAPI (WebSocket) API asset in Exchange and manage it as an API instance +You can create a REST, HTTP (including the WebSocket subtype), SOAP, gRPC, or GraphQL API asset in Exchange and manage it as an API instance in API Manager. . xref:create-instance-task.adoc[Add an API Instance in API Manager] + From ff329d0d0852c8dd11a45b65dd228edab4375d0f Mon Sep 17 00:00:00 2001 From: Luana Dos Santos Date: Thu, 7 May 2026 15:59:02 -0300 Subject: [PATCH 3/3] fixed 2 --- modules/ROOT/pages/_partials/task-add-api-instance.adoc | 4 ++-- modules/ROOT/pages/getting-started-proxy.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index 800a00e8..50eafdbd 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -135,7 +135,7 @@ For more information about versions in Exchange, see xref:exchange::asset-versio ** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. + Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML. -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. +** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. WebSocket instances can use HTTP or AsyncAPI assets from Exchange. ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. @@ -157,7 +157,7 @@ For more information about versions in Exchange, see xref:exchange::asset-versio ** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. + Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML. -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. +** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. For WebSocket APIs, select HTTP and then choose the WebSocket subtype when selecting the API from Exchange. WebSocket instances can use HTTP or AsyncAPI assets from Exchange. ** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. + Upload a WSDL file for your SOAP API or add the link to the file. diff --git a/modules/ROOT/pages/getting-started-proxy.adoc b/modules/ROOT/pages/getting-started-proxy.adoc index e4bf175c..a418c540 100644 --- a/modules/ROOT/pages/getting-started-proxy.adoc +++ b/modules/ROOT/pages/getting-started-proxy.adoc @@ -13,7 +13,7 @@ You can manage your instance using the following steps: . xref:exchange::to-create-an-asset.adoc#create-an-api-asset[Create an API asset in Exchange] + -You can create a REST, HTTP (including the WebSocket subtype), SOAP, gRPC, or GraphQL API asset in Exchange and manage it as an API instance +You can create a REST, HTTP (including the WebSocket subtype), AsyncAPI, SOAP, gRPC, or GraphQL API asset in Exchange and manage it as an API instance in API Manager. . xref:create-instance-task.adoc[Add an API Instance in API Manager] +