Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Update description on using groupId #12710

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update description on using groupId #12710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...nents/apimgt/org.wso2.carbon.apimgt.rest.api.common/src/main/resources/devportal-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion ....api.store.v1/src/gen/java/org/wso2/carbon/apimgt/rest/api/store/v1/SubscriptionsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
3 changes: 3 additions & 0 deletions ...nts/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/resources/devportal-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion components/apimgt/org.wso2.carbon.apimgt.rest.api.util/src/main/resources/devportal-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down
Loading