redoc icon indicating copy to clipboard operation
redoc copied to clipboard

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

Open flaksp opened this issue 6 years ago • 1 comments

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).

flaksp avatar Dec 06 '18 18:12 flaksp

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?

lornajane avatar Nov 23 '23 16:11 lornajane