Embed entire yaml in one block #667
Unanswered
jmbluethner
asked this question in
4. Open API
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
If I understand correctly, it is in fact not possibe to embed all contents of the Swagger yaml in one markdown block, is it?
This means, that every endpoint which is being described in the yaml must be added like
If that's the case, may I ask why?
The OpenAPI, or Swagger, standard already has a super high focus on allowing the frontend implementation to show the entire yaml in a very readeable form. So why would it be required to break that file up into each individual endpoint?
Not only does this cause extra work because the corresponding markdown file has to be adjusted for every new, moved, or removed, endpoint, but it also opens up a risk for deprecated docs if the just described steps are simply being forgotten.
If I didn't read the docs right, and it is in fact possible to embed the entire yaml at once, please feel free to tell my how to do so 🙂
Beta Was this translation helpful? Give feedback.
All reactions