if a path's summary contains a period, it's used for the link and title

[ghost]

spectacle version 0.9.13, swagger spec version 2.0 (generated by goswagger 0.13.0)

I noticed something strange when I ran spectacle against my swagger json. In the left sidebar some of my endpoints were listed by their method and endpoint, and some were listed by their summary. I did an audit and realized the pattern: those with a period "." in their summary were the ones listed by their summary.

Further, the main content would display the summary as the title, and have a "Path" block under it.

The behavior I expect is for the title to be the method and path, and there to be a Description block under it.

[yyamano]

@spencer-rig I can't reproduce it. Could you upload the swagger file?

[ghost]

Maybe it's more complex than just the period at the end of the summary. Here's a swagger json that shows the behavior for me (spectacle v 0.9.13)
swagger.txt

[ghost]

Scrubbing out the parameters and responses also ends with the same behavior:
swagger2.txt

[yyamano]

@spencer-rig Thank you, I got it.

The difference comes from "summary" field. Could you try to change "summary" to "description"?

  "paths": {
    "/admin/demodata": {
      "get": {
        "summary": "Sets up demo data and responds 200 OK.",

    "/admin/organizations": {
      "get": {
        "description": "Returns a list of Organizations",

[auscaster]

Sorry to chime in here late, if the path contains a summary it's used as the title and on the nav bar. This is so users have a choice having of textual titles which work with the standard swagger format, but it does mean that swagger files need to be consistent.

…

On 6 April 2018 at 07:39, Yuji Yamano ***@***.***> wrote: @spencer-rig <https://github.com/spencer-rig> Thank you, I got it. The difference comes from "summary" field. Could you try to change "summary" to "description"? "paths": { "/admin/demodata": { "get": { "summary": "Sets up demo data and responds 200 OK.", "/admin/organizations": { "get": { "description": "Returns a list of Organizations", — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#124 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGKDNnJ83qRTYUxUl31lIAuFFm9rSMYks5tlv9-gaJpZM4SpUYD> .

[ghost]

Gotcha, ok. I think my issue stems from using a different tool: that if my code comment includes a period it'll be parsed by goswagger as a summary instead of a description. Thanks for the clues and insight!