Mention the reason to always have an empty list for "attributes" field in the devportal GET /applications response
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description:
In [1], if you check the response, it will contain a field named "attributes".
Usually, this "attributes" field should contain the custom attributes which we configure for applications as mentioned in [2].
But actually, this "attributes" field will be empty all the time as shown below.
The reason for this is, it is costly to populate the attribute values per application when retrieving the applications as a list. We need to mention this somewhere in the docs.
Affected Product Version:
APIM 4.0.0
APIM 3.2.0
APIM 3.1.0
APIM 3.0.0
[1] https://apim.docs.wso2.com/en/3.2.0/develop/product-apis/devportal-apis/devportal-v1/devportal-v1/#tag/Applications/paths/~1applications/get
[2] https://apim.docs.wso2.com/en/3.2.0/learn/consume-api/manage-application/advanced-topics/add-custom-attributes-to-applications/#server-specific-configuration
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the linked Devportal v1 Applications GET documentation and the custom-attributes guidance first. Document that the GET applications list response keeps the attributes field empty because populating attribute values per application is costly, and verify the explanation is visible in the relevant documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100