Swagger-ui: Render externalDocs in all applicable locations

[lmprice]

I'm currently using Swagger-Core 1.5.3 with Swagger-UI @ 59c1003 , and I'm not seeing the results of any externalDoc additions to in the swagger-ui. I can add an externalDoc at the top level, but it currently isn't working for Operations, Tags, or Models, which are things I think many users would want.

[nrekretep]

+1
Am 18.08.2015 21:10 schrieb "lmprice" [email protected]:

I'm currently using Swagger-Core 1.5.3, and I'm not seeing the results of
any externalDoc additions to in the swagger-ui. I can add an externalDoc at
the top level, but it currently isn't working for Operations or Tags, which
are both things I think many users would want.

—
Reply to this email directly or view it on GitHub
https://github.com/swagger-api/swagger-ui/issues/1545.

[obfischer]

I need this feature too for our documentation.

[webron]

We'll use this ticket to collectively add support for all externalDocs location in all support spec versions. Modifying the topic to reflect that.

[chameleon82]

Need to explain Model properties with external doc
For example:

class Scheduler(
     @Schema(
        title = "Cron formatted invoice schedule",
        example = "0 0 8 5 * *"
        externalDocs = new ExternalDocumentation(
          description = "Here is how to define it properly",
          url = "http://myconfluence.org"
        )
    )
    cron: String   
)

I can see it in UI, but it is in wrong format:

example = "0 0 8 5 * *"
externalDocs: OrderedMap { "description" : "Here is how to define it properly", "url" :  "http://myconfluence.org" }

instead of actual link. Should i open bug for this issue?

[wapmorgan]

Faced the same problem, with externalDocs in a tag - it does not rendered.

[terrencewei]

We need this features to display the externalDocs in tag too, is anyone know when this will be implemented?