wso2 / wso2/docs-apim

Wrong sample request in "Get all Deny Policies" REST call

Open Beginner friendly
#5,233 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component/ProductAPIs Docs/TW Severity/Minor Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:

The given sample request in the documentation [1] is as follows.

curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v2/throttling/policies/deny-policies"

This needs to be corrected as below without having the /policies part. This can be verified from the UI REST API call.

curl -k -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" "https://127.0.0.1:9443/api/am/admin/v2/throttling/deny-policies"

[1] https://apim.docs.wso2.com/en/latest/reference/product-apis/admin-apis/admin-v2/admin-v2/#tag/Advanced-Policies/paths/~1throttling~1policies~1advanced~1{policyId}/delete

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

Open the linked Advanced Policies documentation and locate the “Get all Deny Policies” sample request. Compare it with the UI REST API call, update the documented endpoint to omit /policies, and verify the rendered example uses the corrected path.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.