Redocly / Redocly/redocly-cli

Bundling is not importing tags data used in referenced schema

Open
#1,307 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When bundling spec file and there are paths imported

paths:
  /entities:
    $ref: 'entities.yaml#/paths/~1entities'

Then tags section is not updated with tags data used in imported path scheme, but used Schemas are imported.

So tags section should also be imported from source file. Tag naming conflict should be solved same way as schema objects.

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 bundling path handling for imported paths and compare how referenced schema objects are merged. Verify the behavior with a spec containing an imported path and tags, including a tag-name conflict; done means the resulting bundled spec includes the imported tags without conflicting names.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.