PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs

Unable to render example from schema when using anyOf or other multiple responses

Open
#946 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug

I noticed that it can't render the example from the schema when using anyof. It does know that there are two possible responses, but not what the schema is. I do know each one is correct because they are being used elsewhere and that renders.

      "EnvironmentsResponse": {
        "type": "object",
        "required": [
          "data"
        ],
        "properties": {
          "data": {
            "description": "A collection of environment information.",
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Environment"
                }
              },
              {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EnvironmentSummary"
                }
              }
            ]
          }
        }
      },

Expected behavior

It should render each response.

Current behavior

Doesn't render each response. Instead returns

{
  "data": [
    null
  ]
}

Possible solution

Steps to reproduce

https://preview-docs.coalesce.io/docs/api/coalesce/get-environments (no schema example)
https://preview-docs.coalesce.io/docs/api/coalesce/get-environment (Schema example working)

They both share the Environment Component.

Every endpoint that has multiple responses doesn't render an example.
List Nodes
Get Node
List Workspace Nodes

It does work in Swagger Editor.

Screenshot 2024-09-05 at 3 54 06 PM

Context

Not able to provide response examples when there are multiple options.

Your Environment

    "@docusaurus/core": "^3.5.2",
    "@docusaurus/preset-classic": "^3.5.2",
    "docusaurus-plugin-openapi-docs": "^4.0.1",
    "docusaurus-theme-openapi-docs": "^4.0.1",

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 reproducing the schema examples at the linked get-environments and get-environment pages, then compare how responses using anyOf or multiple response options are rendered. Done means each valid response produces a populated example instead of a null item, with coverage for the listed endpoints if tests are available.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.