diff --git a/en/docs/deploy-and-publish/deploy-on-gateway/choreo-connect/security/rejecting-revoked-tokens.md b/en/docs/deploy-and-publish/deploy-on-gateway/choreo-connect/security/rejecting-revoked-tokens.md index cfa81601c8..106678a1ff 100644 --- a/en/docs/deploy-and-publish/deploy-on-gateway/choreo-connect/security/rejecting-revoked-tokens.md +++ b/en/docs/deploy-and-publish/deploy-on-gateway/choreo-connect/security/rejecting-revoked-tokens.md @@ -87,20 +87,20 @@ Here are the steps to revoke an API Key. 2. Generate an API Key from API-M by following the steps in [Secure APIs with API Keys]({{base_path}}/design/api-security/api-authentication/secure-apis-using-api-keys). -3. Get an access token to the Control Plane (API-M) by referring to [this section]({{base_path}}/reference/product-apis/devportal-apis/devportal-v3/devportal-v3/#section/Authentication). Remember to include `apim:api_key` as a scope when requesting the access token. +3. Get an access token to the Control Plane (API-M) by referring to [this section]({{base_path}}/reference/product-apis/devportal-apis/devportal-v4/devportal-v4/#section/Authentication). Remember to include `apim:api_key` as a scope when requesting the access token. 4. Revoke the API Key by calling the following API from the Control Plane. ``` tab="Format" - curl -k -v -H "Authorization: Bearer " -d '{ "apikey" : "" }' -H "Content-Type: application/json" "https://localhost:9443/api/am/devportal/v3/applications//api-keys//revoke" + curl -k -v -H "Authorization: Bearer " -d '{ "apikey" : "" }' -H "Content-Type: application/json" "https://localhost:9443/api/am/devportal/v4/applications//api-keys//revoke" ``` ``` tab="Example" - curl -k -H "Authorization: Bearer e4cb79d6-c22e-386a-a1eb-0494208e9976" -H "Content-Type: application/json" -X POST -d '{ "apikey" : "eyJ4NXQiOiJOMkpqTWpOaU0yRXhZalJrTnpaalptWTFZVEF4Tm1GbE5qZzRPV1UxWVdRMll6YzFObVk1TlE9PSIsImtpZCI6ImdhdGV3YXlfY2VydGlmaWNhdGVfYWxpYXMiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhcHBsaWNhdGlvbiI6eyJvd25lciI6ImFkbWluIiwidGllclF1b3RhVHlwZSI6bnVsbCwidGllciI6IjEwUGVyTWluIiwibmFtZSI6Im15IiwiaWQiOjIsInV1aWQiOiI5MzkyMTM2OC1lYmRkLTQxYzEtOWI2Ny1lMzhlZmNkZmMzMjAifSwiaXNzIjoiaHR0cHM6XC9cL2FwaW06OTQ0NFwvb2F1dGgyXC90b2tlbiIsInRpZXJJbmZvIjp7IlVubGltaXRlZCI6eyJ0aWVyUXVvdGFUeXBlIjoicmVxdWVzdENvdW50IiwiZ3JhcGhRTE1heENvbXBsZXhpdHkiOjAsImdyYXBoUUxNYXhEZXB0aCI6MCwic3RvcE9uUXVvdGFSZWFjaCI6dHJ1ZSwic3Bpa2VBcnJlc3RMaW1pdCI6MCwic3Bpa2VBcnJlc3RVbml0IjpudWxsfX0sImtleXR5cGUiOiJQUk9EVUNUSU9OIiwic3Vic2NyaWJlZEFQSXMiOlt7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoicXFxcSIsImNvbnRleHQiOiJcL3FxcVwvMSIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjEiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn1dLCJ0b2tlbl90eXBlIjoiYXBpS2V5IiwiaWF0IjoxNjUwMzY0MjYyLCJqdGkiOiJlYzYxZDI0Zi04Nzg2LTRlYjktYmZiNy1lN2EyMGQwMjk1ZjYifQ==.M6ZiC1asUawlx73JYU83knl6vm1AG1q95DKnk-mU_59UG1yTRMJDtQn0CpHNDlTb-w9P4JGY8H5Z6l-aLUsmlyDAgIDG58_Q264jYqXleinRlOQyeAkQrPUM4DlVqM9yKOM-xLB8ZrE8feMj6-jHk6boJNtGBV1XUioJ-IQwq2MnBOII3dRbePYA7hNICmlOWaVXDOZitpihTiIl1JUHT7a_nGDiXg3b-MC14PqrdrAnqNWxih_K6oiVrlulsAaVWhRr3dmTQcsA4Eqr2N9FMHDRPeUT8MKlCpy7_SZeWX207LkwdnvWSVrV6dNPJuAWU1g8my_MYQlDDltZqKaisw==" }' "https://localhost:9443/api/am/devportal/v3/applications/93921368-ebdd-41c1-9b67-e38efcdfc320/api-keys/PRODUCTION/revoke" + curl -k -H "Authorization: Bearer e4cb79d6-c22e-386a-a1eb-0494208e9976" -H "Content-Type: application/json" -X POST -d '{ "apikey" : "eyJ4NXQiOiJOMkpqTWpOaU0yRXhZalJrTnpaalptWTFZVEF4Tm1GbE5qZzRPV1UxWVdRMll6YzFObVk1TlE9PSIsImtpZCI6ImdhdGV3YXlfY2VydGlmaWNhdGVfYWxpYXMiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJhZG1pbkBjYXJib24uc3VwZXIiLCJhcHBsaWNhdGlvbiI6eyJvd25lciI6ImFkbWluIiwidGllclF1b3RhVHlwZSI6bnVsbCwidGllciI6IjEwUGVyTWluIiwibmFtZSI6Im15IiwiaWQiOjIsInV1aWQiOiI5MzkyMTM2OC1lYmRkLTQxYzEtOWI2Ny1lMzhlZmNkZmMzMjAifSwiaXNzIjoiaHR0cHM6XC9cL2FwaW06OTQ0NFwvb2F1dGgyXC90b2tlbiIsInRpZXJJbmZvIjp7IlVubGltaXRlZCI6eyJ0aWVyUXVvdGFUeXBlIjoicmVxdWVzdENvdW50IiwiZ3JhcGhRTE1heENvbXBsZXhpdHkiOjAsImdyYXBoUUxNYXhEZXB0aCI6MCwic3RvcE9uUXVvdGFSZWFjaCI6dHJ1ZSwic3Bpa2VBcnJlc3RMaW1pdCI6MCwic3Bpa2VBcnJlc3RVbml0IjpudWxsfX0sImtleXR5cGUiOiJQUk9EVUNUSU9OIiwic3Vic2NyaWJlZEFQSXMiOlt7InN1YnNjcmliZXJUZW5hbnREb21haW4iOiJjYXJib24uc3VwZXIiLCJuYW1lIjoicXFxcSIsImNvbnRleHQiOiJcL3FxcVwvMSIsInB1Ymxpc2hlciI6ImFkbWluIiwidmVyc2lvbiI6IjEiLCJzdWJzY3JpcHRpb25UaWVyIjoiVW5saW1pdGVkIn1dLCJ0b2tlbl90eXBlIjoiYXBpS2V5IiwiaWF0IjoxNjUwMzY0MjYyLCJqdGkiOiJlYzYxZDI0Zi04Nzg2LTRlYjktYmZiNy1lN2EyMGQwMjk1ZjYifQ==.M6ZiC1asUawlx73JYU83knl6vm1AG1q95DKnk-mU_59UG1yTRMJDtQn0CpHNDlTb-w9P4JGY8H5Z6l-aLUsmlyDAgIDG58_Q264jYqXleinRlOQyeAkQrPUM4DlVqM9yKOM-xLB8ZrE8feMj6-jHk6boJNtGBV1XUioJ-IQwq2MnBOII3dRbePYA7hNICmlOWaVXDOZitpihTiIl1JUHT7a_nGDiXg3b-MC14PqrdrAnqNWxih_K6oiVrlulsAaVWhRr3dmTQcsA4Eqr2N9FMHDRPeUT8MKlCpy7_SZeWX207LkwdnvWSVrV6dNPJuAWU1g8my_MYQlDDltZqKaisw==" }' "https://localhost:9443/api/am/devportal/v4/applications/93921368-ebdd-41c1-9b67-e38efcdfc320/api-keys/PRODUCTION/revoke" ``` !!! info - Refer to [Developer Portal - Revoke API Key]({{base_path}}/reference/product-apis/devportal-apis/devportal-v3/devportal-v3/#tag/API-Keys/paths/~1applications~1{applicationId}~1api-keys~1{keyType}~1revoke/post) section for more info. + Refer to [Developer Portal - Revoke API Key]({{base_path}}/reference/product-apis/devportal-apis/devportal-v4/devportal-v4/#tag/API-Keys/paths/~1applications~1{applicationId}~1api-keys~1{keyType}~1revoke/post) section for more info. The above command will return an empty 200 response. diff --git a/en/docs/design/advanced-topics/adding-an-api-state-change-workflow-using-bps.md b/en/docs/design/advanced-topics/adding-an-api-state-change-workflow-using-bps.md index fb0ed5e704..83555d0b01 100644 --- a/en/docs/design/advanced-topics/adding-an-api-state-change-workflow-using-bps.md +++ b/en/docs/design/advanced-topics/adding-an-api-state-change-workflow-using-bps.md @@ -79,7 +79,7 @@ This section explains how to add a custom workflow to control the API state chan service_url = "https://localhost:9445/bpmn" username = "$ref{super_admin.username}" password = "$ref{super_admin.password}" - callback_endpoint = "https://localhost:${mgt.transport.https.port}/api/am/admin/v0.15/workflows/update-workflow-status" + callback_endpoint = "https://localhost:${mgt.transport.https.port}/api/am/admin/v5/workflows/update-workflow-status" oken_endpoint = "https://localhost:${https.nio.port}/token" client_registration_endpoint = "https://localhost:${mgt.transport.https.port}/client-registration/v0.15/register" client_registration_username = "$ref{super_admin.username}" @@ -175,7 +175,7 @@ enable = true service_url = "https://localhost:9445/bpmn" username = "$ref{super_admin.username}" password = "$ref{super_admin.password}" -callback_endpoint = "https://localhost:${mgt.transport.https.port}/api/am/admin/v0.15/workflows/update-workflow-status" +callback_endpoint = "https://localhost:${mgt.transport.https.port}/api/am/admin/v5/workflows/update-workflow-status" oken_endpoint = "https://localhost:${https.nio.port}/token" client_registration_endpoint = "https://localhost:${mgt.transport.https.port}/client-registration/v0.15/register" client_registration_username = "$ref{super_admin.username}" diff --git a/en/docs/design/api-monetization/monetizing-an-api.md b/en/docs/design/api-monetization/monetizing-an-api.md index 3582ad748e..a3a5a05865 100644 --- a/en/docs/design/api-monetization/monetizing-an-api.md +++ b/en/docs/design/api-monetization/monetizing-an-api.md @@ -694,7 +694,7 @@ You can use the admin REST API, which is available in WSO2 API Manager, to publi 1. Obtain the consumer key and secret key pair by calling the dynamic client registration endpoint. - For more information, see [Admin REST API v4.0]({{base_path}}/reference/product-apis/admin-apis/admin-v4/admin-v4/). + For more information, see [Admin REST API v5.0]({{base_path}}/reference/product-apis/admin-apis/admin-v5/admin-v5/). ``` java curl -X POST -H "Authorization: Basic " -H "Content-Type: application/json" -d @payload.json https://localhost:9443/client-registration/v0.17/register @@ -721,7 +721,7 @@ You can use the admin REST API, which is available in WSO2 API Manager, to publi 3. Publish usage data to the Stripe billing engine. ``` java - curl -k -H "Authorization: Bearer " -X POST -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v1/monetization/publish-usage + curl -k -H "Authorization: Bearer " -X POST -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v5/monetization/publish-usage ``` - `` - Token obtained using client credentials with `monetization_usage_publish` scope in the previous step. @@ -741,7 +741,7 @@ You can use the admin REST API, which is available in WSO2 API Manager, to publi When you call the Admin API to publish usage data, a separate job in a separate thread is created to publish usage data to the billing engine. The status of the above job can be monitored as follows. ``` java - curl -k -H "Authorization: Bearer " -X GET -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v1/monetization/publish-usage/status + curl -k -H "Authorization: Bearer " -X GET -H "Content-Type: application/json" https://localhost:9443/api/am/admin/v5/monetization/publish-usage/status ``` - `` - The same token that you got with the monetization usage scope in previous steps. diff --git a/en/docs/reference/customize-product/customizations/customize-the-api-store-and-gateway-urls-for-tenants.md b/en/docs/reference/customize-product/customizations/customize-the-api-store-and-gateway-urls-for-tenants.md index 3fa915b0fb..b83a020b69 100644 --- a/en/docs/reference/customize-product/customizations/customize-the-api-store-and-gateway-urls-for-tenants.md +++ b/en/docs/reference/customize-product/customizations/customize-the-api-store-and-gateway-urls-for-tenants.md @@ -113,7 +113,7 @@ Carry out the following steps to configure NGINX as the load balancer to support proxy_redirect https://{server-IP}:9443/devportal/ /; proxy_set_header X-WSO2-Tenant "{tenant-domain}"; } - location ~ (/api/am/devportal/v3|/authenticationendpoint|/logincontext|/commonauth|/oidc) { + location ~ (/api/am/devportal/v4|/authenticationendpoint|/logincontext|/commonauth|/oidc) { proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; @@ -154,7 +154,7 @@ Carry out the following steps to configure NGINX as the load balancer to support proxy_redirect https://192.168.1.8:9443/devportal/ /; proxy_set_header X-WSO2-Tenant "wso2.com"; } - location ~ (/api/am/devportal/v3|/authenticationendpoint|/logincontext|/commonauth|/oidc) { + location ~ (/api/am/devportal/v4|/authenticationendpoint|/logincontext|/commonauth|/oidc) { proxy_set_header X-Forwarded-Host $host; proxy_set_header X-Forwarded-Server $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; diff --git a/en/docs/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md b/en/docs/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md index d80f7be3b5..e3c01c5d68 100644 --- a/en/docs/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md +++ b/en/docs/reference/customize-product/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping.md @@ -10,7 +10,7 @@ Initially, the Admins will define API categories. Thereafter, API providers will You can add an API category using any of the following methods: - [Add an API Category using the Admin Portal UI]({{base_path}}/develop/customizations/customizing-the-developer-portal/customize-api-listing/api-category-based-grouping/#add-an-api-category-using-the-admin-portal-ui) -- Add an API Category using the Admin REST API. (You can use the POST resource in the **API Category (Individual)** section [here]({{base_path}}/reference/product-apis/admin-apis/admin-v4/admin-v4)) +- Add an API Category using the Admin REST API. (You can use the POST resource in the **API Category (Individual)** section [here]({{base_path}}/reference/product-apis/admin-apis/admin-v5/admin-v5)) ### Add an API Category using the Admin Portal UI @@ -67,4 +67,4 @@ You can add an API category using any of the following methods: All APIs that belong to the selected category appear. - [![APIs categorised based on API category]({{base_path}}/assets/img/develop/devportal_listing.png)]({{base_path}}/assets/img/develop/devportal_listing.png) + [![APIs categorized based on API category]({{base_path}}/assets/img/develop/devportal_listing.png)]({{base_path}}/assets/img/develop/devportal_listing.png) diff --git a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md index baf742827d..aed129f771 100644 --- a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md +++ b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-http-redirection-for-workflows.md @@ -33,7 +33,7 @@ To customize the default workflow extension, you override the **`execute()`** an    public WorkflowResponse execute(WorkflowDTO workflowDTO) throws WorkflowException {        super.execute(workflowDTO); ``` -4. In the **`execute()`** method define the `CallbackUrl`, `RedirectUrl`, `workflowRefId`, and `RedirectConfirmationMsg`. The CallbackUrl should ideally be an open endpoint accepting workflowRefId as a parameter. Once the endpoint is invoked, it should in-turn invoke the [Admin REST APIs callback method]({{base_path}}/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post). Note that the Admin REST API resources require authentication before invocation. +4. In the **`execute()`** method define the `CallbackUrl`, `RedirectUrl`, `workflowRefId`, and `RedirectConfirmationMsg`. The CallbackUrl should ideally be an open endpoint accepting workflowRefId as a parameter. Once the endpoint is invoked, it should in-turn invoke the [Admin REST APIs callback method]({{base_path}}/reference/product-apis/admin-apis/admin-v5/admin-v5/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post). Note that the Admin REST API resources require authentication before invocation. ``` java @Override    public WorkflowResponse execute(WorkflowDTO workflowDTO) throws WorkflowException { @@ -244,4 +244,4 @@ To customize the default workflow extension, you override the **`execute()`** an ``` ### Invoking the API Manager from a third party BPEL engine -The API Manager can be invoked from a third party entity through the [update workflow status method]({{base_path}}/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post). Refer the [Admin REST APIs]({{base_path}}/develop/product-apis/admin-apis/admin-v1/admin-v1/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post) to learn how to invoke it. Note that the Admin REST API resources require authentication before invocation. +The API Manager can be invoked from a third party entity through the [update workflow status method]({{base_path}}/reference/product-apis/admin-apis/admin-v5/admin-v5/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post). Refer the [Admin REST APIs]({{base_path}}/develop/product-apis/admin-apis/admin-v5/admin-v5/#tag/Workflows-(Individual)/paths/~1workflows~1update-workflow-status/post) to learn how to invoke it. Note that the Admin REST API resources require authentication before invocation. diff --git a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-workflows-in-a-cluster.md b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-workflows-in-a-cluster.md index 9ffc12a75d..11beb78b30 100644 --- a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-workflows-in-a-cluster.md +++ b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/configuring-workflows-in-a-cluster.md @@ -13,7 +13,7 @@ In this guide, you access the Admin Portal ( `https://:9443/admin` ) Web applic + uri-template="https://:9443/api/am/admin/v5/workflows/update-workflow-status?workflowReferenceId={uri.var.workflowRef}"/> ``` diff --git a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/invoking-the-api-manager-from-the-bpel-engine.md b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/invoking-the-api-manager-from-the-bpel-engine.md index 2ce0591770..7812178638 100644 --- a/en/docs/reference/customize-product/extending-api-manager/extending-workflows/invoking-the-api-manager-from-the-bpel-engine.md +++ b/en/docs/reference/customize-product/extending-api-manager/extending-workflows/invoking-the-api-manager-from-the-bpel-engine.md @@ -21,7 +21,7 @@ Once the workflow configurations are finalized at the BPEL, the call-back URL of REST -https://localhost:9443/api/am/admin/v2/workflows/update-workflow-status +https://localhost:9443/api/am/admin/v5/workflows/update-workflow-status @@ -65,7 +65,7 @@ The endpoint expects the following list of parameters: A sample curl request for invoking the REST endpoint is as follows: ``` -curl -H "Authorization:Basic YWRtaW46YWRtaW4=" -X POST https://localhost:9443/api/am/admin/v2/workflows/update-workflow-status -d 'workflowReference=b530be39-9174-43b3-acb3-2603a223b094&status=APPROVED&description=DESCRIPTION' +curl -H "Authorization:Basic YWRtaW46YWRtaW4=" -X POST https://localhost:9443/api/am/admin/v5/workflows/update-workflow-status -d 'workflowReference=b530be39-9174-43b3-acb3-2603a223b094&status=APPROVED&description=DESCRIPTION' ``` A sample SOAP request is given below: diff --git a/en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.md b/en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.md similarity index 85% rename from en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.md rename to en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.md index fe6065e685..4d71746ada 100644 --- a/en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.md +++ b/en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.md @@ -2,5 +2,5 @@ template: templates/redoc.html --- - + \ No newline at end of file diff --git a/en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml b/en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.yaml similarity index 95% rename from en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml rename to en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.yaml index c8d194452c..e764f081b8 100644 --- a/en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml +++ b/en/docs/reference/product-apis/admin-apis/admin-v5/admin-v5.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -60,10 +60,6 @@ info: "jsonAppAttribute": "{}", "tokenType": null } - - Note that in a distributed deployment or IS as KM separated environment to invoke RESTful APIs (product APIs), users must generate tokens through API-M Control Plane's token endpoint. - The tokens generated using third party key managers, are to manage end-user authentication when accessing APIs. - ``` Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. @@ -101,7 +97,7 @@ info: * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance. - [![Run in Postman](https://run.pstmn.io/button.svg)]( https://app.getpostman.com/run-collection/25611032-1feaa854-cf06-4f93-b76c-2fa5fd7791b8) + [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/17491134-b263aa69-7494-4fc5-90fa-daa2f63880ae) contact: name: WSO2 url: https://wso2.com/api-manager/ @@ -109,9 +105,9 @@ info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html - version: v4 + version: v5 servers: - - url: https://apis.wso2.com/api/am/admin/v4 + - url: https://apis.wso2.com/api/am/admin/v5 paths: ###################################################### # The "Content Search Results" Throttling Policies @@ -150,11 +146,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/search?query=type:sub"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/search?query=type:sub"' operationId: throttlingPolicySearch ###################################################### @@ -190,10 +187,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/application"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/application"' post: tags: @@ -253,10 +251,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/application"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/application"' ###################################################### # The "Individual Application Throttling Policy" resource API @@ -306,10 +305,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' put: tags: @@ -369,10 +369,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' delete: tags: @@ -394,11 +395,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/application/4e098fff-7f94-459a-981f-d257332f69d0"' ###################################################### @@ -434,10 +436,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/subscription"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/subscription"' post: tags: @@ -502,10 +505,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/subscription"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/subscription"' ###################################################### # The "Individual Subscription Throttling Policy" resource API @@ -560,10 +564,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' put: tags: @@ -628,10 +633,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' delete: tags: @@ -653,11 +659,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/subscription/c948c723-71dd-4d50-8c77-0a0e99c8cbb1"' ###################################################### # The "Custom Rules Collection" resource API @@ -695,10 +702,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/custom"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/custom"' post: tags: @@ -760,10 +768,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/custom"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/custom"' ###################################################### # The "Individual Custom Rule" resource API @@ -815,10 +824,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' put: tags: @@ -880,10 +890,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' delete: tags: @@ -908,11 +919,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/custom/33662a62-8db1-4d75-af08-afd63c6bd0b4"' ###################################################### # The "Advanced Throttling Policy Collection" resource API @@ -947,10 +959,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/advanced"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/advanced"' post: tags: @@ -1010,10 +1023,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/advanced"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/advanced"' ###################################################### # The "Individual Advanced Throttling Policy" resource API @@ -1063,10 +1077,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_view + - apim:admin_tier_view x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' put: tags: @@ -1126,10 +1141,11 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' delete: tags: @@ -1151,11 +1167,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/advanced/229a3c46-c836-43c8-b988-8eebd9c7774b"' ###################################################### # "Export Throttling Policy" resource API ###################################################### @@ -1238,11 +1255,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/export?policyId=96077508-fd01-4fae-bc64-5de0e2baf43c&name=Bronze&type=sub&format=YAML"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/export?policyId=96077508-fd01-4fae-bc64-5de0e2baf43c&name=Bronze&type=sub&format=YAML"' operationId: exportThrottlingPolicy #################################################################### # Import Throttling Policy @@ -1291,11 +1309,12 @@ paths: - OAuth2Security: - apim:admin - apim:tier_manage + - apim:admin_tier_manage - apim:policies_import_export x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/policies/import?overwrite=True"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/policies/import?overwrite=True"' operationId: importThrottlingPolicy ###################################################### # The "Deny Policy Collection" resource API @@ -1333,7 +1352,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/deny-policies"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/deny-policies"' post: tags: @@ -1383,7 +1402,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/deny-policies"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/deny-policies"' ###################################################### # The "Individual Deny Policy" resource API @@ -1423,7 +1442,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' delete: tags: @@ -1448,7 +1467,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' + "https://127.0.0.1:9443/api/am/admin/v5/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' patch: tags: @@ -1487,7 +1506,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PATCH -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/throttling/deny-policy/b513eb68-69e8-4c32-92cf-852c101363c"' ###################################################### # The "Application Collection" resource APIs @@ -1565,7 +1584,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/applications"' + "https://127.0.0.1:9443/api/am/admin/v5/applications"' ###################################################### # The "Individual Application" resource APIs @@ -1603,7 +1622,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X GET -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b"' + "https://127.0.0.1:9443/api/am/admin/v5/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b"' delete: tags: @@ -1643,7 +1662,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b"' + "https://127.0.0.1:9443/api/am/admin/v5/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b"' /applications/{applicationId}/change-owner: post: @@ -1677,7 +1696,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b/change-owner?owner=admin"' + "https://127.0.0.1:9443/api/am/admin/v5/applications/0a043c2b-ee75-4ef3-9e1c-fc2610ccfa8b/change-owner?owner=admin"' ###################################################### # The "Environment" resource API @@ -1705,7 +1724,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/environments"' + "https://127.0.0.1:9443/api/am/admin/v5/environments"' post: tags: @@ -1739,7 +1758,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/environments"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/environments"' ###################################################### # The "Individual Environment" resource APIs @@ -1781,7 +1800,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"' delete: tags: @@ -1806,7 +1825,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"' + "https://127.0.0.1:9443/api/am/admin/v5/environments/d7cf8523-9180-4255-84fa-6cb171c1f779"' ###################################################### # The Bot Detection Data API resources @@ -1844,7 +1863,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/bot-detection-data"' + "https://127.0.0.1:9443/api/am/admin/v5/bot-detection-data"' ###################################################### # The "Monetization" resource APIs @@ -1880,7 +1899,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/monetization/publish-usage"' + "https://127.0.0.1:9443/api/am/admin/v5/monetization/publish-usage"' /monetization/publish-usage/status: get: @@ -1905,7 +1924,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/monetization/publish-usage/status"' + "https://127.0.0.1:9443/api/am/admin/v5/monetization/publish-usage/status"' ###################################################### # The "Workflow Collection" resource APIs @@ -1939,6 +1958,7 @@ paths: - AM_APPLICATION_DELETION - AM_API_STATE - AM_API_PRODUCT_STATE + - AM_REVISION_DEPLOYMENT responses: 200: description: | @@ -1967,7 +1987,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/workflows"' + "https://127.0.0.1:9443/api/am/admin/v5/workflows"' /workflows/{externalWorkflowRef}: get: @@ -2010,7 +2030,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/workflows/c43a325c-260b-4302-81cb-768eafaa3aed"' + "https://127.0.0.1:9443/api/am/admin/v5/workflows/c43a325c-260b-4302-81cb-768eafaa3aed"' /workflows/update-workflow-status: post: @@ -2055,7 +2075,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/workflows/update-workflow-status?workflowReferenceId=56e3a170-a7a7-45f8-b051-7e43a58a67e1"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/workflows/update-workflow-status?workflowReferenceId=56e3a170-a7a7-45f8-b051-7e43a58a67e1"' ###################################################### # The Tenant Info resource API @@ -2104,7 +2124,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/tenant-info/john"' + "https://127.0.0.1:9443/api/am/admin/v5/tenant-info/john"' ###################################################### # The Custom URL Info resource API @@ -2152,7 +2172,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/custom-urls/wso2.com"' + "https://127.0.0.1:9443/api/am/admin/v5/custom-urls/wso2.com"' ###################################################### # The "Category Collection" resource API @@ -2177,10 +2197,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:api_category x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/api-categories"' + "https://127.0.0.1:9443/api/am/admin/v5/api-categories"' post: tags: @@ -2211,10 +2232,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:api_category x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/api-categories"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/api-categories"' ###################################################### # The "Individual Category" resource APIs @@ -2253,10 +2275,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:api_category x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/api-categories/d7cf8523-9180-4255-84fa-6cb171c1f779"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/api-categories/d7cf8523-9180-4255-84fa-6cb171c1f779"' delete: tags: @@ -2278,10 +2301,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:api_category x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/api-categories/d7cf8523-9180-4255-84fa-6cb171c1f779"' + "https://127.0.0.1:9443/api/am/admin/v5/api-categories/d7cf8523-9180-4255-84fa-6cb171c1f779"' ###################################################### # The Admin settings List @@ -2311,7 +2335,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/settings"' + "https://127.0.0.1:9443/api/am/admin/v5/settings"' #################################################### # The Admin alert management resources @@ -2349,7 +2373,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/alert-types"' + "https://127.0.0.1:9443/api/am/admin/v5/alert-types"' /alert-subscriptions: get: @@ -2384,7 +2408,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions"' + "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions"' put: tags: @@ -2427,7 +2451,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions"' delete: tags: @@ -2458,7 +2482,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions"' + "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions"' /alert-subscriptions/bot-detection: get: @@ -2493,7 +2517,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions/bot-detection"' + "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions/bot-detection"' post: tags: @@ -2536,7 +2560,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions/bot-detection"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions/bot-detection"' /alert-subscriptions/bot-detection/{uuid}: delete: @@ -2576,7 +2600,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/alert-subscriptions/bot-detection/7c9ee02d-37f5-4694-b99c-6d5641b28645"' + "https://127.0.0.1:9443/api/am/admin/v5/alert-subscriptions/bot-detection/7c9ee02d-37f5-4694-b99c-6d5641b28645"' ###################################################### # System scopes resource API @@ -2616,7 +2640,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/system-scopes/YXBpbTpzdWJzY3JpYmU?username=john"' + "https://127.0.0.1:9443/api/am/admin/v5/system-scopes/YXBpbTpzdWJzY3JpYmU?username=john"' /system-scopes: get: @@ -2651,7 +2675,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/system-scopes"' + "https://127.0.0.1:9443/api/am/admin/v5/system-scopes"' put: tags: @@ -2695,7 +2719,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/system-scopes"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/system-scopes"' /system-scopes/role-aliases: get: @@ -2728,7 +2752,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/system-scopes/role-aliases"' + "https://127.0.0.1:9443/api/am/admin/v5/system-scopes/role-aliases"' put: tags: @@ -2763,7 +2787,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/system-scopes/role-aliases"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/system-scopes/role-aliases"' ###################################################### # Roles resource APIs @@ -2793,7 +2817,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -I -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' + "https://127.0.0.1:9443/api/am/admin/v5/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' ###################################################### # The Tenant Theme resource APIs @@ -2835,7 +2859,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/tenant-theme" > theme.zip' + "https://127.0.0.1:9443/api/am/admin/v5/tenant-theme" > theme.zip' put: tags: @@ -2876,7 +2900,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@theme.zip "https://127.0.0.1:9443/api/am/admin/v4/tenant-theme"' + -F file=@theme.zip "https://127.0.0.1:9443/api/am/admin/v5/tenant-theme"' ###################################################### # The Tenant config resource APIs @@ -2916,7 +2940,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/tenant-config" > tenant-config.json' + "https://127.0.0.1:9443/api/am/admin/v5/tenant-config" > tenant-config.json' put: tags: - Tenant Config @@ -2952,7 +2976,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/tenant-config"' + "https://127.0.0.1:9443/api/am/admin/v5/tenant-config"' ###################################################### # The Tenant config schema resource APIs @@ -2992,7 +3016,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/tenant-config-schema" > tenant-config-schema.json' + "https://127.0.0.1:9443/api/am/admin/v5/tenant-config-schema" > tenant-config-schema.json' ###################################################### # The "Key Manager Collection" resource API @@ -3017,10 +3041,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/key-managers"' + "https://127.0.0.1:9443/api/am/admin/v5/key-managers"' post: tags: @@ -3051,10 +3076,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/key-managers"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/key-managers"' ###################################################### # The "Individual KeyManager" resource APIs @@ -3091,10 +3117,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' + "https://127.0.0.1:9443/api/am/admin/v5/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' put: tags: @@ -3129,10 +3156,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v5/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' delete: tags: @@ -3154,10 +3182,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/admin/v4/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' + "https://127.0.0.1:9443/api/am/admin/v5/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"' /key-managers/discover: post: @@ -3192,10 +3221,11 @@ paths: - OAuth2Security: - apim:admin - apim:admin_operations + - apim:keymanagers_manage x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F "type=WSO2-IS" "https://127.0.0.1:9443/api/am/admin/v4/key-managers/discover"' + -F "type=WSO2-IS" "https://127.0.0.1:9443/api/am/admin/v5/key-managers/discover"' components: schemas: @@ -3404,6 +3434,8 @@ components: properties: defaultLimit: $ref: '#/components/schemas/ThrottleLimit' + burstLimit: + $ref: '#/components/schemas/BurstLimit' ApplicationThrottlePolicyList: title: Application Level Throttling Policy List type: object @@ -3728,6 +3760,18 @@ components: $ref: '#/components/schemas/BandwidthLimit' eventCount: $ref: '#/components/schemas/EventCountLimit' + BurstLimit: + title: Burst Limit object + type: object + properties: + rateLimitCount: + type: integer + description: Burst control request count + example: 10 + rateLimitTimeUnit: + type: string + description: Burst control time unit + example: min MonetizationInfo: title: API monetization details object required: @@ -4089,9 +4133,15 @@ components: wsPort: type: integer example: 9099 + wsHost: + type: string + example: mg.wso2.com wssPort: type: integer example: 8099 + wssHost: + type: string + example: mg.wso2.com AdditionalProperty: title: Additional Gateway Properties type: object @@ -4490,6 +4540,22 @@ components: self_validate_jwt: true Username: admin Password: admin + permissions: + type: object + properties: + permissionType: + type: string + example: ALLOW + default: PUBLIC + enum: + - PUBLIC + - ALLOW + - DENY + roles: + type: array + items: + type: string + example: Internal/subscriber tokenType: type: string description: The type of the tokens to be used (exchanged or without exchanged). @@ -4739,6 +4805,7 @@ components: - API_PRODUCT_STATE - SUBSCRIPTION_DELETION - SUBSCRIPTION_UPDATE + - REVISION_DEPLOYMENT workflowStatus: type: string description: | @@ -5197,6 +5264,8 @@ components: apim:admin: Manage all admin operations apim:tier_view: View throttling policies apim:tier_manage: Update and delete throttling policies + apim:admin_tier_view: View throttling policies + apim:admin_tier_manage: Update and delete throttling policies apim:bl_view: View deny policies apim:bl_manage: Update and delete deny policies apim:mediation_policy_view: View mediation policies @@ -5216,9 +5285,11 @@ components: apim:tenant_theme_manage: Manage tenant themes apim:admin_operations: Manage API categories and Key Managers related operations + apim:api_category: Manage API categories apim:admin_settings: Retrieve admin settings apim:admin_alert_manage: Manage admin alerts apim:api_workflow_view: Retrive workflow requests apim:scope_manage: Manage system scopes apim:role_manage: Manage system roles - apim:admin_application_view: View Applications \ No newline at end of file + apim:admin_application_view: View Applications + apim:keymanagers_manage: Manage Key Managers \ No newline at end of file diff --git a/en/docs/reference/product-apis/admin-apis/admin-v4/docs/examples/alerts/applications.yaml b/en/docs/reference/product-apis/admin-apis/admin-v5/docs/examples/alerts/applications.yaml similarity index 94% rename from en/docs/reference/product-apis/admin-apis/admin-v4/docs/examples/alerts/applications.yaml rename to en/docs/reference/product-apis/admin-apis/admin-v5/docs/examples/alerts/applications.yaml index 74eea662ed..2b687266aa 100644 --- a/en/docs/reference/product-apis/admin-apis/admin-v4/docs/examples/alerts/applications.yaml +++ b/en/docs/reference/product-apis/admin-apis/admin-v5/docs/examples/alerts/applications.yaml @@ -17,7 +17,7 @@ delete: - id: deleteApplication - request: method: DELETE - url: https://localhost:9443/api/am/admin/v1/applications/367a2361-8db5-4140-8133-c6c8dc7fa0c4 + url: https://localhost:9443/api/am/admin/v5/applications/367a2361-8db5-4140-8133-c6c8dc7fa0c4 headers: | Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8 response: diff --git a/en/docs/reference/product-apis/devops-apis/devops-v0/devops-v0.yaml b/en/docs/reference/product-apis/devops-apis/devops-v0/devops-v0.yaml index a20360fa41..163329877d 100644 --- a/en/docs/reference/product-apis/devops-apis/devops-v0/devops-v0.yaml +++ b/en/docs/reference/product-apis/devops-apis/devops-v0/devops-v0.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2022, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -20,7 +20,7 @@ info: This document specifies a **RESTful API** for WSO2 **API Manager** - DevOps. contact: name: WSO2 - url: https://wso2.com/api-manager/ + url: http://wso2.com/products/api-manager/ email: architecture@wso2.com license: name: Apache 2.0 @@ -54,6 +54,8 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" + + "/tenant-logs/{tenantId}/apis/{apiId}": get: summary: | @@ -80,8 +82,8 @@ paths: schema: $ref: "#/components/schemas/Error" parameters: - - $ref: '#/components/parameters/tenantId' - - $ref: '#/components/parameters/apiId' + - $ref: '#/components/parameters/tenantId' + - $ref: '#/components/parameters/apiId' put: summary: | Set logging levels of the API with its api ID @@ -184,9 +186,10 @@ paths: application/json: schema: $ref: "#/components/schemas/Error" - + servers: - url: https://apis.wso2.com/api/am/devops/v0 + components: schemas: LoggingApiOutputList: @@ -196,25 +199,6 @@ components: type: array items: $ref: "#/components/schemas/LoggingApiOutput" - LoggingApiInput: - title: API Info object with log details - properties: - logLevel: - type: string - example: FULL - LoggingApiOutput: - title: API Info object with log details - properties: - context: - type: string - example: pizashack/v1.0.0 - logLevel: - type: string - example: FULL - apiId: - type: string - example: 12d6e73c-778d-45ac-b57d-117c6c5092a4 - CorrelationComponentsList: title: correlation-components properties: @@ -246,8 +230,26 @@ components: type: array items: type: string - example: "MessageDeliveryTaskThreadPool" + example: "MessageDeliveryTaskPool" + LoggingApiInput: + title: API Info object with log details + properties: + logLevel: + type: string + example: FULL + LoggingApiOutput: + title: API Info object with log details + properties: + context: + type: string + example: pizashack/v1.0.0 + logLevel: + type: string + example: FULL + apiId: + type: string + example: 12d6e73c-778d-45ac-b57d-117c6c5092a4 Error: title: Error object returned with 4XX HTTP Status required: @@ -291,6 +293,7 @@ components: type: string description: | A detail description about the error message. + parameters: tenantId: name: tenantId diff --git a/en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.md b/en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.md similarity index 80% rename from en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.md rename to en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.md index ba7ef389f0..48fc622175 100644 --- a/en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.md +++ b/en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.md @@ -2,5 +2,5 @@ template: templates/redoc.html --- - + \ No newline at end of file diff --git a/en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.yaml b/en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.yaml similarity index 97% rename from en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.yaml rename to en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.yaml index 68c26fe32c..86bd5548a4 100644 --- a/en/docs/reference/product-apis/devportal-apis/devportal-v3/devportal-v3.yaml +++ b/en/docs/reference/product-apis/devportal-apis/devportal-v4/devportal-v4.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -61,10 +61,6 @@ info: "tokenType": null } ``` - - Note that in a distributed deployment or IS as KM separated environment to invoke RESTful APIs (product APIs), users must generate tokens through API-M Control Plane's token endpoint. - The tokens generated using third party key managers, are to manage end-user authentication when accessing APIs. - Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. You also need to add the proper **scope** when getting the access token. All possible scopes for devportal REST API can be viewed in **OAuth2 Security** section @@ -101,7 +97,7 @@ info: * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance. - [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/25611032-b6a3878d-afa1-4cb8-b564-e69d73342f3f) + [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/17491134-b8760354-b3c3-4019-b60a-e813cba8d7c0) contact: name: WSO2 url: https://wso2.com/api-manager/ @@ -109,9 +105,9 @@ info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html - version: v3 + version: v4 servers: - - url: https://apis.wso2.com/api/am/devportal/v3 + - url: https://apis.wso2.com/api/am/devportal/v4 ###################################################### # The "API Collection" resource APIs ###################################################### @@ -181,7 +177,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis" /apis/{apiId}: get: @@ -234,7 +230,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed" /apis/{apiId}/swagger: get: @@ -303,7 +299,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/swagger" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/swagger" /apis/{apiId}/async-api-specification: get: @@ -411,7 +407,7 @@ paths: - OAuth2Security: [ ] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/async-api-specification" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/async-api-specification" /apis/{apiId}/graphql-schema: get: @@ -558,7 +554,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/graphql-schema" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/graphql-schema" /apis/{apiId}/sdks/{language}: get: @@ -602,7 +598,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/sdks/java" + "https://localhost:9443/api/am/devportal/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/sdks/java" > Petstore_java_1.0.0.zip /apis/{apiId}/wsdl: @@ -649,7 +645,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/wsdl" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/wsdl" ###################################################### # The "Document Collection" resource APIs @@ -701,7 +697,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/documents" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/documents" ###################################################### # The "Individual Document" resource APIs @@ -753,7 +749,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/c43a325c-260b-4302-81cb-768eafaa3aed/documents/850a4f34-db2c-4d23-9d85-3f95fbfb082c" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/c43a325c-260b-4302-81cb-768eafaa3aed/documents/850a4f34-db2c-4d23-9d85-3f95fbfb082c" /apis/{apiId}/documents/{documentId}/content: get: @@ -825,7 +821,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content" /apis/{apiId}/thumbnail: get: @@ -880,7 +876,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: 'curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/thumbnail" > image.jpeg' + source: 'curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/thumbnail" > image.jpeg' /apis/{apiId}/ratings: get: @@ -911,7 +907,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/ratings" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/ratings" /apis/{apiId}/user-rating: get: @@ -963,7 +959,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating" + "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating" put: tags: @@ -1009,7 +1005,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating"' + -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating"' delete: tags: @@ -1035,7 +1031,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -X DELETE -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating" + "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/user-rating" /apis/{apiId}/comments: get: @@ -1068,7 +1064,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments" post: tags: @@ -1138,7 +1134,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' + -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' /apis/{apiId}/comments/{commentId}: get: @@ -1190,7 +1186,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" patch: tags: @@ -1263,7 +1259,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PATCH -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' + -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' delete: tags: @@ -1305,7 +1301,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -X DELETE -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" + "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" /apis/{apiId}/comments/{commentId}/replies: get: @@ -1357,7 +1353,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4/replies" + source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4/replies" /apis/{apiId}/topics: get: @@ -1395,7 +1391,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/apis/5b65808c-cdf2-43e1-a695-de63e3ad0ae9/topics" + "https://localhost:9443/api/am/devportal/v4/apis/5b65808c-cdf2-43e1-a695-de63e3ad0ae9/topics" /apis/{apiId}/subscription-policies: get: @@ -1446,7 +1442,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/268c9e55-3dc1-4f47-82e7-977e5343d077/subscription-policies" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/268c9e55-3dc1-4f47-82e7-977e5343d077/subscription-policies" ###################################################### # The "Application Collection" resource APIs @@ -1525,7 +1521,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications?query=CalculatorApp"' + "https://localhost:9443/api/am/devportal/v4/applications?query=CalculatorApp"' post: tags: @@ -1590,7 +1586,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications"' ###################################################### # The "Individual Application" resource APIs @@ -1644,7 +1640,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' + "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' put: tags: @@ -1703,7 +1699,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' + -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' delete: tags: @@ -1747,7 +1743,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -X DELETE "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' + -X DELETE "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015"' /applications/{applicationId}/generate-keys: post: @@ -1789,7 +1785,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/generate-keys"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/generate-keys"' /applications/{applicationId}/map-keys: post: @@ -1831,7 +1827,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/map-keys"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/map-keys"' /applications/{applicationId}/keys: get: @@ -1865,7 +1861,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys"' + "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys"' /applications/{applicationId}/keys/{keyType}: get: @@ -1902,7 +1898,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION"' + "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION"' put: tags: @@ -1945,7 +1941,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION"' + -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION"' /applications/{applicationId}/keys/{keyType}/regenerate-secret: post: @@ -1999,7 +1995,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION/regenerate-secret"' + -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION/regenerate-secret"' /applications/{applicationId}/keys/{keyType}/clean-up: post: @@ -2032,7 +2028,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v3/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION/clean-up"' + -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v4/applications/896658a0-b4ee-4535-bbfa-806c894a4015/keys/PRODUCTION/clean-up"' /applications/{applicationId}/keys/{keyType}/generate-token: post: @@ -2076,7 +2072,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/keys/PRODUCTION/generate-token"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/keys/PRODUCTION/generate-token"' /applications/{applicationId}/oauth-keys: get: @@ -2110,7 +2106,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys"' + "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys"' /applications/{applicationId}/oauth-keys/{keyMappingId}: get: @@ -2146,7 +2142,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584"' + "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584"' put: tags: @@ -2188,7 +2184,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584"' + -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584"' /applications/{applicationId}/oauth-keys/{keyMappingId}/regenerate-secret: post: @@ -2241,7 +2237,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584/regenerate-secret"' + -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584/regenerate-secret"' /applications/{applicationId}/oauth-keys/{keyMappingId}/clean-up: post: @@ -2273,7 +2269,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584/clean-up"' + -H "Content-Type: application/json" -X POST "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/df972173-c957-46d4-96ac-99be8e303584/clean-up"' /applications/{applicationId}/oauth-keys/{keyMappingId}/generate-token: post: @@ -2316,7 +2312,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/{keyMappingId}/generate-token"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/oauth-keys/{keyMappingId}/generate-token"' /applications/{applicationId}/api-keys/{keyType}/generate: post: @@ -2360,7 +2356,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/api-keys/PRODUCTION/generate"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/api-keys/PRODUCTION/generate"' /applications/{applicationId}/api-keys/{keyType}/revoke: post: @@ -2399,7 +2395,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/applications/16cd2684-9657-4a01-a956-4efd89e96077/api-keys/PRODUCTION/revoke"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/applications/16cd2684-9657-4a01-a956-4efd89e96077/api-keys/PRODUCTION/revoke"' /applications/export: get: @@ -2466,7 +2462,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/applications/export?appName=sampleApp&appOwner=admin&withKeys=true" + "https://localhost:9443/api/am/devportal/v4/applications/export?appName=sampleApp&appOwner=admin&withKeys=true" > exportedApplication.zip' /applications/import: @@ -2553,7 +2549,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@exportedApplication.zip "https://127.0.0.1:9443/api/am/devportal/v3/applications/import?preserveOwner=true&skipSubscriptions=false&appOwner=admin&skipApplicationKeys=false&update=true"' + -F file=@exportedApplication.zip "https://127.0.0.1:9443/api/am/devportal/v4/applications/import?preserveOwner=true&skipSubscriptions=false&appOwner=admin&skipApplicationKeys=false&update=true"' ###################################################### # The "Subscription Collection" resource APIs @@ -2568,10 +2564,10 @@ paths: This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving applications which are subscribed to a specific API. - `GET https://localhost:9443/api/am/devportal/v3/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` + `GET https://localhost:9443/api/am/devportal/v4/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. - `GET https://localhost:9443/api/am/devportal/v3/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` + `GET https://localhost:9443/api/am/devportal/v4/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**. @@ -2613,7 +2609,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/subscriptions?apiId=02e658e7-71c7-4b1d-a623-be145b789340"' + "https://localhost:9443/api/am/devportal/v4/subscriptions?apiId=02e658e7-71c7-4b1d-a623-be145b789340"' post: tags: @@ -2682,7 +2678,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/subscriptions"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/subscriptions"' /subscriptions/multiple: post: @@ -2744,7 +2740,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/subscriptions/multiple"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/subscriptions/multiple"' ###################################################### # The "Subscriptions related to API" resource API @@ -2789,7 +2785,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/devportal/v3/subscriptions/e93fb282-b456-48fc-8981-003fb89086ae/additionalInfo"' + source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://localhost:9443/api/am/devportal/v4/subscriptions/e93fb282-b456-48fc-8981-003fb89086ae/additionalInfo"' ###################################################### # The "Individual Subscription" resource APIs @@ -2839,7 +2835,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/subscriptions/5b65808c-cdf2-43e1-a695-de63e3ad0ae9"' + "https://localhost:9443/api/am/devportal/v4/subscriptions/5b65808c-cdf2-43e1-a695-de63e3ad0ae9"' put: tags: @@ -2918,7 +2914,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v3/subscriptions/80369180-7d90-4ee8-99a1-19fa68512aa5"' + -H "Content-Type: application/json" -X PUT -d @data.json "https://localhost:9443/api/am/devportal/v4/subscriptions/80369180-7d90-4ee8-99a1-19fa68512aa5"' delete: tags: @@ -2961,7 +2957,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X DELETE "https://localhost:9443/api/am/devportal/v3/subscriptions/80369180-7d90-4ee8-99a1-19fa68512aa5"' + -H "Content-Type: application/json" -X DELETE "https://localhost:9443/api/am/devportal/v4/subscriptions/80369180-7d90-4ee8-99a1-19fa68512aa5"' /subscriptions/{subscriptionId}/usage: get: @@ -3011,7 +3007,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/subscriptions/5b65808c-cdf2-43e1-a695-de63e3ad0ae9/usage"' + "https://localhost:9443/api/am/devportal/v4/subscriptions/5b65808c-cdf2-43e1-a695-de63e3ad0ae9/usage"' ###################################################### # The "Throttling Policy Collection" resource APIs @@ -3056,7 +3052,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/throttling-policies/application" + source: curl -k "https://localhost:9443/api/am/devportal/v4/throttling-policies/application" ###################################################### # The "Individual Throttling Policy" resource APIs @@ -3111,7 +3107,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/throttling-policies/application/10PerMin" + source: curl -k "https://localhost:9443/api/am/devportal/v4/throttling-policies/application/10PerMin" ###################################################### # The "Tag Collection" resource API @@ -3163,7 +3159,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/tags" + source: curl -k "https://localhost:9443/api/am/devportal/v4/tags" ###################################################### # The "Content Search Results" resource APIs @@ -3219,7 +3215,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/search?query=PizzaShackAPI" + source: curl -k "https://localhost:9443/api/am/devportal/v4/search?query=PizzaShackAPI" ###################################################### # The "SDK Generation Languages" list resource APIs @@ -3250,7 +3246,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/sdk-gen/languages" + "https://localhost:9443/api/am/devportal/v4/sdk-gen/languages" ###################################################### # The Web hook API topic details @@ -3293,7 +3289,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/webhooks/subscriptions?applicationId=5b65808c-cdf2-43e1-a695-de63e3ad0ae9&apiId=ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://localhost:9443/api/am/devportal/v4/webhooks/subscriptions?applicationId=5b65808c-cdf2-43e1-a695-de63e3ad0ae9&apiId=ae4eae22-3f65-387b-a171-d37eaa366fa8" ###################################################### # The Developer Portal settings List @@ -3324,7 +3320,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/settings"' + "https://localhost:9443/api/am/devportal/v4/settings"' /settings/application-attributes: get: @@ -3361,7 +3357,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/settings/application-attributes"' + "https://localhost:9443/api/am/devportal/v4/settings/application-attributes"' ###################################################### # The tenant resource APIs @@ -3412,7 +3408,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/tenants" + source: curl -k "https://localhost:9443/api/am/devportal/v4/tenants" ###################################################### # The "Recommendations" resource API @@ -3447,7 +3443,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/recommendations"' + "https://localhost:9443/api/am/devportal/v4/recommendations"' ###################################################### # The "Category Collection" resource API @@ -3474,7 +3470,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/api-categories" + source: curl -k "https://localhost:9443/api/am/devportal/v4/api-categories" ###################################################### # The "Key Manager Collection" resource API @@ -3503,7 +3499,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/devportal/v3/key-managers"' + "https://localhost:9443/api/am/devportal/v4/key-managers"' ###################################################### # GraphQL "Query Complexity" resource APIs @@ -3542,7 +3538,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/graphql-policies/complexity" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/graphql-policies/complexity" /apis/{apiId}/graphql-policies/complexity/types: get: @@ -3578,7 +3574,7 @@ paths: - OAuth2Security: [] x-code-samples: - lang: Curl - source: curl -k "https://localhost:9443/api/am/devportal/v3/apis/e93fb282-b456-48fc-8981-003fb89086ae/graphql-policies/complexity/types" + source: curl -k "https://localhost:9443/api/am/devportal/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/graphql-policies/complexity/types" ###################################################### # User resource APIs @@ -3611,7 +3607,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v3/me/change-password"' + -H "Content-Type: application/json" -X POST -d @data.json "https://localhost:9443/api/am/devportal/v4/me/change-password"' components: schemas: @@ -3762,6 +3758,9 @@ components: description: | Custom(user defined) properties of API example: { } + monetizedInfo: + type: boolean + example: true APIInfoList: title: API Info List type: object @@ -3854,6 +3853,11 @@ components: Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used. example: Authorization + apiKeyHeader: + type: string + description: | + Name of the API key header used for invoking the API. If it is not set, default value `apiKey` will be used. + example: ApiKey securityScheme: type: array description: | @@ -5133,6 +5137,11 @@ components: type: string description: Average rating of the API example: "4.5" + monetizedInfo: + type: boolean + example: true + advertiseInfo: + $ref: '#/components/schemas/AdvertiseInfo' DocumentSearchResult: title: Document Result allOf: diff --git a/en/docs/reference/product-apis/gateway-apis/gateway-v2/gateway-v2.yaml b/en/docs/reference/product-apis/gateway-apis/gateway-v2/gateway-v2.yaml index 9ebaa02ed2..47e4f3c5b3 100644 --- a/en/docs/reference/product-apis/gateway-apis/gateway-v2/gateway-v2.yaml +++ b/en/docs/reference/product-apis/gateway-apis/gateway-v2/gateway-v2.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -18,7 +18,7 @@ swagger: '2.0' # Prolog ###################################################### info: - version: "v2.2" + version: "v2.3" title: "WSO2 API Manager - Gateway" description: | This document specifies a **RESTful API** for WSO2 **API Manager** - Gateway. @@ -944,4 +944,4 @@ definitions: #----------------------------------------------------- # END-OF-FILE -#----------------------------------------------------- \ No newline at end of file +#----------------------------------------------------- diff --git a/en/docs/reference/product-apis/overview.md b/en/docs/reference/product-apis/overview.md index d702e6d1a6..977092a77a 100644 --- a/en/docs/reference/product-apis/overview.md +++ b/en/docs/reference/product-apis/overview.md @@ -5,15 +5,15 @@ The following topics list the APIs exposed from the API Publisher, Developer Por
- + - + - + diff --git a/en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.md b/en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.md similarity index 81% rename from en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.md rename to en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.md index 19a458c0ae..3e27b1d179 100644 --- a/en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.md +++ b/en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.md @@ -2,5 +2,5 @@ template: templates/redoc.html --- - + diff --git a/en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.yaml b/en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.yaml similarity index 93% rename from en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.yaml rename to en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.yaml index 34786cdb6a..f9e5ccb95e 100644 --- a/en/docs/reference/product-apis/publisher-apis/publisher-v4/publisher-v4.yaml +++ b/en/docs/reference/product-apis/publisher-apis/publisher-v5/publisher-v5.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -60,11 +60,6 @@ info: "tokenType": null } ``` - - - Note that in a distributed deployment or IS as KM separated environment to invoke RESTful APIs (product APIs), users must generate tokens through API-M Control Plane's token endpoint. - The tokens generated using third party key managers, are to manage end-user authentication when accessing APIs. - Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. You also need to add the proper **scope** when getting the access token. All possible scopes for publisher REST API can be viewed in **OAuth2 Security** section @@ -101,7 +96,7 @@ info: * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance. - [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25611032-8753756c-7f03-4f5b-8738-603f426a54a2) + [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/17491134-edb4ef7a-1ac7-420b-8651-2d9fd5585f6c) contact: name: WSO2 url: https://wso2.com/api-manager/ @@ -109,9 +104,9 @@ info: license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html - version: v4 + version: v5 servers: - - url: https://apis.wso2.com/api/am/publisher/v4 + - url: https://apis.wso2.com/api/am/publisher/v5 security: - OAuth2Security: - apim:api_view @@ -198,7 +193,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis"' operationId: getAllAPIs post: @@ -215,11 +210,10 @@ paths: description: Open api version schema: type: string - default: v4 + default: v3 enum: - v2 - v3 - - v4 requestBody: description: API object that needs to be added content: @@ -264,7 +258,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis"' operationId: createAPI ###################################################### @@ -325,7 +319,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f"' operationId: getAPI put: @@ -394,7 +388,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f"' operationId: updateAPI delete: @@ -428,7 +422,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f"' operationId: deleteAPI /apis/{apiId}/topics: @@ -488,7 +482,7 @@ paths: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f/topics"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f/topics"' /apis/{apiId}/reimport-service: put: @@ -530,7 +524,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/ecb5b300-422d-4ee8-88d2-364a0a122238/reimport-service"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/ecb5b300-422d-4ee8-88d2-364a0a122238/reimport-service"' /apis/{apiId}/swagger: get: @@ -586,7 +580,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f/swagger"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f/swagger"' operationId: getAPISwagger put: @@ -660,7 +654,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F apiDefinition=@swagger.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/swagger"' + -F apiDefinition=@swagger.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/swagger"' operationId: updateAPISwagger /apis/{apiId}/generate-mock-scripts: @@ -717,7 +711,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f/generate-mock-scripts"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f/generate-mock-scripts"' /apis/{apiId}/generated-mock-scripts: get: @@ -772,7 +766,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f/generated-mock-scripts"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f/generated-mock-scripts"' /apis/{apiId}/resource-policies: get: @@ -842,7 +836,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies?resourcePath=checkPhoneNumber&verb=post&sequenceType=in"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies?resourcePath=checkPhoneNumber&verb=post&sequenceType=in"' operationId: getAPIResourcePolicies /apis/{apiId}/resource-policies/{resourcePolicyId}: @@ -901,7 +895,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies/8efc32a4-c7f1-4bee-b860-b7566e2bc0d5"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies/8efc32a4-c7f1-4bee-b860-b7566e2bc0d5"' operationId: getAPIResourcePoliciesByPolicyId put: @@ -968,7 +962,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies/8efc32a4-c7f1-4bee-b860-b7566e2bc0d5"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/resource-policies/8efc32a4-c7f1-4bee-b860-b7566e2bc0d5"' operationId: updateAPIResourcePoliciesByPolicyId /apis/{apiId}/thumbnail: @@ -1021,7 +1015,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/thumbnail"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/thumbnail"' operationId: getAPIThumbnail put: @@ -1092,7 +1086,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@image.jpeg "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/thumbnail"' + -F file=@image.jpeg "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/thumbnail"' /apis/{apiId}/subscription-policies: get: @@ -1146,7 +1140,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/subscription-policies"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/2fd14eb8-b828-4013-b448-0739d2e76bf7/subscription-policies"' operationId: getAPISubscriptionPolicies /apis/copy-api: @@ -1203,7 +1197,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/copy-api?newVersion=2.0&defaultVersion=false&apiId=2fd14eb8-b828-4013-b448-0739d2e76bf7"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/copy-api?newVersion=2.0&defaultVersion=false&apiId=2fd14eb8-b828-4013-b448-0739d2e76bf7"' operationId: createNewAPIVersion /apis/change-lifecycle: @@ -1244,7 +1238,7 @@ paths: 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. You can specify additional checklist items by using an **"attribute:"** modifier. Eg: "Deprecate old versions after publishing the API:true" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in "attribute1:true, attribute2:false" format. - **Sample CURL :** curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -X POST "https://localhost:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse" + **Sample CURL :** curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -X POST "https://localhost:9443/api/am/publisher/v5/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse" schema: type: string - $ref: '#/components/parameters/apiId-Q' @@ -1294,7 +1288,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish"' operationId: changeAPILifecycle /apis/{apiId}/lifecycle-history: @@ -1343,7 +1337,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-history"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-history"' operationId: getAPILifecycleHistory /apis/{apiId}/lifecycle-state: @@ -1400,7 +1394,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state"' operationId: getAPILifecycleState /apis/{apiId}/lifecycle-state/pending-tasks: @@ -1429,7 +1423,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state/pending-tasks"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state/pending-tasks"' operationId: deleteAPILifecycleStatePendingTasks ###################################################### @@ -1474,7 +1468,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions?query=deployed:true"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions?query=deployed:true"' #-------------------------------------------- # Create a new API revision @@ -1517,7 +1511,7 @@ paths: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions"' ###################################################### # The "API Revisions" individual resource API @@ -1557,7 +1551,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' #-------------------------------------------- # Delete a revision @@ -1596,7 +1590,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' /apis/{apiId}/deployments: #-------------------------------------------- @@ -1631,7 +1625,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments"' /apis/{apiId}/deployments/{deploymentId}: #-------------------------------------------- @@ -1672,7 +1666,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments/UHJvZHVjdGlvbiBhbmQgU2FuZGJveA"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments/UHJvZHVjdGlvbiBhbmQgU2FuZGJveA"' /apis/{apiId}/deploy-revision: #-------------------------------------------- @@ -1719,7 +1713,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' /apis/{apiId}/undeploy-revision: #-------------------------------------------- @@ -1776,7 +1770,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/undeploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/undeploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' /apis/{apiId}/restore-revision: @@ -1812,7 +1806,41 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/restore-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/restore-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + + /apis/{apiId}/cancel-revision-workflow/{revisionId}/{envName}: + #-------------------------------------------------------- + # Cancel a pending revision deployment workflow task given revision id and environment name + #-------------------------------------------------------- + delete: + tags: + - API Revisions + summary: Delete Pending Revision Deployment Workflow Tasks + description: | + This operation can be used to remove pending revision deployment requests that are in pending state + parameters: + - $ref: '#/components/parameters/apiId' + - $ref: '#/components/parameters/revisionId' + - $ref: '#/components/parameters/envName' + responses: + 200: + description: | + OK. + Revision deployment pending task removed successfully. + content: { } + 404: + $ref: '#/components/responses/NotFound' + 412: + $ref: '#/components/responses/PreconditionFailed' + security: + - OAuth2Security: + - apim:api_publish + - apim:api_manage + x-code-samples: + - lang: Curl + source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://127.0.0.1:9443/api/am/publisher/v5/apis/890a4f4d-09eb-4877-a323-57f6ce2ed79b/cancel-revision-workflow/e0824883-3e86-403a-aec1-22bbc454eb7c/Default"' + operationId: deleteAPIRevisionDeploymentPendingTask /apis/import-service: post: @@ -1866,7 +1894,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-service?serviceKey=Pizzashack-1.0.0"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-service?serviceKey=Pizzashack-1.0.0"' /apis/{apiId}/comments: get: @@ -1903,7 +1931,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' + "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' post: tags: @@ -1974,7 +2002,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' + -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments"' /apis/{apiId}/comments/{commentId}: get: @@ -2030,7 +2058,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' + "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' patch: tags: @@ -2102,7 +2130,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PATCH -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' + -H "Content-Type: application/json" -d @data.json "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4"' delete: tags: @@ -2142,7 +2170,7 @@ paths: x-code-samples: - lang: Curl source: curl -k -X DELETE -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" + "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4" /apis/{apiId}/comments/{commentId}/replies: get: @@ -2198,7 +2226,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization:Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://localhost:9443/api/am/publisher/v4/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4/replies"' + "https://localhost:9443/api/am/publisher/v5/apis/e93fb282-b456-48fc-8981-003fb89086ae/comments/d4cf1704-5d09-491c-bc48-4d19ce6ea9b4/replies"' /apis/import-openapi: post: @@ -2266,7 +2294,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@openapi.json -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-openapi"' + -F file=@openapi.json -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-openapi"' /apis/import-wsdl: post: @@ -2292,11 +2320,11 @@ paths: **Sample cURL to Upload WSDL File** - curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F file=@api.wsdl -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl" + curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F file=@api.wsdl -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-wsdl" **Sample cURL to Upload WSDL Archive** - curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F file="@wsdl.zip;type=application/zip" -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl" + curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -F file="@wsdl.zip;type=application/zip" -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-wsdl" format: binary url: type: string @@ -2354,7 +2382,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@api.wsdl -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-wsdl"' + -F file=@api.wsdl -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-wsdl"' /apis/import-graphql-schema: post: @@ -2425,7 +2453,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@schema.graphql -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-graphql-schema"' + -F file=@schema.graphql -F additionalProperties=@data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-graphql-schema"' operationId: importGraphQLSchema /apis/validate-openapi: @@ -2487,7 +2515,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@openapi.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate-openapi"' + -F file=@openapi.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate-openapi"' /apis/validate-endpoint: post: @@ -2535,7 +2563,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate-endpoint?apiId=e0824883-3e86-403a-aec1-22bbc454eb7c&endpointUrl=https%3A%2F%2Flocalhost%3A9443%2Fam%2Fsample%2Fpizzashack%2Fv1%2Fapi%2F"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate-endpoint?apiId=e0824883-3e86-403a-aec1-22bbc454eb7c&endpointUrl=https%3A%2F%2Flocalhost%3A9443%2Fam%2Fsample%2Fpizzashack%2Fv1%2Fapi%2F"' /apis/validate: post: @@ -2587,7 +2615,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate?query=name%3Awso2"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate?query=name%3Awso2"' /apis/validate-wsdl: post: @@ -2636,7 +2664,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@api.wsdl "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate-wsdl"' + -F file=@api.wsdl "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate-wsdl"' /apis/validate-graphql-schema: post: @@ -2683,7 +2711,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@schema.graphql "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate-graphql-schema"' + -F file=@schema.graphql "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate-graphql-schema"' operationId: validateGraphQLSchema /apis/{apiId}/graphql-schema: @@ -2739,7 +2767,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/graphql-schema"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/graphql-schema"' operationId: getAPIGraphQLSchema put: @@ -2805,7 +2833,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F schemaDefinition=@schema.graphql "https://127.0.0.1:9443/api/am/publisher/v4/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/graphql-schema"' + -F schemaDefinition=@schema.graphql "https://127.0.0.1:9443/api/am/publisher/v5/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/graphql-schema"' operationId: updateAPIGraphQLSchema /apis/{apiId}/amznResourceNames: @@ -2849,7 +2877,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/amznResourceNames"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/amznResourceNames"' operationId: getAmazonResourceNamesOfAPI /apis/{apiId}/monetize: @@ -2887,7 +2915,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/monetize' + -H "Content-Type: application/json" -d @data.json https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/monetize' operationId: addAPIMonetization /apis/{apiId}/monetization: @@ -2919,7 +2947,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/monetization"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/monetization"' operationId: getAPIMonetization /apis/{apiId}/revenue: @@ -2970,7 +2998,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/revenue"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/revenue"' operationId: getAPIRevenue /apis/{apiId}/documents: @@ -3022,7 +3050,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/documents"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/e0824883-3e86-403a-aec1-22bbc454eb7c/documents"' operationId: getAPIDocuments post: @@ -3081,7 +3109,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents"' operationId: addAPIDocument /apis/{apiId}/documents/{documentId}: @@ -3139,7 +3167,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' operationId: getAPIDocumentByDocumentId put: @@ -3205,7 +3233,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @doc.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' + -H "Content-Type: application/json" -d @doc.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' operationId: updateAPIDocument delete: @@ -3236,7 +3264,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5"' operationId: deleteAPIDocument /apis/{apiId}/documents/{documentId}/content: @@ -3252,7 +3280,7 @@ paths: 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type - _Sample cURL_ : `curl -k -H "Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51" -F inlineContent=@"docs.txt" -X POST "https://localhost:9443/api/am/publisher/v4/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` + _Sample cURL_ : `curl -k -H "Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51" -F inlineContent=@"docs.txt" -X POST "https://localhost:9443/api/am/publisher/v5/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: @@ -3316,7 +3344,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content"' operationId: getAPIDocumentContentByDocumentId post: @@ -3393,7 +3421,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@sample.pdf "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content"' + -F file=@sample.pdf "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/0bcb7f05-599d-4e1a-adce-5cb89bfe58d5/content"' operationId: addAPIDocumentContent /apis/{apiId}/documents/validate: @@ -3434,7 +3462,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/validate?name=CalculatorDoc"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/documents/validate?name=CalculatorDoc"' /apis/{apiId}/wsdl-info: get: @@ -3467,7 +3495,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl-info"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl-info"' /apis/{apiId}/wsdl: get: @@ -3516,7 +3544,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl"' put: tags: @@ -3585,7 +3613,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@api.wsdl "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl"' + -F file=@api.wsdl "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/wsdl"' /apis/{apiId}/graphql-policies/complexity: get: @@ -3623,7 +3651,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity"' operationId: getGraphQLPolicyComplexityOfAPI @@ -3656,7 +3684,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity"' operationId: updateGraphQLPolicyComplexityOfAPI /apis/{apiId}/graphql-policies/complexity/types: @@ -3695,7 +3723,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity/types"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/graphql-policies/complexity/types"' operationId: getGraphQLPolicyComplexityTypesOfAPI /apis/{apiId}/resource-paths: @@ -3753,7 +3781,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/resource-paths"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/resource-paths"' operationId: getAPIResourcePaths /apis/{apiId}/auditapi: @@ -3791,7 +3819,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/auditapi"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/auditapi"' operationId: getAuditReportOfAPI /apis/{apiId}/external-stores: @@ -3836,7 +3864,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/external-stores"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/external-stores"' /apis/{apiId}/publish-to-external-stores: post: @@ -3888,7 +3916,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/publish-to-external-stores?externalStoreId=Store123#"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/publish-to-external-stores?externalStoreId=Store123#"' /apis/{apiId}/generate-key: post: @@ -3920,7 +3948,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/7a2298c4-c905-403f-8fac-38c73301631f/generate-key"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/7a2298c4-c905-403f-8fac-38c73301631f/generate-key"' /apis/export: get: @@ -4011,7 +4039,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/export?apiId=96077508-fd01-4fae-bc64-5de0e2baf43c&name=PizzaShackAPI&version=1.0&provider=admin&format=YAML" + "https://127.0.0.1:9443/api/am/publisher/v5/apis/export?apiId=96077508-fd01-4fae-bc64-5de0e2baf43c&name=PizzaShackAPI&version=1.0&provider=admin&format=YAML" > exportAPI.zip' operationId: exportAPI @@ -4075,7 +4103,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@admin-PizzaShackAPI-1.0.0.zip "https://127.0.0.1:9443/api/am/publisher/v4/apis/import?preserveProvider=false&overwrite=false"' + -F file=@admin-PizzaShackAPI-1.0.0.zip "https://127.0.0.1:9443/api/am/publisher/v5/apis/import?preserveProvider=false&overwrite=false"' operationId: importAPI ###################################################### @@ -4090,10 +4118,10 @@ paths: This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving all subscriptions for the user's APIs. - `GET https://127.0.0.1:9443/api/am/publisher/v4/subscriptions` + `GET https://127.0.0.1:9443/api/am/publisher/v5/subscriptions` 2. Retrieving subscriptions for a specific API. - `GET https://127.0.0.1:9443/api/am/publisher/v4/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` + `GET https://127.0.0.1:9443/api/am/publisher/v5/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` parameters: - $ref: '#/components/parameters/apiId-Q-Opt' - $ref: '#/components/parameters/limit' @@ -4141,7 +4169,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/subscriptions?apiId=96077508-fd01-4fae-bc64-5de0e2baf43c"' + "https://127.0.0.1:9443/api/am/publisher/v5/subscriptions?apiId=96077508-fd01-4fae-bc64-5de0e2baf43c"' operationId: getSubscriptions ###################################################### @@ -4201,7 +4229,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/subscriptions/64eca60b-2e55-4c38-8603-e9e6bad7d809/usage"' + "https://127.0.0.1:9443/api/am/publisher/v5/subscriptions/64eca60b-2e55-4c38-8603-e9e6bad7d809/usage"' operationId: getSubscriptionUsage /subscriptions/{subscriptionId}/subscriber-info: @@ -4232,7 +4260,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/subscriptions/64eca60b-2e55-4c38-8603-e9e6bad7d809/subscriber-info"' + "https://127.0.0.1:9443/api/am/publisher/v5/subscriptions/64eca60b-2e55-4c38-8603-e9e6bad7d809/subscriber-info"' operationId: getSubscriberInfoBySubscriptionId /subscriptions/block-subscription: @@ -4290,7 +4318,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/subscriptions/block-subscription?subscriptionId=64eca60b-2e55-4c38-8603-e9e6bad7d809&blockState=PROD_ONLY_BLOCKED"' + "https://127.0.0.1:9443/api/am/publisher/v5/subscriptions/block-subscription?subscriptionId=64eca60b-2e55-4c38-8603-e9e6bad7d809&blockState=PROD_ONLY_BLOCKED"' operationId: blockSubscription /subscriptions/unblock-subscription: @@ -4335,7 +4363,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/subscriptions/unblock-subscription?subscriptionId=64eca60b-2e55-4c38-8603-e9e6bad7d809"' + "https://127.0.0.1:9443/api/am/publisher/v5/subscriptions/unblock-subscription?subscriptionId=64eca60b-2e55-4c38-8603-e9e6bad7d809"' operationId: unBlockSubscription @@ -4391,7 +4419,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/throttling-policies/api"' + "https://127.0.0.1:9443/api/am/publisher/v5/throttling-policies/api"' ###################################################### # The "Subscription Throttling Based on Quota Type" resource APIs @@ -4443,7 +4471,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/throttling-policies/streaming/subscription?limit=10&offset=0"' + "https://127.0.0.1:9443/api/am/publisher/v5/throttling-policies/streaming/subscription?limit=10&offset=0"' ###################################################### # The "Individual Throttling Tier" resource APIs @@ -4504,7 +4532,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/throttling-policies/api/Platinum"' + "https://127.0.0.1:9443/api/am/publisher/v5/throttling-policies/api/Platinum"' /apis/{apiId}/client-certificates: get: @@ -4549,7 +4577,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates?alias=wso2carbon"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates?alias=wso2carbon"' operationId: getAPIClientCertificates post: @@ -4616,7 +4644,7 @@ paths: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: multipart/form-data" -F certificate=@test.crt -F alias=wso2carbon -F tier=Gold - "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates"' operationId: addAPIClientCertificate /apis/{apiId}/client-certificates/{alias}: @@ -4662,7 +4690,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' operationId: getAPIClientCertificateByAlias put: @@ -4729,7 +4757,7 @@ paths: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: multipart/form-data" -F certificate=@test.crt -F alias=wso2carbon - -F apiId=fea749dd-d548-4a8b-b308-34903b39a34b -F tier=Gold "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' + -F apiId=fea749dd-d548-4a8b-b308-34903b39a34b -F tier=Gold "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' operationId: updateAPIClientCertificateByAlias delete: @@ -4773,7 +4801,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon"' operationId: deleteAPIClientCertificateByAlias /apis/{apiId}/client-certificates/{alias}/content: @@ -4816,7 +4844,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon/content" > test.crt' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/d48a3412-1b85-49be-99f4-b81a3722ae73/client-certificates/wso2carbon/content" > test.crt' operationId: getAPIClientCertificateContentByAlias ###################################################### @@ -4872,7 +4900,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates?alias=wso2carbon&endpoint=www.abc.com"' + "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates?alias=wso2carbon&endpoint=www.abc.com"' operationId: getEndpointCertificates post: @@ -4937,7 +4965,7 @@ paths: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: multipart/form-data" -F certificate=@test.crt -F alias=alias - -F endpoint=https://www.abc.com "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates"' + -F endpoint=https://www.abc.com "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates"' operationId: addEndpointCertificate /endpoint-certificates/{alias}: @@ -4982,7 +5010,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates/wso2carbon"' + "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates/wso2carbon"' operationId: getEndpointCertificateByAlias put: @@ -5047,7 +5075,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: multipart/form-data" -F certificate=@test.crt "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates/wso2carbon"' + -H "Content-Type: multipart/form-data" -F certificate=@test.crt "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates/wso2carbon"' operationId: updateEndpointCertificateByAlias delete: @@ -5091,7 +5119,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates/wso2carbon"' + "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates/wso2carbon"' operationId: deleteEndpointCertificateByAlias /endpoint-certificates/{alias}/content: @@ -5133,7 +5161,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates/wso2carbon/content" > test.crt' + "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates/wso2carbon/content" > test.crt' operationId: getEndpointCertificateContentByAlias /endpoint-certificates/{alias}/usage: @@ -5181,7 +5209,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/endpoint-certificates/wso2cert/usage"' + "https://127.0.0.1:9443/api/am/publisher/v5/endpoint-certificates/wso2cert/usage"' operationId: getCertificateUsageByAlias ###################################################### @@ -5242,7 +5270,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/search?query=pizza"' + "https://127.0.0.1:9443/api/am/publisher/v5/search?query=pizza"' operationId: search ###################################################### @@ -5300,7 +5328,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products?query=PizzaAPIProduct"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products?query=PizzaAPIProduct"' operationId: getAllAPIProducts post: @@ -5353,7 +5381,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/api-products"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/api-products"' operationId: createAPIProduct ################################################################ @@ -5414,7 +5442,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' operationId: getAPIProduct put: @@ -5480,7 +5508,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' operationId: updateAPIProduct @@ -5513,7 +5541,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33"' operationId: deleteAPIProduct /api-products/{apiProductId}/thumbnail: @@ -5568,7 +5596,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/thumbnail" + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/thumbnail" > image.jpeg' operationId: getAPIProductThumbnail @@ -5638,7 +5666,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: multipart/form-data" -F file=@image.jpeg "https://127.0.0.1:9443/api/am/publisher/v4/api-products/d48a3412-1b85-49be-99f4-b81a3722ae73/thumbnail"' + -H "Content-Type: multipart/form-data" -F file=@image.jpeg "https://127.0.0.1:9443/api/am/publisher/v5/api-products/d48a3412-1b85-49be-99f4-b81a3722ae73/thumbnail"' operationId: updateAPIProductThumbnail /api-products/{apiProductId}/swagger: @@ -5692,7 +5720,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/swagger"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/swagger"' operationId: getAPIProductSwagger /api-products/{apiProductId}/is-outdated: @@ -5798,7 +5826,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents"' operationId: getAPIProductDocuments post: @@ -5854,7 +5882,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents"' operationId: addAPIProductDocument /api-products/{apiProductId}/documents/{documentId}: @@ -5913,7 +5941,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' operationId: getAPIProductDocument put: @@ -5978,7 +6006,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' operationId: updateAPIProductDocument delete: @@ -6008,7 +6036,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3"' operationId: deleteAPIProductDocument /api-products/{apiProductId}/documents/{documentId}/content: @@ -6024,7 +6052,7 @@ paths: 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type - _Sample cURL_ : `curl -k -H "Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51" -F inlineContent=@"docs.txt" -X POST "https://localhost:9443/api/am/publisher/v4/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` + _Sample cURL_ : `curl -k -H "Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51" -F inlineContent=@"docs.txt" -X POST "https://localhost:9443/api/am/publisher/v5/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: @@ -6086,7 +6114,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3/content"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3/content"' operationId: getAPIProductDocumentContent post: @@ -6161,7 +6189,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: multipart/form-data" -F file=@sample.pdf "https://127.0.0.1:9443/api/am/publisher/v4/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3/content"' + -H "Content-Type: multipart/form-data" -F file=@sample.pdf "https://127.0.0.1:9443/api/am/publisher/v5/api-products/5bca47e1-8233-46a5-9295-525dca337f33/documents/83312daf-0d8a-427b-8f72-12755b7901d3/content"' operationId: addAPIProductDocumentContent ###################################################### @@ -6206,7 +6234,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions?query=deployed:true"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions?query=deployed:true"' #-------------------------------------------- # Create a new API Product revision @@ -6248,7 +6276,7 @@ paths: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions"' ###################################################### # The "API Revisions" individual resource API Product @@ -6288,7 +6316,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' #-------------------------------------------- # Delete a revision @@ -6326,7 +6354,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/revisions/e0824883-3e86-403a-aec1-22bbc454eb7c"' /api-products/{apiProductId}/deployments: #-------------------------------------------- @@ -6361,7 +6389,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments"' /api-products/{apiProductId}/deployments/{deploymentId}: #-------------------------------------------- @@ -6402,7 +6430,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments/UHJvZHVjdGlvbiBhbmQgU2FuZGJveA"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deployments/UHJvZHVjdGlvbiBhbmQgU2FuZGJveA"' /api-products/{apiProductId}/deploy-revision: #-------------------------------------------- @@ -6452,7 +6480,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/deploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' /api-products/{apiProductId}/undeploy-revision: #-------------------------------------------- @@ -6509,7 +6537,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/undeploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/undeploy-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' /api-products/{apiProductId}/restore-revision: @@ -6545,7 +6573,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/restore-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/restore-revision?revisionId=e0824883-3e86-403a-aec1-22bbc454eb7c"' /api-products/copy-api-products: #-------------------------------------------------------- @@ -6597,7 +6625,8 @@ paths: - apim:api_manage x-code-samples: - lang: Curl - source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/publisher/v4/api-products/copy-api-products?newVersion=2.0&defaultVersion=false&apiProductId=2fd14eb8-b828-4013-b448-0739d2e76bf7"' + source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/copy-api-products?newVersion=2.0&defaultVersion=false&apiproductId=2fd14eb8-b828-4013-b448-0739d2e76bf7"' operationId: createNewAPIProductVersion /api-products/export: @@ -6681,7 +6710,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/export?name=LeasingAPIProduct&version=1.0.0&revisionNumber=2&provider=admin&format=YAML" + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/export?name=LeasingAPIProduct&version=1.0.0&revisionNumber=2&provider=admin&format=YAML" > exportAPIProduct.zip' operationId: exportAPIProduct @@ -6757,7 +6786,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@admin-PizzaShackAPIProduct.zip "https://127.0.0.1:9443/api/am/publisher/v4/api-products/import?preserveProvider=false&overwriteAPIProduct=false&overwriteAPIs=false&importAPIs=false"' + -F file=@admin-PizzaShackAPIProduct.zip "https://127.0.0.1:9443/api/am/publisher/v5/api-products/import?preserveProvider=false&overwriteAPIProduct=false&overwriteAPIs=false&importAPIs=false"' operationId: importAPIProduct ###################################################### @@ -6787,7 +6816,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -I -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' + "https://127.0.0.1:9443/api/am/publisher/v5/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' /me/roles/{roleId}: head: @@ -6812,7 +6841,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -I -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/me/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' + "https://127.0.0.1:9443/api/am/publisher/v5/me/roles/SW50ZXJuYWwvcHVibGlzaGVyCQ"' ###################################################### # The "ExternalStore Collection" resource APIs @@ -6843,7 +6872,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/external-stores"' + "https://127.0.0.1:9443/api/am/publisher/v5/external-stores"' ###################################################### # The Publisher settings resource APIs @@ -6873,7 +6902,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/settings"' + "https://127.0.0.1:9443/api/am/publisher/v5/settings"' operationId: getSettings ###################################################### @@ -6914,7 +6943,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/linter-custom-rules"' + "https://127.0.0.1:9443/api/am/publisher/v5/linter-custom-rules"' ###################################################### # The tenant resource APIs ###################################################### @@ -6968,7 +6997,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/tenants?state=active"' + "https://127.0.0.1:9443/api/am/publisher/v5/tenants?state=active"' /tenants/{tenantDomain}: head: @@ -6993,7 +7022,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -I -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/tenants/wso2.com"' + "https://127.0.0.1:9443/api/am/publisher/v5/tenants/wso2.com"' ###################################################### # The "API Category Collection" resource API @@ -7021,7 +7050,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-categories"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-categories"' operationId: getAllAPICategories ###################################################### @@ -7062,7 +7091,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/scopes"' + "https://127.0.0.1:9443/api/am/publisher/v5/scopes"' post: tags: @@ -7103,7 +7132,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/scopes"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/scopes"' /scopes/{scopeId}: get: @@ -7139,7 +7168,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/scopes/01234567-0123-0123-0123-012345678901"' + "https://127.0.0.1:9443/api/am/publisher/v5/scopes/01234567-0123-0123-0123-012345678901"' put: tags: @@ -7182,7 +7211,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v4/scopes/01234567-0123-0123-0123-012345678901"' + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/scopes/01234567-0123-0123-0123-012345678901"' delete: tags: @@ -7207,7 +7236,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/scopes/01234567-0123-0123-0123-012345678901"' + "https://127.0.0.1:9443/api/am/publisher/v5/scopes/01234567-0123-0123-0123-012345678901"' head: tags: @@ -7233,7 +7262,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -I -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/scopes/YXBpbTphcGlfdmlldw"' + "https://127.0.0.1:9443/api/am/publisher/v5/scopes/YXBpbTphcGlfdmlldw"' /scopes/{scopeId}/usage: get: @@ -7270,7 +7299,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/scopes/01234567-0123-0123-0123-012345678901/usage"' + "https://127.0.0.1:9443/api/am/publisher/v5/scopes/01234567-0123-0123-0123-012345678901/usage"' ###################################################### # The "Key Managers Collection" resource API @@ -7299,7 +7328,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/key-managers"' + "https://127.0.0.1:9443/api/am/publisher/v5/key-managers"' operationId: getAllKeyManagers /apis/validate-asyncapi: @@ -7358,7 +7387,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@streetlights.yml "https://127.0.0.1:9443/api/am/publisher/v4/apis/validate-asyncapi"' + -F file=@streetlights.yml "https://127.0.0.1:9443/api/am/publisher/v5/apis/validate-asyncapi"' /apis/import-asyncapi: post: @@ -7422,7 +7451,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@streetlights.yml -F additionalProperties=@import-asyncapi.json "https://127.0.0.1:9443/api/am/publisher/v4/apis/import-asyncapi"' + -F file=@streetlights.yml -F additionalProperties=@import-asyncapi.json "https://127.0.0.1:9443/api/am/publisher/v5/apis/import-asyncapi"' /apis/{apiId}/asyncapi: get: @@ -7478,7 +7507,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/01234567-0123-0123-0123-012345678901/asyncapi"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/01234567-0123-0123-0123-012345678901/asyncapi"' put: tags: @@ -7551,7 +7580,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=@streetlights.yml "https://127.0.0.1:9443/api/am/publisher/v4/apis/01234567-0123-0123-0123-012345678901/asyncapi"' + -F file=@streetlights.yml "https://127.0.0.1:9443/api/am/publisher/v5/apis/01234567-0123-0123-0123-012345678901/asyncapi"' /apis/{apiId}/environments/{envId}/keys: get: tags: @@ -7584,7 +7613,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/01234567-0123-0123-0123-012345678901/environments/9b37ac57-78b9-4fac-b0d4-dc8f4b15c023/keys"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/01234567-0123-0123-0123-012345678901/environments/9b37ac57-78b9-4fac-b0d4-dc8f4b15c023/keys"' put: tags: - APIs @@ -7622,7 +7651,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json - "https://127.0.0.1:9443/api/am/publisher/v4/apis/01234567-0123-0123-0123-012345678901/environments/9b37ac57-78b9-4fac-b0d4-dc8f4b15c023/keys"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/01234567-0123-0123-0123-012345678901/environments/9b37ac57-78b9-4fac-b0d4-dc8f4b15c023/keys"' /apis/{apiId}/operation-policies: get: tags: @@ -7669,7 +7698,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies"' post: tags: @@ -7736,7 +7765,7 @@ paths: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: multipart/form-data" -F policySpecFile=@setHeader.yaml -F policyDefinitionFile=@setHeader.j2 - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies"' /apis/{apiId}/operation-policies/{operationPolicyId}: @@ -7781,7 +7810,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' delete: tags: @@ -7814,7 +7843,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' /apis/{apiId}/operation-policies/{operationPolicyId}/content: get: @@ -7857,7 +7886,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a/content"' + "https://127.0.0.1:9443/api/am/publisher/v5/apis/96077508-fd01-4fae-bc64-5de0e2baf43c/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a/content"' /operation-policies: get: @@ -7919,7 +7948,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies"' + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies"' post: tags: - Operation Policies @@ -7980,7 +8009,7 @@ paths: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: multipart/form-data" -F policySpecFile=@setHeader.yaml -F policyDefinitionFile=@setHeader.j2 - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies"' + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies"' /operation-policies/export: get: @@ -8034,7 +8063,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies/export?name=addHeader&version=v1" + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies/export?name=addHeader&version=v1" > addHeader_v1.zip' /operation-policies/import: @@ -8072,7 +8101,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - -F file=add_header_v1.zip "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies/import"' + -F file=add_header_v1.zip "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies/import"' operationId: importOperationPolicy /operation-policies/{operationPolicyId}: @@ -8114,7 +8143,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' delete: tags: @@ -8144,7 +8173,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' /operation-policies/{operationPolicyId}/content: get: @@ -8183,7 +8212,276 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a/content"' + "https://127.0.0.1:9443/api/am/publisher/v5/operation-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a/content"' + + ###################################################### + # The Gateway Policies API + ###################################################### + /gateway-policies: + post: + tags: + - Gateway Policies + summary: Engage gateway policies to the request, response, fault flows + description: | + This operation can be used to apply gateway policies to the request, response, fault flows. + operationId: addGatewayPoliciesToFlows + requestBody: + description: Policy details object that needs to be added. + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappings' + required: true + responses: + 201: + description: | + OK. + Policy mapping created successfully. + headers: + Location: + description: | + The URL of the created gateway policy mapping. + schema: + type: string + Content-Type: + description: | + The content type of the body. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappingInfo' + 400: + $ref: '#/components/responses/BadRequest' + 404: + $ref: '#/components/responses/NotFound' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies"' + + get: + tags: + - Gateway Policies + summary: | + Get all gateway policies mapping information + description: | + This operation provides you a list of all gateway policies mapping information. + operationId: getAllGatewayPolicies + parameters: + - $ref: '#/components/parameters/policyLimit' + - $ref: '#/components/parameters/offset' + - name: query + in: query + description: | + **Search condition**. + + You can search in attributes by using an **"gatewayLabel:"** modifier. + + Eg. + The entry "gatewayLabel:gateway1" will result in a match with a Gateway Policy Mapping only if the policy mapping is deployed on "gateway1". + + If query attribute is provided, this returns the Gateway policy Mapping available under the given limit. + + Please note that you need to use encoded URL (URL encoding) if you are using a client which does not support URL encoding (such as curl) + schema: + type: string + responses: + 200: + description: | + OK. + List of gateway policies is returned. + headers: + Content-Type: + description: The content type of the body. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappingDataList' + 404: + $ref: '#/components/responses/NotFound' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_view + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies"' + + /gateway-policies/{gatewayPolicyMappingId}: + get: + tags: + - Gateway Policies + summary: Retrieve information of a selected gateway policy mapping + description: | + This operation can be used to retrieve information of a selected gateway policy mapping. + operationId: getGatewayPolicyMappingContentByPolicyMappingId + parameters: + - $ref: '#/components/parameters/gatewayPolicyMappingId' + responses: + 200: + description: | + OK. + Gateway policy mapping information returned. + headers: + Content-Type: + description: | + The content type of the body. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappings' + 404: + $ref: '#/components/responses/NotFound' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_view + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + + delete: + tags: + - Gateway Policies + summary: Delete a gateway policy mapping + description: | + This operation can be used to delete an existing gateway policy mapping by providing the Id of the policy mapping. + operationId: deleteGatewayPolicyByPolicyId + parameters: + - $ref: '#/components/parameters/gatewayPolicyMappingId' + responses: + 200: + description: | + OK. + Resource successfully deleted. + content: { } + 403: + $ref: '#/components/responses/Forbidden' + 404: + $ref: '#/components/responses/NotFound' + 412: + $ref: '#/components/responses/PreconditionFailed' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + + put: + tags: + - Gateway Policies + summary: Update gateway policies added to the request, response, fault flows + description: | + This operation can be used to update already added gateway policies to the request, response, fault flows. + operationId: updateGatewayPoliciesToFlows + parameters: + - $ref: '#/components/parameters/gatewayPolicyMappingId' + requestBody: + description: Policy details object that needs to be updated. + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappings' + required: true + responses: + 200: + description: | + OK. + Policy mapping updated successfully. + headers: + Content-Type: + description: | + The content type of the body. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GatewayPolicyMappings' + 400: + $ref: '#/components/responses/BadRequest' + 404: + $ref: '#/components/responses/NotFound' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies/f56eb8b4-128c-45aa-ad35-9c87a546261a"' + + /gateway-policies/{gatewayPolicyMappingId}/deploy: + post: + tags: + - Gateway Policies + summary: Engage gateway policy mapping to the gateways + description: | + This operation can be used to engage gateway policy mapping to the gateway/s. + operationId: engageGlobalPolicy + parameters: + - $ref: '#/components/parameters/gatewayPolicyMappingId' + requestBody: + description: Policy details object that needs to be added. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GatewayPolicyDeployment' + required: true + responses: + 200: + description: | + OK. + Gateway policy mapping engaged successfully. + headers: + Content-Type: + description: | + The content type of the body. + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GatewayPolicyDeployment' + 400: + $ref: '#/components/responses/BadRequest' + 404: + $ref: '#/components/responses/NotFound' + 500: + $ref: '#/components/responses/InternalServerError' + security: + - OAuth2Security: + - apim:gateway_policy_manage + x-code-samples: + - lang: Curl + source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" + -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/publisher/v5/gateway-policies/deploy"' /api-products/change-lifecycle: post: @@ -8226,7 +8524,7 @@ paths: 2. **Requires re-subscription when publishing the API**: If you set this to true, users need to re subscribe to the API Products although they may have subscribed to an older version. You can specify additional checklist items by using an **"attribute:"** modifier. Eg: "Deprecate old versions after publishing the API:true" will deprecate older versions of a particular API Product when it is promoted to Published state from Created state. Multiple checklist items can be given in "attribute1:true, attribute2:false" format. - **Sample CURL :** curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -X POST "https://localhost:9443/api/am/publisher/v4/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse" + **Sample CURL :** curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -X POST "https://localhost:9443/api/am/publisher/v5/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish&lifecycleChecklist=Deprecate%20old%20versions%20after%20publishing%20the%20API%3Atrue,Requires%20re-subscription%20when%20publishing%20the%20API%3Afalse" schema: type: string - $ref: '#/components/parameters/apiProductId-Q' @@ -8258,7 +8556,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/change-lifecycle?apiId=890a4f4d-09eb-4877-a323-57f6ce2ed79b&action=Publish"' operationId: changeAPIProductLifecycle /api-products/{apiProductId}/lifecycle-history: @@ -8293,7 +8591,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-history"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-history"' operationId: getAPIProductLifecycleHistory /api-products/{apiProductId}/lifecycle-state: @@ -8329,7 +8627,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state"' operationId: getAPIProductLifecycleState /api-products/{apiProductId}/lifecycle-state/pending-tasks: @@ -8360,7 +8658,7 @@ paths: x-code-samples: - lang: Curl source: 'curl -k -X DELETE -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" - "https://127.0.0.1:9443/api/am/publisher/v4/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state/pending-tasks"' + "https://127.0.0.1:9443/api/am/publisher/v5/api-products/890a4f4d-09eb-4877-a323-57f6ce2ed79b/lifecycle-state/pending-tasks"' operationId: deleteAPIProductLifecycleStatePendingTasks components: @@ -8553,6 +8851,21 @@ components: advertiseOnly: type: boolean example: true + monetizedInfo: + type: boolean + example: true + businessOwner: + type: string + example: Business Owner + businessOwnerEmail: + type: string + example: businessowner@abc.com + TechnicalOwner: + type: string + example: Technical Owner + TechnicalOwnerEmail: + type: string + example: technicalowner@abc.com APIMetadata: title: API Info object with basic minimal API details. type: object @@ -8631,7 +8944,6 @@ components: readOnly: true example: 01234567-0123-0123-0123-012345678901 name: - maxLength: 60 minLength: 1 pattern: '(^[^~!@#;:%^*()+={}|\\<>"'',&$\[\]\/]*$)' type: string @@ -8652,7 +8964,7 @@ components: pattern: '^[^~!@#;:%^*()+={}|\\<>"'',&/$\[\]\s+\/]+$' example: 1.0.0 provider: - maxLength: 50 + maxLength: 200 type: string description: | If the provider value is not given user invoking the api will be used as the provider. @@ -8765,6 +9077,12 @@ components: Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used. example: Authorization + apiKeyHeader: + type: string + pattern: '(^[^~!@#;:%^*()+={}|\\<>"'',&$\s+]*$)' + description: | + Name of the API key header used for invoking the API. If it is not set, default value `apiKey` will be used. + example: apiKey securityScheme: type: array description: | @@ -8814,6 +9132,8 @@ components: type: fault items: $ref: '#/components/schemas/MediationPolicy' + apiPolicies: + $ref: '#/components/schemas/APIOperationPolicies' subscriptionAvailability: type: string description: The subscription availability. Accepts one of the following. @@ -8897,6 +9217,8 @@ components: example: APPROVED createdTime: type: string + lastUpdatedTimestamp: + type: string lastUpdatedTime: type: string x-otherScopes: @@ -8913,10 +9235,10 @@ components: { "endpoint_type": "http", "sandbox_endpoints": { - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/" }, "production_endpoints": { - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/" } } @@ -8928,22 +9250,22 @@ components: "sessionManagement": "", "sandbox_endpoints": [ { - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/1" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/1" }, { "endpoint_type": "http", "template_not_supported": false, - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/2" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/2" } ], "production_endpoints": [ { - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/3" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/3" }, { "endpoint_type": "http", "template_not_supported": false, - "url": "https://localhost:9443/am/sample/pizzashack/v4/api/4" + "url": "https://localhost:9443/am/sample/pizzashack/v3/api/4" } ], "sessionTimeOut": "", @@ -8957,21 +9279,21 @@ components: { "endpoint_type":"http", "template_not_supported":false, - "url":"https://localhost:9443/am/sample/pizzashack/v4/api/1" + "url":"https://localhost:9443/am/sample/pizzashack/v3/api/1" } ], "endpoint_type":"failover", "sandbox_endpoints":{ - "url":"https://localhost:9443/am/sample/pizzashack/v4/api/2" + "url":"https://localhost:9443/am/sample/pizzashack/v3/api/2" }, "production_endpoints":{ - "url":"https://localhost:9443/am/sample/pizzashack/v4/api/3" + "url":"https://localhost:9443/am/sample/pizzashack/v3/api/3" }, "sandbox_failovers":[ { "endpoint_type":"http", "template_not_supported":false, - "url":"https://localhost:9443/am/sample/pizzashack/v4/api/4" + "url":"https://localhost:9443/am/sample/pizzashack/v3/api/4" } ] } @@ -9011,9 +9333,9 @@ components: example: endpoint_type: http sandbox_endpoints: - url: https://localhost:9443/am/sample/pizzashack/v4/api/ + url: https://localhost:9443/am/sample/pizzashack/v3/api/ production_endpoints: - url: https://localhost:9443/am/sample/pizzashack/v4/api/ + url: https://localhost:9443/am/sample/pizzashack/v3/api/ endpointImplementationType: type: string example: INLINE @@ -9191,6 +9513,14 @@ components: minLength: 1 type: string example: Default + status: + type: string + example: CREATED + default: CREATED + enum: + - CREATED + - APPROVED + - REJECTED vhost: maxLength: 255 minLength: 1 @@ -9295,6 +9625,21 @@ components: gatewayVendor: type: string example: wso2 + monetizedInfo: + type: boolean + example: true + businessOwner: + type: string + example: Business Owner + businessOwnerEmail: + type: string + example: businessowner@abc.com + TechnicalOwner: + type: string + example: Technical Owner + TechnicalOwnerEmail: + type: string + example: technicalowner@abc.com APIProduct: title: API Product object required: @@ -9446,6 +9791,11 @@ components: Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used. example: Authorization + apiKeyHeader: + type: string + description: | + Name of the API key header used for invoking the API. If it is not set, default value `apiKey` will be used. + example: ApiKey securityScheme: type: array description: | @@ -9507,6 +9857,8 @@ components: type: string lastUpdatedTime: type: string + lastUpdatedTimestamp: + type: string gatewayVendor: title: field to identify gateway vendor type: string @@ -10435,9 +10787,15 @@ components: wsPort: type: integer example: 9099 + wsHost: + type: string + example: mg.wso2.com wssPort: type: integer example: 8099 + wssHost: + type: string + example: mg.wso2.com websubHttpPort: type: integer example: 9021 @@ -10772,6 +11130,8 @@ components: example: "" amznResourceTimeout: type: integer + amznResourceContentEncode: + type: boolean payloadSchema: type: string example: "" @@ -10895,7 +11255,7 @@ components: $ref: '#/components/schemas/CertificateValidity' version: type: string - example: v4 + example: V3 subject: type: string example: CN=wso2.com, OU=wso2, O=wso2, L=Colombo, ST=Western, C=LK @@ -11062,7 +11422,7 @@ components: contains host/servers specified in the OpenAPI file/URL items: type: string - example: https://localhost:9443/am/sample/pizzashack/v4/api/ + example: https://localhost:9443/am/sample/pizzashack/v3/api/ description: | API definition information errors: @@ -11265,6 +11625,24 @@ components: advertiseOnly: type: boolean example: true + hasThumbnail: + type: boolean + example: true + monetizedInfo: + type: boolean + example: true + businessOwner: + type: string + example: Business Owner + businessOwnerEmail: + type: string + example: businessowner@abc.com + TechnicalOwner: + type: string + example: Technical Owner + TechnicalOwnerEmail: + type: string + example: technicalowner@abc.com APIProductSearchResult: title: API Result allOf: @@ -11296,6 +11674,24 @@ components: thumbnailUri: type: string example: /apis/01234567-0123-0123-0123-012345678901/thumbnail + hasThumbnail: + type: boolean + example: true + monetizedInfo: + type: boolean + example: true + businessOwner: + type: string + example: Business Owner + businessOwnerEmail: + type: string + example: businessowner@abc.com + TechnicalOwner: + type: string + example: Technical Owner + TechnicalOwnerEmail: + type: string + example: technicalowner@abc.com APIMonetizationInfo: title: API monetization object required: @@ -11507,6 +11903,23 @@ components: type: string description: Authorization Header example: authorization + customProperties: + type: array + items: + type: object + properties: + name: + type: string + description: | + Custom property name + example: Department + description: + type: string + description: Description of custom property + example: Relevant Department + required: + type: boolean + example: false SecurityAuditAttribute: title: SecurityAuditAttributeDTO type: object @@ -11746,8 +12159,8 @@ components: additionalProperties: type: string example: - productionEndpoint: https://localhost:9443/pizzashack/v4/api/ - sandboxEndpoint: https://localhost:9443/pizzashack/v4/api/ + productionEndpoint: https://localhost:9443/pizzashack/v3/api/ + sandboxEndpoint: https://localhost:9443/pizzashack/v3/api/ AsyncAPISpecificationValidationResponse: title: AsyncAPI Specification Validation Response required: @@ -11790,7 +12203,7 @@ components: contains host/servers specified in the AsyncAPI file/URL items: type: string - example: "https://localhost:9443/am/sample/pizzashack/v4/api/" + example: "https://localhost:9443/am/sample/pizzashack/v3/api/" gatewayVendor: type: string example: wso2 @@ -11841,6 +12254,97 @@ components: type: array items: $ref: '#/components/schemas/OperationPolicy' + GatewayPolicyMappings: + title: Gateway Policy Mappings + type: object + required: + - policyMapping + - displayName + properties: + id: + type: string + example: 121223q41-24141-124124124-12414 + policyMapping: + $ref: '#/components/schemas/APIOperationPolicies' + description: + type: string + description: A brief description about the policy mapping + example: Set header value to the request with item type and response header set with served server name + displayName: + type: string + description: Meaningful name to identify the policy mapping + example: item_type_setter + appliedGatewayLabels: + type: array + items: + type: string + example: gatewayLabel_1 + GatewayPolicyMappingDeploymentInfo: + title: Gateway Policy Mapping and Deployment Information + type: object + properties: + id: + type: string + example: 121223q41-24141-124124124-12414 + description: + type: string + description: A brief description about the policy mapping + example: Set header value to the request with item type and response header set with served server name + displayName: + type: string + description: Meaningful name to identify the policy mapping + example: item_type_setter + appliedGatewayLabels: + type: array + items: + type: string + example: gatewayLabel_1 + GatewayPolicyMappingInfo: + title: Gateway Policy Mapping Information + type: object + properties: + id: + type: string + example: 121223q41-24141-124124124-12414 + description: + type: string + description: A brief description about the policy mapping + example: Set header value to the request with item type and response header set with served server name + displayName: + type: string + description: Meaningful name to identify the policy mapping + example: item_type_setter + GatewayPolicyDeployment: + title: Details to map, deploy, undeploy policy mappings to gateways + required: + - gatewayLabel + - gatewayDeployment + type: object + properties: + gatewayLabel: + type: string + example: gatewayLabel_1 + gatewayDeployment: + type: boolean + example: true + mappingUUID: + type: string + example: 01234567-0123-0123-0123-012345678901 + GatewayPolicyMappingDataList: + title: Gateway Policy Mapping List + type: object + properties: + count: + type: integer + description: | + Number of gateway policy mappings returned. + example: 1 + list: + type: array + items: + $ref: '#/components/schemas/GatewayPolicyMappingDeploymentInfo' + pagination: + $ref: '#/components/schemas/Pagination' GatewayEnvironmentProtocolURI: title: Gateway Environment protocols and URIs required: @@ -12239,6 +12743,14 @@ components: required: true schema: type: string + gatewayPolicyMappingId: + name: gatewayPolicyMappingId + in: path + description: | + Gateway policy mapping Id + required: true + schema: + type: string # API Revision Identifier # Specified as part of the path expression @@ -12251,6 +12763,17 @@ components: schema: type: string + # API Revision Environment + # Specified as part of the path expression + envName: + name: envName + in: path + description: | + Environment name of an Revision + required: true + schema: + type: string + # API Revision Identifier # Specified as part of the query string revisionId-Q: @@ -12517,6 +13040,8 @@ components: apim:mediation_policy_manage: Update and delete mediation policies apim:common_operation_policy_view: View common operation policies apim:common_operation_policy_manage: Add, Update and Delete common operation policies + apim:gateway_policy_view: View gateway policies + apim:gateway_policy_manage: Add, Update and Delete gateway policies apim:client_certificates_view: View client certificates apim:client_certificates_add: Add client certificates apim:client_certificates_update: Update and delete client certificates @@ -12539,4 +13064,4 @@ components: apim:tier_view: View throttling policies apim:tier_manage: View, update and delete throttling policies apim:api_list_view: View, Retrieve API list - apim:api_definition_view: View, Retrieve API definition \ No newline at end of file + apim:api_definition_view: View, Retrieve API definition diff --git a/en/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yaml b/en/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yaml index 6a15c6d606..a6dfcd1e45 100644 --- a/en/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yaml +++ b/en/docs/reference/product-apis/service-catalog-apis/service-catalog-v1/service-catalog-v1.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2023, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +# Copyright (c) 2024, WSO2 Inc. (http://www.wso2.org) All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -90,7 +90,7 @@ info: Navigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header. If you use a different authentication mechanism, this process may change. - version: '1.1' + version: '1.2' servers: - url: 'https://apis.wso2.com/api/service-catalog/v1' - url: 'http://apis.wso2.com/api/service-catalog/v1' diff --git a/en/mkdocs.yml b/en/mkdocs.yml index cde9240b17..34cddf9eb1 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -890,11 +890,11 @@ nav: - Product REST APIs: - Overview: reference/product-apis/overview.md - Publisher APIs: - - Publisher API v4: reference/product-apis/publisher-apis/publisher-v4/publisher-v4.md + - Publisher API v5: reference/product-apis/publisher-apis/publisher-v5/publisher-v5.md - Developer Portal APIs: - - Developer Portal API v3: reference/product-apis/devportal-apis/devportal-v3/devportal-v3.md + - Developer Portal API v4: reference/product-apis/devportal-apis/devportal-v4/devportal-v4.md - Admin APIs: - - Admin API v4: reference/product-apis/admin-apis/admin-v4/admin-v4.md + - Admin API v5: reference/product-apis/admin-apis/admin-v5/admin-v5.md - Gateway APIs: - Gateway API v2: reference/product-apis/gateway-apis/gateway-v2/gateway-v2.md - Service Catalog APIs:
WSO2 Publisher API v4WSO2 Publisher API v5 WSO2 recommends that you use the latest REST APIs as it is up to date and has support for the latest WSO2 API Manager 4.2.0 features.
WSO2 Developer Portal API v3WSO2 Developer Portal API v4
WSO2 Admin Portal API v4WSO2 Admin Portal API v5
WSO2 Gateway API v2