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

Feature Request: return parsed markdown body (html body) via API #6135

Open
meteorlxy opened this issue Feb 20, 2019 · 8 comments
Open

Feature Request: return parsed markdown body (html body) via API #6135

meteorlxy opened this issue Feb 20, 2019 · 8 comments
Labels
type/enhancement An improvement of existing functionality type/proposal The new feature has not been accepted yet but needs to be discussed first.

Comments

@meteorlxy
Copy link

Description

Currently, we can only get the raw body (markdown string) of issues/comments via API. i.e. the body field:

image

Hope we can generate parsed body (HTML string) via API.

  • Github API: use custom media type application/vnd.github.v3.html+json to return body_html field - REF
  • Gitlab API: have another markdown API to parse markdown string to HTML string by users - REF
  • Bitbucket API: return content.html by default - REF
@lunny lunny added type/enhancement An improvement of existing functionality type/proposal The new feature has not been accepted yet but needs to be discussed first. labels Feb 21, 2019
@westurner
Copy link

How does /api/v1/markdown work?

@meteorlxy
Copy link
Author

It's similar to Gitlab's implementation.

It works, but when fetching list of comments, we have to call /api/v1/markdown several times.

@westurner
Copy link

(I haven't looked at the code yet.) Is the rendered markdown HTML stored in the database or rendered for every request?

@meteorlxy
Copy link
Author

I haven't looked at the code yet

Me neither 😅 In fact, I'm not familiar with this project

@westurner
Copy link

(t activates the GitHub file finder)

@lunny
Copy link
Member

lunny commented Sep 3, 2020

So I think this could be closed?

@westurner
Copy link

Where is and when was this feature implemented?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement An improvement of existing functionality type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

No branches or pull requests

3 participants