github-starred/gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-03-12 02:24:21 -05:00
Code Issues 2.6k Packages Projects Releases 100 Wiki Activity

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

New Issue
Open
opened 2025-11-02 04:54:56 -06:00 by GiteaMirror · 8 comments
GiteaMirror commented 2025-11-02 04:54:56 -06:00
Owner
Copy Link

Originally created by @meteorlxy on GitHub (Feb 20, 2019).

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
Originally created by @meteorlxy on GitHub (Feb 20, 2019). ## Description Currently, we can only get the raw body (markdown string) of issues/comments via API. i.e. the `body` field: ![image](https://user-images.githubusercontent.com/18205362/53071891-7df4d880-351e-11e9-8263-a54ff335b53a.png) 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](https://developer.github.com/v3/issues/comments/#custom-media-types) - Gitlab API: have another `markdown` API to parse markdown string to HTML string by users - [REF](https://docs.gitlab.com/ce/api/markdown.html) - Bitbucket API: return `content.html` by default - [REF](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/issues/%7Bissue_id%7D/comments#get)
GiteaMirror added the type/proposaltype/enhancement labels 2025-11-02 04:54:56 -06:00
GiteaMirror commented 2025-11-02 04:54:56 -06:00
Author
Owner
Copy Link

@westurner commented on GitHub (Mar 3, 2019):

How does /api/v1/markdown work?

@westurner commented on GitHub (Mar 3, 2019): How does `/api/v1/markdown` work?
GiteaMirror commented 2025-11-02 04:54:56 -06:00
Author
Owner
Copy Link

@meteorlxy commented on GitHub (Mar 3, 2019):

It's similar to Gitlab's implementation.

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

@meteorlxy commented on GitHub (Mar 3, 2019): It's similar to Gitlab's implementation. It works, but when fetching list of comments, we have to call `/api/v1/markdown` several times.
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@westurner commented on GitHub (Mar 3, 2019):

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

@westurner commented on GitHub (Mar 3, 2019): (I haven't looked at the code yet.) Is the rendered markdown HTML stored in the database or rendered for every request?
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@meteorlxy commented on GitHub (Mar 3, 2019):

I haven't looked at the code yet

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

@meteorlxy commented on GitHub (Mar 3, 2019): > I haven't looked at the code yet Me neither 😅 In fact, I'm not familiar with this project
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@westurner commented on GitHub (Mar 3, 2019):

I took a quick look for my first time:

https://github.com/go-gitea/gitea/blob/master/models/issue.go

  • RenderedContent

https://github.com/go-gitea/gitea/blob/master/routers/api/v1/api.go

https://github.com/go-gitea/gitea/blob/master/routers/api/v1/repo/issue.go

https://github.com/go-gitea/gitea/blob/master/routers/api/v1/misc/markdown.go

@westurner commented on GitHub (Mar 3, 2019): I took a quick look for my first time: https://github.com/go-gitea/gitea/blob/master/models/issue.go - `RenderedContent` https://github.com/go-gitea/gitea/blob/master/routers/api/v1/api.go https://github.com/go-gitea/gitea/blob/master/routers/api/v1/repo/issue.go https://github.com/go-gitea/gitea/blob/master/routers/api/v1/misc/markdown.go
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@westurner commented on GitHub (Mar 3, 2019):

(t activates the GitHub file finder)

@westurner commented on GitHub (Mar 3, 2019): (`t` activates the GitHub file finder)
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@lunny commented on GitHub (Sep 3, 2020):

So I think this could be closed?

@lunny commented on GitHub (Sep 3, 2020): So I think this could be closed?
GiteaMirror commented 2025-11-02 04:54:57 -06:00
Author
Owner
Copy Link

@westurner commented on GitHub (Sep 3, 2020):

Where is and when was this feature implemented?

@westurner commented on GitHub (Sep 3, 2020): Where is and when was this feature implemented?
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
$20
$250
$50
$500
backport/done
💎 Bounty
docs-update-needed
good first issue
hacktoberfest
issue/bounty
issue/confirmed
issue/critical
issue/duplicate
issue/needs-feedback
issue/not-a-bug
issue/regression
issue/stale
issue/workaround
lgtm/need 2
modifies/api
modifies/translation
outdated/backport/v1.18
outdated/theme/markdown
outdated/theme/timetracker
performance/bigrepo
performance/cpu
performance/memory
performance/speed
pr/breaking
proposal/accepted
proposal/rejected
pr/wip
pull-request
Mirrored from GitHub Pull Request
 reviewed/wontfix
💰 Rewarded
skip-changelog
status/blocked
topic/accessibility
topic/api
topic/authentication
topic/build
topic/code-linting
topic/commit-signing
topic/content-rendering
topic/deployment
topic/distribution
topic/federation
topic/gitea-actions
topic/issues
topic/lfs
topic/mobile
topic/moderation
topic/packages
topic/pr
topic/projects
topic/repo
topic/repo-migration
topic/security
topic/theme
topic/ui
topic/ui-interaction
topic/ux
topic/webhooks
topic/wiki
type/bug
type/deprecation
type/docs
type/enhancement
type/feature
type/miscellaneous
type/proposal
type/question
type/refactoring
type/summary
type/testing
type/upstream
No Label type/enhancement type/proposal
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#2945
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?