wso2 / wso2/docs-apim

Admin REST API v4 - Incorrect Request Paths in Global Key Manager API Request Samples

Open
#10,874 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

AI-Agent/Fixed Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Current Limitation

The request paths listed under “Request Samples” in the Global Key Manager API Collection [1] are incorrect.

Example:

In [2], the existing request sample is:
curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v2/global-key-managers"

In [3], the existing request sample is:
curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v3/key-managers/8d263942-a6df-4cc2-a804-7a2525501450"

[1] https://apim.docs.wso2.com/en/4.3.0/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Global-Key-Manager-(Collection)
[2] https://apim.docs.wso2.com/en/4.3.0/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Global-Key-Manager-(Collection)/paths/~1global-key-managers/get
[3] https://apim.docs.wso2.com/en/4.3.0/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Global-Key-Manager-(Individual)/paths/~1global-key-managers~1%7BkeyManagerId%7D/put

Suggested Improvement

The Global Key Manager API endpoints under “Request Samples” should be updated to reflect the correct request paths.

Example:

In [1], the request sample should be updated to:
curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v4/global-key-managers"

In [2], the request sample should be updated to:
curl -k -X PUT -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" -H "Content-Type: application/json" -d @data.json "https://127.0.0.1:9443/api/am/admin/v4/global-key-managers/8d263942-a6df-4cc2-a804-7a2525501450"

Similarly, the request samples for all Global Key Manager REST API endpoints in the documentation should be reviewed and updated accordingly.

[1] https://apim.docs.wso2.com/en/4.3.0/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Global-Key-Manager-(Collection)/paths/~1global-key-managers/get
[2] https://apim.docs.wso2.com/en/4.3.0/reference/product-apis/admin-apis/admin-v4/admin-v4/#tag/Global-Key-Manager-(Individual)/paths/~1global-key-managers~1%7BkeyManagerId%7D/put

Version

4.3.0, 4.4.0, 4.5.0, 4.6.0

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 with the Global Key Manager API Collection and Individual request samples linked in the issue, comparing each documented path with the v4 endpoint examples provided. Review all Global Key Manager REST API samples for the listed product versions; done means the samples consistently use the correct /api/am/admin/v4 paths.

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
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.