Render a markup document as HTML

POST

/markup

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Request Body

Media typeapplication/json

MarkupOption markup options

object

BranchPath

The current branch path where the form gets posted

string

Context

Context to render

string

FilePath

File path for detecting extension in file mode

string

Mode

Mode to render (comment, gfm, markdown, file)

string

Text

Text markup to render

string

Wiki

Is it a wiki page ?

boolean

Example^generated

{
  "BranchPath": "example",
  "Context": "example",
  "FilePath": "example",
  "Mode": "example",
  "Text": "example",
  "Wiki": true
}

Responses

200

MarkupRender is a rendered markup document

Media typetext/html

string

422

APIValidationError is error format response related to input validation

Media typetext/html

object

message

string

url

string