From 54602fc1bb295c96ab7536ff73d0e335fa987871 Mon Sep 17 00:00:00 2001 From: pasant9 Date: Mon, 25 Nov 2024 11:15:27 +0530 Subject: [PATCH] Update description on using groupId --- .../src/main/resources/devportal-api.yaml | 3 +++ .../carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java | 2 +- .../src/main/resources/devportal-api.yaml | 3 +++ .../src/main/resources/devportal-api.yaml | 5 ++++- 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml b/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml index 4a041b7af23f..993819c1a019 100644 --- a/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml +++ b/components/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml @@ -2614,6 +2614,9 @@ paths: 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` + If application sharing is enabled, the **groupId** can be used to include subscriptions associated with the + specified **groupId** in the results, provided the application is shared within the group. + **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**. parameters: diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java b/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java index cc4fe540ef12..0dd16ffc57e0 100644 --- a/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java +++ b/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java @@ -61,7 +61,7 @@ public class SubscriptionsApi { @Produces({ "application/json" }) - @ApiOperation(value = "Get All Subscriptions ", notes = "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` 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` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**. ", response = SubscriptionListDTO.class, authorizations = { + @ApiOperation(value = "Get All Subscriptions ", notes = "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` 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` If application sharing is enabled, the **groupId** can be used to include subscriptions associated with the specified **groupId** in the results, provided the application is shared within the group. **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**. ", response = SubscriptionListDTO.class, authorizations = { @Authorization(value = "OAuth2Security", scopes = { @AuthorizationScope(scope = "apim:subscribe", description = "Subscribe API"), @AuthorizationScope(scope = "apim:sub_manage", description = "Retrieve, Manage subscriptions") diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml b/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml index 4a041b7af23f..993819c1a019 100644 --- a/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml +++ b/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml @@ -2614,6 +2614,9 @@ paths: 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` + If application sharing is enabled, the **groupId** can be used to include subscriptions associated with the + specified **groupId** in the results, provided the application is shared within the group. + **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**. parameters: diff --git a/components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/resources/devportal-api.yaml b/components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/resources/devportal-api.yaml index 321b62fff472..754f3c25a1b4 100644 --- a/components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/resources/devportal-api.yaml +++ b/components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/resources/devportal-api.yaml @@ -2371,11 +2371,14 @@ paths: description: | 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 subscibed to a specific API. + 1. Retrieving applications which are subscribed to a specific API. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` + + If application sharing is enabled, the **groupId** can be used to include subscriptions associated with the + specified **groupId** in the results, provided the application is shared within the group. **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**.