Redocly / Redocly/redoc

Vendor extensions JsonSchema

Open
#1,728 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the problem to be solved
Some IDEs (Phpstorm et al) are capable of autocompletion based on json schema but redoc vendor extensions are not available as an spec

Describe the solution you'd like
Create a json schema file of Redoc vendor extensions and publish extending oficial openapi schemas

Additional context
No further data is required except the vendor extensions spec, any custom schema can be loaded.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Redoc vendor extensions and the official OpenAPI schemas referenced by the issue. Define the vendor-extension schema and its published extensions to the official schemas; done means IDEs can load the resulting schema and autocomplete Redoc extensions.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.