Properties
| Name | Type | Description |
|---|---|---|
| version | object | The attachment version. Set this to the current version number of the attachment. Note, the version number only needs to be incremented when updating the actual attachment, not its properties. |
| id | string | The ID of the attachment to be updated. |
| type | string | Set this to `attachment`. |
| title | string | The updated name of the attachment. |
| metadata | object | |
| container | object | The new content to attach the attachment to. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/AttachmentUpdate",
"title": "AttachmentUpdate",
"required": [
"id",
"type",
"version"
],
"type": "object",
"properties": {
"version": {
"required": [
"number"
],
"type": "object",
"properties": {
"number": {
"type": "integer",
"description": "The version number.",
"format": "int32"
}
},
"description": "The attachment version. Set this to the current version number of the\nattachment. Note, the version number only needs to be incremented when\nupdating the actual attachment, not its properties."
},
"id": {
"type": "string",
"description": "The ID of the attachment to be updated."
},
"type": {
"type": "string",
"description": "Set this to `attachment`.",
"enum": [
"attachment"
]
},
"title": {
"maxLength": 255,
"type": "string",
"description": "The updated name of the attachment."
},
"metadata": {
"type": "object",
"properties": {
"mediaType": {
"type": "string",
"description": "The media type of the attachment, e.g. 'img/jpg'."
},
"comment": {
"type": "string",
"description": "The comment for this update."
}
}
},
"container": {
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The `id` of the parent content."
},
"type": {
"type": "string",
"description": "The content type. You can only attach attachments to content\nof type: `page`, `blogpost`."
}
},
"description": "The new content to attach the attachment to."
}
}
}