Skip to content

W-22353500-Add GraphQL and WebSocket asset type docs. #652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luanamulesoft merged 4 commits into from
May 7, 2026
+9 −3
Merged

W-22353500-Add GraphQL and WebSocket asset type docs. #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
128f6b0
Add GraphQL and WebSocket asset type docs.
luanamulesoft May 4, 2026
e45288c
fix websocket http type
luanamulesoft May 7, 2026
ff329d0
fixed 2
luanamulesoft May 7, 2026
910b927
Merge branch 'flex-1-13-release-branch' into W-22353500-graphql-webS-…
luanamulesoft May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions modules/ROOT/pages/_partials/task-add-api-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +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. 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.
** **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.

.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
+
Expand All @@ -154,10 +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. 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.
** **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.

.. Update the *Asset type*, *API version*, and *Asset version* if you are not using the latest version.
+
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/getting-started-proxy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (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]
+
Expand Down