Missing information on info.version and info.title when modifying or creating an API via OpenAPI Definition
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description
Hi Team,
Following section is missing in 4.3.0 [1], 4.1.0 [2] and 4.0.0 [3] documentation of 'Edit an API by modifying the API Definition'.
!!! important Starting from WSO2 API Manager 4.x, the platform ensures that the info.version and info.title fields in the OpenAPI (Swagger) specification are automatically aligned with the version and title of the API that is published on the API Manager. This approach ensures that the version and title in the Swagger definition accurately correspond to the actual API deployed in the API Gateway.
[1] https://apim.docs.wso2.com/en/4.3.0/tutorials/edit-an-api-by-modifyng-the-api-definition
[2] https://apim.docs.wso2.com/en/4.1.0/tutorials/edit-an-api-by-modifyng-the-api-definition
[3] https://apim.docs.wso2.com/en/4.0.0/tutorials/edit-an-api-by-modifyng-the-api-definition
Suggested Fix
Adding the above section as similar to APIM 4.4.0 [1]
Version(s)
4.3.0, 4.1.0, 4.0.0
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
Compare the 4.4.0 reference section with the linked 4.3.0, 4.1.0, and 4.0.0 “Edit an API by modifying the API Definition” pages. Add the same information notice to each older version and verify that the rendered documentation matches the 4.4.0 wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100