Documentation Improvements – OAuth Token Expiration
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description
Improvements to the OAuth Token Expiration pages
Steps to Reproduce
- Navigate to https://apim.docs.wso2.com/en/4.1.0/design/api-security/oauth2/token-expiration/ and https://apim.docs.wso2.com/en/4.1.0/consume/manage-application/generate-keys/obtain-access-token/changing-the-default-token-expiration-time/
- Notice there are several configurations to change the default expiration times. The expiration time is defined in seconds, but this is not clearly mentioned in the documentation.
- In https://apim.docs.wso2.com/en/4.1.0/design/api-security/oauth2/token-expiration/, there is a link to Changing the Default Token Expiration Time. But it is a broken link. The proper link should be https://apim.docs.wso2.com/en/4.1.0/consume/manage-application/generate-keys/obtain-access-token/changing-the-default-token-expiration-time/
- In https://apim.docs.wso2.com/en/4.1.0/design/api-security/oauth2/token-expiration/, the configuration:
[oauth]
token_validation.app_access_token_validity = 10000
Defines the default global validity duration, which applies only when registering new OAuth applications.
However, this setting does not affect existing OAuth applications. Existing applications retain the validity duration defined at the time of their creation. This behavior is not clearly explained in the documentation. In https://apim.docs.wso2.com/en/4.1.0/consume/manage-application/generate-keys/obtain-access-token/changing-the-default-token-expiration-time/, there is a note mentioning "The changes that you do here will be applied only to the new applications that you create.". It would be better to add this note to https://apim.docs.wso2.com/en/4.1.0/design/api-security/oauth2/token-expiration/ as well.
Version
4.1.0
Environment Details (with versions)
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the OAuth Token Expiration page and the Changing the Default Token Expiration Time page linked in the issue. Verify the configuration units, correct the broken link, and clarify that the global validity setting applies only to new applications. Done means both pages accurately explain these behaviors and the link resolves.
Written by the indexing model from the issue text.
Assessment
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100