Skip to content

Specification Extensions not supported for externalDocumentationObject #513

Closed

Description

@AP-G

Dear all,

it looks like Specification Extensions are not supported for an externalDocumentationObject. If I parse the file I get a

x-ExternalDoc-simple is not a valid property at #/paths/externalDocs

This is strange in two ways, as the externalDocs is part of the OpenAPI Object (root) and not as part of paths.

Here is my example:

...
components:
....
security:
...
tags:
...
externalDocs:
  description: My external API documentation
  url: https://external.server.tld/doc
  # extension
  x-ExternalDoc-simple: MyContent

Activity

  1. added this to the 1.2.4 milestone on Sep 28, 2020
  2. darrelmiller commented on Sep 28, 2020

    @darrelmiller
    Member

    Thank you! I just checked and the code to deserialize extensions in both v2 and v3 is missing. That should be an easy fix to get into a patch release. I am puzzled about that error message though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:bugA broken experience

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions