Extensible Security Scheme Object
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
There are a number of issues regarding support for security controls which do not fall neatly under the "apiKey", "http", "oauth2", "openIdConnect" taxonomy. This suggests that we need a more extensible form of the Security Scheme Object. One that makes it easy to add security schemes to OpenAPI. I propose that we create a new branch to work this issue. Guiding principles are:
- Do no harm. The extensible security schemes should be backwards compatible with the current version.
- Use a registry approach. This allows new schemes to be added without requiring a change to OpenAPI.
More to come.
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 files, tests, or entry points are named. Start by reviewing the current OpenAPI Security Scheme Object taxonomy and the six comments, then investigate how a backwards-compatible registry could extend it. Done means a concrete, agreed design for extensible schemes rather than only the two guiding principles.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100