Redocly / Redocly/redocly-cli

no-unresolved-refs should be case-sensitive

Open
#1,326 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue p3 Type: Bug
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

$ref values are URI and URI are case-sensitive, therefore, no-unresolved-refs should be case-sensitive.

It seems to vary with the OS at the moment (case-insensitive on Windows).

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 locating the no-unresolved-refs rule and its tests, then reproduce the behavior on Windows and a case-sensitive OS. Done means URI $ref values are resolved with case-sensitive matching consistently across operating systems.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.