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

[Manasha11]

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

[wso2-engineering-bot]

@wso2-engineering-bot create a PR for this issue following repo conventions

[wso2-engineering-bot]

Automated Fix Completed

I've successfully fixed the incorrect Admin REST API v4 Global Key Manager request paths and created pull requests for all applicable versions.

Pull Requests Created:

• PR #10875 - Version 4.6.0
• PR #10876 - Version 4.5.0
• PR #10877 - Version 4.4.0
• PR #10878 - Version 4.3.0
• PR #10879 - Version 4.7.0
• PR #10880 - Master branch

Changes Made:

All curl request samples in the Global Key Manager API documentation have been updated:

• api/am/admin/v2/global-key-managers → api/am/admin/v4/global-key-managers
• api/am/admin/v3/key-managers → api/am/admin/v4/global-key-managers

Versions Not Applicable:

Versions 4.2.0, 4.1.0, and 4.0.0 do not have the Global Key Manager API section, so no fixes were needed for these versions.

All PRs are ready for review.