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

Show descriptions of the models in the UI #35

Closed
ayush opened this issue Jul 18, 2012 · 15 comments
Closed

Show descriptions of the models in the UI #35

ayush opened this issue Jul 18, 2012 · 15 comments
Milestone

Comments

@ayush
Copy link
Contributor

ayush commented Jul 18, 2012

swagger-ui ignores the model descriptors coming in from the server. Not good. It should show em

@pietervogelaar
Copy link

Any estimate when this will be implemented?

@tot-ra
Copy link
Contributor

tot-ra commented Oct 25, 2012

I've done it locally but as a hack by modifying generated javascript from coffescript and without using templates. It was around 1day work and I might have time to rewrite it properly, but looking at pending pull requests, they are not merged very often.

@pietervogelaar
Copy link

Do you have a link to the code with your modifications?

@tot-ra
Copy link
Contributor

tot-ra commented Oct 25, 2012

@pietervogelaar
Copy link

Thanks... it's a start :) I hope the swagger team will pick it up soon... I think it should have high priority because you have to know what the API expects when using Swagger to test it.

@fehguy
Copy link
Contributor

fehguy commented Oct 31, 2012

@pietervogelaar bumping up the priority on this...

@angelolloqui
Copy link

I would also like to see this one implemented

@ayush
Copy link
Contributor Author

ayush commented Nov 5, 2012

A push on this is coming through real soon.

@ayush ayush closed this as completed in b743c0f Nov 6, 2012
@angelolloqui
Copy link

Awesome ayush! Thanks! faster was impossible!

@pietervogelaar
Copy link

Thanks a lot!! I will check it out asap!

@ayush
Copy link
Contributor Author

ayush commented Nov 6, 2012

@angelolloqui @pietervogelaar thanks. let me know if you guys have feedback on this.

@angelolloqui
Copy link

Well, I already tried it out and it looks great! The only "however" that I would say are the colors used for the even rows. I think it would be more useful if the datatype would be the "even" element instead of the full property, and therefore we could change its color (fields names in black, types in orange). Anyway, with or without this little improvement, it works like a charm! Thanks!

@ayush
Copy link
Contributor Author

ayush commented Nov 6, 2012

Thats a good point. However, the intent behind alternating colors for full properties (rather than field/type) was to make it make easy for the eyeball to jump from one property to another.

@angelolloqui
Copy link

@ayush I understand the point but I dont fully agree that is indeed easier to jump from one to another. In my opinion it would be easier with the field/type though. Anyway, as I said, it is more than enough for my purposes. Thanks!

@pietervogelaar
Copy link

I checked it out and it looks great! One point of feedback. All properties are comma seperated now and that saves a lot of vertical space. But maybe a toggle button would be nice to see the properties below eachother because it will read easier.

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

5 participants