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

Structural improvements: move root externalDocs to info #685

Closed
arno-di-loreto opened this issue May 8, 2016 · 4 comments
Closed

Structural improvements: move root externalDocs to info #685

arno-di-loreto opened this issue May 8, 2016 · 4 comments
Labels
metadata tags, info, license, contact, markdown usage, etc.

Comments

@arno-di-loreto
Copy link
Contributor

This issue is quite simple it's only about moving the root externalDocs into the info object to simplify root.

before:

info:
  # (existing) info object
externalDocs:
  # link to some external documentation about the API

after:

info:
  # (existing) info object + externalDocs
  (... same properties as existing info object)
  externalDocs:
    # (existing) Moving externalDocs from root to info
@arno-di-loreto arno-di-loreto changed the title Structural improvements to simplify root: move root externalDocs to info Structural improvements: move root externalDocs to info May 8, 2016
@darrelmiller
Copy link
Member

I'm not sure I see the benefits. Yes the root has one less property, but now the info object has one more. What is the benefit of having less properties in the root?

I don't feel strongly one way or the other, but if we are going to make a breaking change then I think we should have a fairly good justification.

@darrelmiller
Copy link
Member

Having now read OAI/sig-moonwalk#115 I see the reason for your proposal.

@arno-di-loreto
Copy link
Contributor Author

parent #560

@handrews handrews added metadata tags, info, license, contact, markdown usage, etc. and removed OpenAPI.Next Proposal labels Feb 8, 2024
@handrews
Copy link
Member

handrews commented May 24, 2024

Closing this as included in

as it would be part of a major version change to remove/move a top-level field.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
metadata tags, info, license, contact, markdown usage, etc.
Projects
None yet
Development

No branches or pull requests

4 participants