[Feature Request] - Allow payload definition for JWT schema
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
Is your feature request related to a problem?
Yes. The clients will be able to know what they expect within the payload of the JWT. It will save time to parse the payload on the client-side.
Describe the solution you'd like
In the security schemas sections, the developer should be able to provide the JWT payload as another sub-schema.
Something like:
securitySchemes:
AppJwt:
type: http
scheme: bearer
bearerFormat: JWT
payload: '#/components/schemas/AppJwtPayload'
schemas:
AppJwtPayload:
type: object
properties:
userId:
type: string
Thanks.
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
No repository files, tests, or entry points are named in the issue. Start by reviewing the security-schemas specification and the existing JWT bearer schema model, then determine how a payload reference should be represented and validated; done means the syntax is agreed and supported with corresponding coverage.
Written by the indexing model from the issue text.
Assessment
- Domain
- authentication, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100