swagger-api / swagger-api/swagger-ui
OpenAPI 3.1.0 support: Implement `JumpToPath` in JSON Schema 2020-12 rendering
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
When rendering OpenAPI 3.1.0 with JSON Schema Draft 2020-12 schemas, we need to add support for JumpToPath placeholder. This placeholder is then used in SwaggerEditor usecases.
JumpToPath looks like that in JSON Schema Draft 4/5 renderer. When clicked, it focuses the editor cursor on a position in the definition where the schema is defined.
TODO:
- implement the
JumpInPathin SwaggerUI - create an isssue with SwaggerEditor@5 to override the
JumpToPathcomponent
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
Compare the existing JSON Schema Draft 4/5 renderer's JumpToPath behavior with the JSON Schema 2020-12 rendering path in SwaggerUI. Confirm that clicking the placeholder focuses the editor cursor on the schema definition, then track the separate SwaggerEditor@5 issue needed to override the JumpToPath component.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100