{
    "type": "object",
    "title": "Changeset Response",
    "description": "Container for Changeset object.",
    "properties": {
        "changeset": {
            "$ref": "#/components/schemas/Changeset",
            "description": "Changeset properties."
        }
    },
    "additionalProperties": false
}

{
    "type": "string",
    "description": "Indicates the state of the Changeset. 'waitingForFile' - indicates that Changeset metadata is created, but Changeset file is not uploaded yet or file upload is not confirmed yet. 'fileUploaded' - indicates that Changeset file is uploaded and confirmed.",
    "enum": [
        "waitingForFile",
        "fileUploaded"
    ],
    "title": "Changeset state"
}

{
    "type": "object",
    "description": "Changeset represents a file containing changes to the iModel. A single Changeset contains changes made on a single Briefcase file and pushed as a single file.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the Changeset."
        },
        "displayName": {
            "type": "string",
            "description": "Display name of the Changeset. Corresponds to Index property."
        },
        "description": {
            "type": "string",
            "description": "Description of the Changeset.",
            "nullable": true
        },
        "index": {
            "type": "integer",
            "description": "Index of the Changeset (increasing, but not necessarily sequential)."
        },
        "parentId": {
            "type": "string",
            "description": "Id of the parent Changeset.",
            "nullable": true
        },
        "creatorId": {
            "type": "string",
            "description": "Id of the user who created the Changeset."
        },
        "pushDateTime": {
            "type": "string",
            "format": "date-time",
            "description": "Date when the Changeset was pushed to iModelHub."
        },
        "briefcaseId": {
            "type": "integer",
            "description": "Id of the briefcase that was used to push the Changeset."
        },
        "groupId": {
            "type": "string",
            "description": "Id of the [Changeset Group](https://developer.bentley.com/apis/imodels-v2/operations/create-imodel-changeset-group/) that the Changeset belongs to.",
            "nullable": true
        },
        "fileSize": {
            "type": "integer",
            "description": "Size of the Changeset file in bytes."
        },
        "containingChanges": {
            "type": "integer",
            "description": "Describes what type of changes Changeset contains. Tells what changes changeset contains. 0 - regular, 1 - schema, 2 - definition, 4 - spatial data, 8 - sheets and drawings, 16 - views and models, 32 - global properties. ContainingChanges is flag value, therefore all change types, except Schema, can be combined."
        },
        "state": {
            "type": "string",
            "description": "Indicates the state of the Changeset. 'waitingForFile' - indicates that Changeset metadata is created, but Changeset file is not uploaded yet or file upload is not confirmed yet. 'fileUploaded' - indicates that Changeset file is uploaded and confirmed.",
            "enum": [
                "waitingForFile",
                "fileUploaded"
            ],
            "title": "Changeset state",
            "$ref": "#/components/schemas/Changeset-state"
        },
        "application": {
            "$ref": "#/components/schemas/Application",
            "description": "Information about the application that pushed the Changeset."
        },
        "synchronizationInfo": {
            "$ref": "#/components/schemas/SynchronizationInfo",
            "description": "Optional information about synchronization that is related to the Changeset."
        },
        "_links": {
            "$ref": "#/components/schemas/ChangesetLinks",
            "description": "Contains the hyperlinks to the related data of the Changeset."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "title": "Changeset Links",
    "description": "Hyperlinks to Changeset related data.",
    "properties": {
        "creator": {
            "$ref": "#/components/schemas/Link",
            "description": "Information about the creator of the Changeset."
        },
        "namedVersion": {
            "$ref": "#/components/schemas/Link",
            "description": "Named Version which was created for Changeset. If this is null then Changeset does not have a Named Version created for it."
        },
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Self hyperlink to get the details of the Changeset."
        },
        "download": {
            "$ref": "#/components/schemas/CloudStorageLink",
            "description": "Hyperlink to download Changeset file from storage. Set only if the user has at least `imodels_read` permission, otherwise it is always set to null."
        },
        "currentOrPrecedingCheckpoint": {
            "$ref": "#/components/schemas/Link",
            "description": "Hyperlink to get the latest successfully generated checkpoint where applied changeset index is lower or equal to this changeset index."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false
}

{
    "type": "string",
    "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
    "enum": [
        "azure",
        "google"
    ],
    "title": "CloudStorageLink storageType"
}

{
    "type": "object",
    "nullable": true,
    "description": "Hyperlink container.",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to cloud storage."
        },
        "storageType": {
            "type": "string",
            "description": "Storage type. Possible values: `azure` - Azure Blob storage, `google` - Google Cloud storage.",
            "enum": [
                "azure",
                "google"
            ],
            "title": "CloudStorageLink storageType",
            "$ref": "#/components/schemas/CloudStorageLink-storageType"
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "nullable": true,
    "description": "Information about the client application that is related to an entity.",
    "properties": {
        "id": {
            "type": "string",
            "description": "Id of the application."
        },
        "name": {
            "type": "string",
            "description": "Application name."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "nullable": true,
    "description": "Information about synchronization that is related to a Changeset. This information is set by applications that perform iModel synchronization.",
    "properties": {
        "taskId": {
            "type": "string",
            "description": "Id of the synchronization task.",
            "nullable": true
        },
        "changedFiles": {
            "type": "array",
            "nullable": true,
            "items": {
                "type": "string"
            },
            "description": "List of source file names that contained changes which were synchronized to this Changeset."
        }
    },
    "additionalProperties": false
}

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "additionalProperties": true
}

{
    "type": "object",
    "title": "Error Response",
    "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}