wso2 / wso2/docs-apim

[DOC] [APIM] [3.2.0] Update the Response details of developer portal rest API list application details

Open
#4,449 0 comments 0 reactions 1 assignee View on GitHub

@ruthryi is already working on this.

Since Aug 5, 2021.

API-M-3.2.0 CEXP Component/ProductAPIs Severity/Minor Type/Bug Type/U2
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
In APIM 3.2.0 (latest WUM update), when we use the developer rest API method [1] to list application details for a given application, we could observe that the response does not include the application key details.

Sample request

curl -k -H "Authorization: Bearer <Access_TOKEN>" "https://localhost:9443/api/am/store/v1/applications/054031a7-032a-4d7b-9998-0d0f6f67c72d/oauth-keys" -v

Sample Response

{"applicationId":"054031a7-032a-4d7b-9998-0d0f6f67c72d","name":"sample","throttlingPolicy":"10PerMin","description":"","tokenType":"JWT","status":"APPROVED","groups":[],"subscriptionCount":0,"keys":[],"attributes":{},"subscriptionScopes":[],"owner":"admin","hashEnabled":false}

As per the documentation [1], It mentioned that the response of the request should include an array of objects (Application key details).

image

Further, when analyzing the implementation [2] we could observe that we have not implemented to set keys for the applicationKeyDTOs object. And further, as per comment [3], we could observe that it is in the Todo list.

Since we cannot cater to the above requirement via WUM update as it might break clients when parsing responses. We can fix the OAS used in the documentation and remove the empty field and update the documentation [1] properly with the correct list of fields which should be available in the API response.

Suggested Labels:
APIM , 3.2.0

Suggested Assignees:
@Mariangela

Affected Product Version:
3.2.0

[1] [1] https://apim.docs.wso2.com/en/3.2.0/develop/product-apis/devportal-apis/devportal-v1/devportal-v1/#tag/Applications/paths/~1applications~1{applicationId}/get
[2] https://github.com/wso2/carbon-apimgt/blob/master/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/ApplicationMappingUtil.java#L66
[3] https://github.com/wso2/carbon-apimgt/blob/master/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/mappings/ApplicationMappingUtil.java#L66

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.