render-raw.json

{
  "summary": "Render a Markdown document in raw mode",
  "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.\n\n",
  "operationId": "markdown/render-raw",
  "tags": ["markdown"],
  "externalDocs": {
    "description": "API method documentation",
    "url": "https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode"
  },
  "parameters": [
    {
      "name": "accept",
      "description": "Setting to `application/vnd.github.v3+json` is recommended",
      "in": "header",
      "schema": {
        "type": "string",
        "default": "application/vnd.github.v3+json"
      }
    },
    {
      "name": "content-type",
      "description": "Setting content-type header is required for this endpoint",
      "in": "header",
      "schema": { "type": "string", "enum": ["text/plain; charset=utf-8"] }
    }
  ],
  "responses": { "200": { "description": "response" } },
  "x-code-samples": [
    {
      "lang": "Shell",
      "source": "curl \\\n  -XPOST \\\n  -H\"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw \\\n  -d '{\"data\":\"data\"}'"
    },
    {
      "lang": "JS",
      "source": "octokit.markdown.renderRaw({\n  data: 'data'\n})"
    },
    { "lang": "Ruby", "source": "octokit.render_raw(\n  'data'\n)" }
  ],
  "x-github": {
    "legacy": false,
    "enabledForApps": true,
    "githubCloudOnly": false,
    "requestBodyParameterName": "data",
    "previews": []
  },
  "x-changes": [],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": { "type": "string", "description": "data parameter" }
      }
    }
  }
}