swagger-api / swagger-api/swagger-ui
OpenAPI 3.1.0 support: implement JSON Schema 2020-12 keywords into `sample` plugin
Open
Nobody has claimed this yet.
type: feature
version: 5.x
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
We're missing support for following JSON Schema 2020-12 keywords in SwaggerUI:
- dependentRequired keyword
- not keyword
- if keyword
- then keyword
- else keyword
- dependentSchemas
- prefixItems
- patternProperties
- propertyNames
- unevaluatedItems
- unevaluatedProperties
The goal of this issue is to analyze the missing keywords and implement them to samples plugin if it make sense to include the keywords into example generation.
Refs #8577
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 locating the samples plugin and reviewing how it currently handles JSON Schema keywords. Analyze each listed OpenAPI 3.1.0 keyword to determine whether it can contribute to example generation; done means the sensible keywords are implemented and the plugin's behavior is covered by the project's relevant checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100