Skip to content
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

Swagger 2 - ui ignoring "description" fields? #578

Closed
kasztelan opened this issue Sep 18, 2014 · 8 comments
Closed

Swagger 2 - ui ignoring "description" fields? #578

kasztelan opened this issue Sep 18, 2014 · 8 comments
Milestone

Comments

@kasztelan
Copy link

Just trying to use swagger for the first time and I decided to start with second version. I cloned develop_2.0 branch as suggested here: #568

I commented the line in index.html that load swagger.js and left the swagger-client.js one. It seems to work with 2.0 spec now but it doesn't seem to display description fields neither from Operation Object nor from model's properties. I'm using the example from http://wordnik.github.io/swagger-editor/ and though there are many descriptions there they aren't displayed by the swagger-ui

@fehguy fehguy added this to the v2.1.0 milestone Sep 19, 2014
@fehguy
Copy link
Contributor

fehguy commented Sep 20, 2014

yes, this is a bug and will be addressed.

@sosoxuc
Copy link

sosoxuc commented Oct 19, 2014

Fixed with swagger-api/swagger-js@f2a5ae3 as i observed

@AvihayTsayeg
Copy link

This is happening using online swagger editor and master branch

@webron
Copy link
Contributor

webron commented Feb 8, 2015

@AvihayTsayeg - the swagger-editor is an independent project. If you experience issues with it, please open a ticket on it directly.

@AvihayTsayeg
Copy link

Thx for the answer,
The editor is just fine and it is showing the description,
The description is not displayed using swagger-ui (master build)

tags:
- name: Reports
  description: "Scheduled Reports' API. The API provides methods to gets the reports list, the specific report data, run a report and get the run status and results."
paths: 

in the editor it is showing the description like this...
image

Thx, Avihay

@mohsen1
Copy link
Contributor

mohsen1 commented Feb 8, 2015

The editor shows tag description in title attribute of the tag elements.

@AvihayTsayeg
Copy link

Thx @mohsen1,
Does swaggerUi display this tag description somewhere ?

again thx for your answers !

@mohsen1
Copy link
Contributor

mohsen1 commented Feb 26, 2015

It's not an issue as of 3249125
screen shot 2015-02-25 at 4 27 23 pm

@mohsen1 mohsen1 closed this as completed Feb 26, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants