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.

Sign up for GitHub

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

Jump to bottom

Endpoint description containts HTML in place of markdown #559

Closed
frodrigo opened this issue Jan 4, 2017 · 2 comments
Closed

Endpoint description containts HTML in place of markdown #559

frodrigo opened this issue Jan 4, 2017 · 2 comments
Labels
bug?

Comments

@frodrigo
Copy link
Contributor

frodrigo commented Jan 4, 2017

Like main info description, endoint description should be in markdown and not in HTML

This line should be fixed or removed
https://github.com/ruby-grape/grape-swagger/blob/master/lib/grape-swagger/endpoint.rb#L138

As side question, I think there is no raison to add again the summary in the description (and more over as a title)
https://github.com/ruby-grape/grape-swagger/blob/master/lib/grape-swagger/endpoint.rb#L136
@dblock
Copy link
Member

dblock commented Jan 4, 2017

@frodrigo write a test, make a PR?

@dblock dblock added the bug? label Jan 4, 2017
frodrigo added a commit to Mapotempo/grape-swagger that referenced this issue Jan 4, 2017
@frodrigo
Map clearly Grape desc/detail to Swagger summary/description ruby-gra…
d3c279d 
…pe#559
frodrigo added a commit to Mapotempo/grape-swagger that referenced this issue Jan 4, 2017
@frodrigo
Set endpoint description in Markdown ruby-grape#559
6f7f76b 
Map clearly Grape desc/detail to Swagger summary/description
@frodrigo frodrigo mentioned this issue Jan 4, 2017
Merged
frodrigo added a commit to Mapotempo/grape-swagger that referenced this issue Jan 4, 2017
@frodrigo
Set endpoint description in Markdown ruby-grape#559
a41387c 
Map clearly Grape desc/detail to Swagger summary/description
@LeFnord
Copy link
Member

LeFnord commented Jan 11, 2017

closed with follow-up issue #566

@LeFnord LeFnord closed this as completed Jan 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug?
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@LeFnord @dblock @frodrigo