redhat-developer / redhat-developer/yaml-language-server
RFC: Support schema from a child definition
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 352
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 11
Description
Is your enhancement related to a problem? Please describe.
My schema is defined in https://foo.net/openapi, which returns a swagger/openapi document, but my schema needs to be a specific model in the JSON response.
That is,foo.yaml's schema is actually defined by https://foo.net.net/openapi#components.schemas.MyJsonSchemaThing
Describe the solution you would like
Support specifying a lookup path from the JSON response.
Describe alternatives you have considered
Writing a proxy server to do this path traversal for me
Additional context
OpenAPI/Swagger is a pretty common provider of JSONSchema models. Would be great to support this common use case.
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 tracing how the language server resolves the remote schema at https://foo.net/openapi and compare it with the requested fragment ending in #components.schemas.MyJsonSchemaThing. Define the supported lookup-path behavior for foo.yaml and verify that a schema nested in an OpenAPI response resolves without a proxy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- devtools, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100