OAI / OAI/OpenAPI-Specification
Feature request: standard file that describes what openapi features are supported by an implementation
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 31.2k
- Forks
- 9.2k
- Avg merge
- 6h 37m
- Merged PRs (30d)
- 27
Description
Feature request: standard file that describes what openapi features are supported by an implementation
If all implementations provided a yaml or json file of what features were supported it would allow for easier comparison of implementations.
What if we did this with the json schema descriptions of the openapi spec:
https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.0/schema.yaml
And the json path was the feature, like:
#/servers and the value is a boolean or a FeatureSupportInfo object like so:
FeatureSupportInfo:
type: object
properties:
supported:
type: boolean
docUrl:
type: string
verificationTestUrl:
type: string
required:
- supported
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 OpenAPI v3.0 schema.yaml linked in the issue and the proposal for JSON Pointer feature paths. Clarify the scope and format with maintainers before implementation. Done means the repository has an agreed standard for describing supported features, including optional documentation and verification links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, openapi, yaml
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100