lib/api/markdown.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

module API
  class Markdown < Grape::API
    params do
      requires :text, type: String, desc: "The markdown text to render"
      optional :gfm, type: Boolean, desc: "Render text using GitLab Flavored Markdown"
      optional :project, type: String, desc: "The full path of a project to use as the context when creating references using GitLab Flavored Markdown"
    end
    resource :markdown do
      desc "Render markdown text" do
        detail "This feature was introduced in GitLab 11.0."
      end
      post do
        # Explicitly set CommonMark as markdown engine to use.
        # Remove this set when https://gitlab.com/gitlab-org/gitlab-ce/issues/43011 is done.
        context = { markdown_engine: :common_mark, only_path: false }

        if params[:project]
          project = Project.find_by_full_path(params[:project])

          not_found!("Project") unless can?(current_user, :read_project, project)

          context[:project] = project
        else
          context[:skip_project_check] = true
        end

        context[:pipeline] = params[:gfm] ? :full : :plain_markdown

        { html: Banzai.render(params[:text], context) }
      end
    end
  end
end