PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Missing information in the API key value in the Authorization header in all the sample codes
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
Describe the bug
In the code samples, we find Authorizationas <API_KEY_VALUE>.
However, when we use JWT, the <API_KEY_VALUE> requires a prefix (JWT ).
That is not clear in the code sample, and our clients are stumbling on it.
Expected behavior
Show the expected syntax for the Authorization header value.
Current behavior
The current value that is shown <API_KEY_VALUE> is not sufficient.
Possible solution
a) Add a configuration to add a prefix:
- Before the <API_KEY_VALUE>.
- In the JWT Authentication input in the REQUEST.
b) Or, add a configuration to set a text instead of the default <API_KEY_VALUE>.
Screenshots
Context
Our clients have difficulty in understanding the syntax of the authentication header due to the missing JWT .
Your Environment
Version used: Plugin version is 2.1.3
Environment name and version: Chrome 123.0.6312.124, node.js 20.12.2
Operating System and version: Mac
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
No files, tests, or entry points are named in the issue. Start by locating the code that renders Authorization headers in generated API samples and the JWT authentication configuration, then compare the generated examples with the expected header syntax. Done means all relevant samples clearly show the required JWT prefix or a supported configurable equivalent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, authentication, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100