OAI / OAI/OpenAPI-Specification
Consolidated $ref-to-Some Object feature request
Open
Nobody has claimed this yet.
re-use: ref-everywhere
- Dominant language
- Markdown
- Stars
- 31.2k
- Forks
- 9.2k
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 27
Description
This issure consolidates and replaces the numerous "can the OAS allow $ref for..." issues:
- Security Requirement: OAI/OpenAPI-Specification#1850
- Security Scheme: OAI/OpenAPI-Specification#1972 (but see also OAI/OpenAPI-Specification#3776 for an alternative)
- Server: OAI/OpenAPI-Specification#2338
- Tags: OAI/OpenAPI-Specification#2905
- Operation: OAI/OpenAPI-Specification#2922 (but note that there are impacts on finding and resolving
operationId) - Media Type: OAI/OpenAPI-Specification#3056 (closed because the specific use case is handled by overriding
descriptionwith a Reference Object); also OAI/OpenAPI-Specification#2845 although there is more to that one) - Contact: OAI/OpenAPI-Specification#3552
- License: OAI/OpenAPI-Specification#3569
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 by reviewing the linked issues for Security Requirement, Security Scheme, Server, Tags, Operation, Media Type, Contact, and License to understand the separate use cases and alternatives. Define the specification changes needed to support $ref for these objects, including the noted operationId impacts; done means the relevant cases are consistently resolved in the OpenAPI Specification.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100