wso2 / wso2/docs-apim

Update the github tag in swaggers after rest API version upgrade

Open
#6,781 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Priority/Normal Type/Docs Type/Task
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

Need to update the github tag in swaggers.

In some of the rest api yaml files we have the following line which points to the github link of the respective yaml file. After the GA release, this link should be pointed to the relevant carbon-apimgt tag of the released product. This is only a documentation change.

Screen Shot 2023-03-02 at 1 47 24 PM

The github tag in the swagger downloaded from the doc page should be modified. For example [1].

[1] https://apim.docs.wso2.com/en/latest/reference/product-apis/admin-apis/admin-v3/admin-v3/

Affected Component

APIM

Version

4.2.0-SNAPSHOT

Related Issues

No response

Suggested Labels

No response

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.

Research direction

Start by reviewing the REST API YAML files and the admin-v3 documentation page linked in the issue. Update the GitHub reference in the affected Swagger files to the relevant released carbon-apimgt tag, then verify that the Swagger downloaded from the documentation page uses the updated link.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, openapi
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.