Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

External Documentation is not rendered if it's inside root of the schema #737

Open
flaksp opened this issue Dec 6, 2018 · 1 comment
Open
Labels

Comments

@flaksp
Copy link
Contributor

flaksp commented Dec 6, 2018

External Documentation is not rendered if it's inside root of the schema. However there are no problems if external docs are located inside any property of an object.

Schema minimal example:

{
  "components": {
    "schemas": {
      "AuthorizationHeaderMissingApiProblem": {
        "externalDocs": {
          "description": "RFC 7807 (Problem Details for HTTP APIs)",
          "url": "https://tools.ietf.org/html/rfc7807"
        },
        "nullable": false,
        "properties": { ... },
        "type": "object",
        "title": "AuthorizationHeaderMissingApiProblem"
      }
    }
  }
}

This schema used in responses and it's missing rendered external docs section (probably it will be missed in requests too).

@lornajane
Copy link
Contributor

I realise this is an old issue, but I don't want to lose a valuable bug report! Could you let us know if this still seems like a problem since the 2.0 release?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants