postext.dev

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "new_blank",
        "copy_current",
        "duplicate",
        "rename",
        "add_language",
        "set_cover",
        "remove_cover",
        "hide_sample",
        "show_sample"
      ]
    },
    "kind": {
      "type": "string",
      "enum": [
        "sample",
        "project"
      ],
      "description": "duplicate: what the id names."
    },
    "id": {
      "type": "string",
      "description": "duplicate, rename, hide_sample, show_sample: the book. add_language, set_cover, remove_cover: the project (the one on screen when left out)."
    },
    "thisLanguageOnly": {
      "type": "boolean",
      "description": "rename a project in several languages: give the name and description to the language on screen only; the others keep the title they show."
    },
    "language": {
      "type": "string",
      "description": "add_language: the tag of the new language (en, es, fr, zh-Hant, ar…), one the book does not have. duplicate a sample: the language to copy. Left out, the one a click on the sample would open: the one on screen, else the interface language, else the language the reader last edited."
    },
    "from": {
      "type": "string",
      "enum": [
        "edited",
        "original"
      ],
      "description": "duplicate a sample: copy the reader's edited version in that language (edited; refused when there is none) or the sample as it ships (original). Left out, the edited version when there is one, as the Books panel does."
    },
    "name": {
      "type": "string",
      "description": "new_blank, copy_current, rename: the name."
    },
    "description": {
      "type": "string",
      "description": "rename: the description (empty clears it)."
    },
    "file": {
      "type": "object",
      "description": "set_cover: the picture (PNG, JPEG, WebP, GIF or SVG): where to fetch it (url) or its bytes (base64).",
      "properties": {
        "url": {
          "type": "string",
          "description": "An http(s) or data: URL the page can fetch."
        },
        "base64": {
          "type": "string",
          "description": "The bytes, base64-encoded."
        },
        "mimeType": {
          "type": "string",
          "description": "Its media type. Read from the response or the file name when left out."
        },
        "fileName": {
          "type": "string",
          "description": "Its file name, with its extension."
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false
}