stoplightio
API Overview: External Docs in Additional Information Links
Split out from #687
Add External Docs to the Additional Information Links box.
- For External Docs display "externalDocs.description" if it exists, default to "Find out more" and link to externalDocs.url.
External Docs looks like this in OpenAPI v2 / v3.0, and it is not stored in http-spec yet, which makes this tricky.
openapi: 3.0.0
info:
description: bla bla
externalDocs:
description: Project Wiki
url: 'https://github.com/stoplight/elements/wiki'
If we do not currently store any of this info in the HttpService object of http-spec, it should be added.
We don't, we need to add it to both types and http-spec.
Do we think this would ever be prioritized? I also note that we don't respect the externalDoc value at the tag level (though given how the UI is, it wouldn't make sense to do so) and endpoint level either.
It's one thing I've noticed that this project does not have partity with when compared with swagger-ui. It's somewhat important to me because sometimes, external-documentation is truly necessary :)
