OpenAPI-Specification icon indicating copy to clipboard operation
OpenAPI-Specification copied to clipboard

Structural improvements: move root externalDocs to info

Open arno-di-loreto opened this issue 9 years ago • 3 comments

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 avatar May 08 '16 15:05 arno-di-loreto

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 avatar May 09 '16 13:05 darrelmiller

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

darrelmiller avatar May 09 '16 13:05 darrelmiller

parent OAI/OpenAPI-Specification#560

arno-di-loreto avatar May 12 '16 18:05 arno-di-loreto

Closing this as included in

  • OAI/sig-moonwalk#116

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

handrews avatar May 24 '24 18:05 handrews