-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Add support for externalDocs attributes #480
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
Comments
@webron It doesn't make sense to support markdown in description of an external doc. If description of external docs is markdown then it means it can contain a lot of things like tables, headings and so on. Maybe it should be plain text instead? |
For example this external doc can be rendered in a simple link: description: Find more info here
url: https://swagger.io <a href="https://swagger.io">Find more info here</a> But if description is a complex markdown document it becomes tricky to render and support all cases |
For what it's worth plaintext would be good enough for my needs. |
It's not my place to say whether it makes sense or not. People should use it however they want. If they want to go crazy, let them. |
What is the necessity of having markdown here? |
It's part of the spec. Can't be changed now. |
# [0.3.0](https://github.com/swagger-api/swagger-ide/compare/v0.2.2...v0.3.0) (2022-02-10) ### Bug Fixes * **eslint:** define rule to match airbnb preset format ([#467](https://github.com/swagger-api/swagger-ide/issues/467)) ([bf59735](https://github.com/swagger-api/swagger-ide/commit/bf59735a2815b969fe8a06d8249a6f6b6044c316)) * **lint:** add dist to ignore list ([#477](https://github.com/swagger-api/swagger-ide/issues/477)) ([737a2e8](https://github.com/swagger-api/swagger-ide/commit/737a2e8ee940a9248808d8e1b14de3ccf4c35f7d)) * **lint:** reorder eslintc extends list ([#480](https://github.com/swagger-api/swagger-ide/issues/480)) ([e901ce3](https://github.com/swagger-api/swagger-ide/commit/e901ce36571760670cc3a62a05da56342a6c7712)) * **package:** introduce new exports mappings ([#518](https://github.com/swagger-api/swagger-ide/issues/518)) ([35f59a0](https://github.com/swagger-api/swagger-ide/commit/35f59a05032ff4ffb82678eb43106ba82c42080b)) ### Features * bump apidom-ls to 0.17.0 ([e240b74](https://github.com/swagger-api/swagger-ide/commit/e240b74794a88b8a515e1cc24e9c3be1e21fbb29))
The Swagger 2 spec supports an optional 'externalDocs' on several objects:
Swagger, Operation, Tag and Schema.
The externalDocs attribute is an 'externalDocumentationObject' which has a description and a url.
https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#externalDocumentationObject
Is it possible to add support to swagger editor for those please?
The text was updated successfully, but these errors were encountered: