wso2 / wso2/docs-apim

[Docs] Improve the add-env details for the client-registration endpoint when WSO2 IS-as-KM used as the KM

Open
#3,061 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-3.1.0 API-M-3.2.0 API-M-4.0.0 Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
In the doc [1], we haven't mention how to set the client-registration endpoint when the IS-as-KM is used as the KM node. When the KM host and port is used as the registration endpoint for an environment, it gives a 401 error.

Need to check this behaviour and update the docs mentioning the details as required what to use as the registration endpoint (when to use Publisher node and when to use IDP node etc).

Note: As a workaround, it is advised to use the Publisher node's host and the port as the registration endpoint.

[1] https://apim.docs.wso2.com/en/3.1.0/learn/api-controller/getting-started-with-wso2-api-controller/#add-an-environment

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 “Add an Environment” section at the linked API Controller documentation page and review how the client-registration endpoint is described. Verify the 401 behavior when WSO2 IS-as-KM is used as the KM, then document when to use the Publisher or IDP node, including the stated Publisher-node workaround.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.