Redocly / Redocly/redocly-cli

Respect: improve rules to resolve OpenAPI definition context

Open
#2,123 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

p3 Respect Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.

Improve Respect rules validation by having sourceDescription bundled context.
If all content from description is bundled and resolved there is a way to validate:

  • schemeName in x-security extension
  • used operationId and operationPath
  • other OpenAPI references

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 tracing the Respect rules validation flow and how sourceDescription is handled when OpenAPI content is bundled and resolved. Done means the rules can validate schemeName in x-security extensions, used operationId and operationPath, and other OpenAPI references from that context.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.