PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

[Bug] Circular label not being applied in all cases

Open
#157 0 comments 0 reactions 1 assignee View on GitHub

@sserrata is already working on this.

Since Mar 27, 2024.

bug roadmap
Dominant language
TypeScript
Stars
1.1k
Forks
315
Avg merge
7d 5h
Merged PRs (30d)
7

Description

Describe the bug

With the new resolver/serializer, circular schema references should be replaced with a "circular" label. There are cases where this label is not properly applied (see below):

Screen Shot 2022-07-12 at 3 54 56 PM

Expected behavior

Circular label should appear next to the property with the circular reference:

Screen Shot 2022-07-12 at 3 56 14 PM

Possible solution

  • Debug createSchemaDetails to determine if and where the label may be getting dropped/lost.
  • Debug the serializer function to determine if label is left out in some cases

Steps to reproduce

See #154 deploy preview

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.