search

Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
23.59k stars 2.3k forks source link

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

Open flaksp opened 5 years ago

flaksp commented 5 years ago

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 commented 11 months ago

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?