Rust · 0.1.0

MemoImportPlan

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

ImportMemosResponse

Shape and fields

object

MemoImportPlan describes what importing a staged archive would do.

Field	Type / requirement	Description
`exportTime`	string (date-time)	When the archive was written.
`exporter`	string	Username of the user who exported the archive.
`generator`	string	The software that wrote the archive.
`memos`	integer (int32)	Number of memo records in the archive.
`attachments`	integer (int32)	Number of attachment files in the archive.
`new`	integer (int32)	Memos whose UID nobody on the instance holds.
`existing`	integer (int32)	Memos the user already holds; the conflict policy applies to them.
`renamed`	integer (int32)	Memos whose UID another account holds; they are imported under fresh UIDs.
`warnings`	array<MemoImportIssue>	Deviations the archive reader corrected while validating.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "exportTime": {
      "type": "string",
      "description": "When the archive was written.",
      "format": "date-time"
    },
    "exporter": {
      "type": "string",
      "description": "Username of the user who exported the archive."
    },
    "generator": {
      "type": "string",
      "description": "The software that wrote the archive."
    },
    "memos": {
      "type": "integer",
      "description": "Number of memo records in the archive.",
      "format": "int32"
    },
    "attachments": {
      "type": "integer",
      "description": "Number of attachment files in the archive.",
      "format": "int32"
    },
    "new": {
      "type": "integer",
      "description": "Memos whose UID nobody on the instance holds.",
      "format": "int32"
    },
    "existing": {
      "type": "integer",
      "description": "Memos the user already holds; the conflict policy applies to them.",
      "format": "int32"
    },
    "renamed": {
      "type": "integer",
      "description": "Memos whose UID another account holds; they are imported under fresh UIDs.",
      "format": "int32"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MemoImportIssue"
      },
      "description": "Deviations the archive reader corrected while validating."
    }
  },
  "description": "MemoImportPlan describes what importing a staged archive would do."
}