Update Publisher REST API Docs Mentioning the Possibility of Using API/API-Product ID and Revision UUID to Retrieve API/Product Information
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Current Limitation
It does not mention that either the API/API Product ID or the API/API Product Revision UUID can be used to retrieve API or API Product information in the document [1].
Suggested Improvement
As part of addressing the concern we talked about internally, we need to update the Publisher specification YAML file to allow the retrieval of API or API Product information using either the API/API Product ID or the API/API Product Revision UUID. A sample PR has been added in [2].
[1] https://apim.docs.wso2.com/en/latest/reference/product-apis/publisher-apis/publisher-v4/publisher-v4/#tag/APIs/operation/getAPI
[2] https://github.com/wso2/docs-apim/pull/9170
Version
No response
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
Start by reviewing the Publisher specification YAML file and the sample PR at docs-apim#9170. Confirm how the getAPI operation currently identifies APIs and API Products, then update the specification so both the resource ID and revision UUID are supported for retrieval.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100