expand description of swagger /auth/query to add retrieve information
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 92
- Forks
- 81
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 46
Description
Describe the bug
A clear and concise description of what the bug is.
I think I have done a certificate sign-on - but would like to display the userid which was activated. I could not find a REST request for this.
I found /auth/query
Validate the authentication token. - but I did not want to validate - I wanted to display...
After half an hour, and google, I found
which says
Use the /query API to validate the token and retrieve the information associated with the token.
Please can you change the swagger definitions
from
Validate the authentication token.
to
Validate the token and retrieve the information associated with the token
Contributor guide
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 linked Swagger definition and locate the /auth/query endpoint description in the API-layer documentation source. Change the summary so it says the endpoint validates the token and retrieves the information associated with it, then verify the rendered Swagger documentation shows the updated wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100