Skip to content

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

Closed
chrisdudley opened this issue Jun 4, 2015 · 6 comments
Closed

Add support for externalDocs attributes #480

chrisdudley opened this issue Jun 4, 2015 · 6 comments

Comments

@chrisdudley
Copy link
Contributor

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?

@mohsen1 mohsen1 added this to the 2.9.7 milestone Jun 4, 2015
@mohsen1
Copy link
Contributor

mohsen1 commented Jun 11, 2015

@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?

@mohsen1
Copy link
Contributor

mohsen1 commented Jun 11, 2015

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

@chrisdudley
Copy link
Contributor Author

For what it's worth plaintext would be good enough for my needs.
Thanks!

@webron
Copy link
Contributor

webron commented Jun 11, 2015

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.

@mohsen1
Copy link
Contributor

mohsen1 commented Jun 11, 2015

What is the necessity of having markdown here?

@webron
Copy link
Contributor

webron commented Jun 11, 2015

It's part of the spec. Can't be changed now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants