Atlassian · Schema

VersionRestore

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
operationKey string Set to 'restore'.
params object
View JSON Schema on GitHub

JSON Schema

atlassian-versionrestore-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VersionRestore",
  "title": "VersionRestore",
  "required": [
    "operationKey",
    "params"
  ],
  "type": "object",
  "properties": {
    "operationKey": {
      "type": "string",
      "description": "Set to 'restore'.",
      "enum": [
        "restore"
      ],
      "example": "restore"
    },
    "params": {
      "required": [
        "message",
        "versionNumber"
      ],
      "type": "object",
      "properties": {
        "versionNumber": {
          "type": "integer",
          "description": "The version number to be restored.",
          "format": "int32"
        },
        "message": {
          "type": "string",
          "description": "Description for the version."
        },
        "restoreTitle": {
          "type": "boolean",
          "default": false,
          "description": "If true, the content title will be the same as the title from the version restored. Defaults to `false`."
        }
      },
      "example": "example_value"
    }
  }
}