changedOutput schema / (root)
Previous value: -nullNew value: +{
+ "properties": {
+ "api": {
+ "description": "API version (1.0).",
+ "type": "string"
+ },
+ "doc": {
+ "description": "The document read or written: path, sha256 and paragraph count.",
+ "properties": {
+ "characters": {
+ "description": "text.normalize of a text string: its length.",
+ "type": "integer"
+ },
+ "paragraphs": {
+ "description": "Body paragraphs.",
+ "type": "integer"
+ },
+ "path": {
+ "description": "Path of the document.",
+ "type": "string"
+ },
+ "sha256": {
+ "description": "sha256 of the file (pass as expect.sha256 to a write).",
+ "type": "string"
+ },
+ "source": {
+ "description": "A .txt/.md/.odt source's format, encoding and split mode; \"text\" for a text string (text.normalize).",
+ "type": [
+ "object",
+ "string"
+ ]
+ }
+ },
+ "type": "object"
+ },
+ "next": {
+ "description": "Cursor for the next page (pass as cursor), or null.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "ok": {
+ "description": "Always true on success.",
+ "type": "boolean"
+ },
+ "op": {
+ "description": "The operation that ran.",
+ "type": "string"
+ },
+ "result": {
+ "description": "What the operation returns.",
+ "properties": {
+ "applied": {
+ "description": "One entry per style in the template.",
+ "items": {
+ "description": "What happened to a style.",
+ "properties": {
+ "action": {
+ "description": "created, replaced or skipped.",
+ "type": "string"
+ },
+ "style": {
+ "description": "Style id.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "backup": {
+ "description": "Path of the backup taken before the write.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "changed_parts": {
+ "description": "Package parts rewritten.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dry_run": {
+ "description": "True when nothing was written (a preview).",
+ "type": "boolean"
+ },
+ "op_id": {
+ "description": "Undo-log id of this write (history.undo / history.restore).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "paragraphs_changed": {
+ "description": "Paragraphs whose style reference was rewritten.",
+ "type": "integer"
+ },
+ "references_rewritten": {
+ "description": "Style references rewritten (renames, merges).",
+ "type": "integer"
+ },
+ "sha256": {
+ "description": "sha256 of the file after the write (pass as expect.sha256 next).",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tracked": {
+ "description": "Always false: style definitions are not tracked changes.",
+ "type": "boolean"
+ },
+ "warnings": {
+ "description": "Notes on what the write could not do as asked.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "applied",
+ "dry_run",
+ "tracked",
+ "changed_parts"
+ ],
+ "type": "object"
+ },
+ "warnings": {
+ "description": "Things to know about the result.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "api",
+ "ok",
+ "op",
+ "result",
+ "warnings",
+ "next"
+ ],
+ "type": "object"
+}