Making Security Scheme Objects Extensible
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 6
- Forks
- 3
- Avg merge
- 1h 54m
- Merged PRs (30d)
- 1
Description
OpenAPI allows you to extend Security Scheme Objects. However, since the values of the Type field are fixed, and the contents of a security scheme are determined by the value of the Type field, then security schemes are not really extensible. We should add "x-custom" as a valid value to the Type field. This indicates that this is an extended (non-standard) Security Scheme Object. Extended Security Schemes should populate the "x-type" field to identify the type of custom scheme being described. x-type is an unrestricted string. It is up to the implementing community to manage its' values. OAI/OpenAPI-Specification#1004
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 or tests are identified in the issue. Start by reviewing the OpenAPI Security Scheme Object definition and the discussion in OAI/OpenAPI-Specification#1004; done means agreeing on the x-custom Type value, the unrestricted x-type field, and the resulting specification changes.
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
- Mostly clear
- Newbie friendliness
- 35/100