Deprecated Tag is not rendered when used in "oneOf"

Open
#1,366 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the provided JSON Schema example and trace how deprecated values are rendered when the schema uses oneOf. Compare this with the existing behavior for deprecated properties outside oneOf, then verify the result using the query-parameter schema and its enum values.

Written by the indexing model from the issue text.

Description

openapi

So I have the following json schema for a query parameter which I want to render:

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "oneOf": [
    {
      "type": "string",
      "example": "include",
      "enum": ["include", "only", "exclude"]
    },
    {
      "type": "string",
      "enum": ["true"],
      "deprecated": true
    }
  ]
}

While the deprecation property works fine if I would use it without the oneOf for this case I do not see it:
image

Is this the correct whey how I mark an value for an enum as deprecated?

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

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.

More from Redocly/redoc

All issues in Redocly/redoc

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.