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

Specification Extensions not supported for externalDocumentationObject #513

Closed
AP-G opened this issue Aug 27, 2020 · 1 comment
Closed
Labels
type:bug A broken experience
Milestone

Comments

@AP-G
Copy link

AP-G commented Aug 27, 2020

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
@darrelmiller darrelmiller added the type:bug A broken experience label Sep 28, 2020
@darrelmiller darrelmiller added this to the 1.2.4 milestone Sep 28, 2020
@darrelmiller
Copy link
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
Labels
type:bug A broken experience
Projects
None yet
Development

No branches or pull requests

2 participants