Skip to content

Commit

Permalink
Update description on using groupId
Browse files Browse the repository at this point in the history
  • Loading branch information
PasanT9 committed Nov 25, 2024
1 parent 0f6c1e9 commit 54602fc
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 2 deletions.
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
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
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
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

0 comments on commit 54602fc

Please sign in to comment.