getMarkdown

​

Summary

• Operation ID: getMarkdown
• API member path: editor.doc.getMarkdown(...)
• Mutates document: no
• Idempotency: idempotent
• Supports tracked mode: no
• Supports dry run: no
• Deterministic target resolution: yes

​

Expected result

​

Input fields

​

Example request

{
  "in": {
    "kind": "story",
    "storyType": "body"
  }
}

​

Output fields

​

Example response

"example"

​

Pre-apply throws

• STORY_NOT_FOUND
• STORY_MISMATCH
• STORY_NOT_SUPPORTED
• CROSS_STORY_PLAN
• MATERIALIZATION_FAILED

​

Non-applied failure codes

• None

​

Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "in": {
      "$ref": "#/$defs/StoryLocator"
    }
  },
  "type": "object"
}

{
  "type": "string"
}