projects-export-v1

Copied to Clipboard

{ "$id": "projects-export-v1", "title": "Project Export Document", "description": "An exported project document", "type": "object", "additionalProperties": false, "required": [ "_id", "iid", "name", "description", "thumbnail", "backgroundColor", "components", "created", "createdBy", "lastUpdated", "lastUpdatedBy" ], "properties": { "_id": { "$ref": "common#/definitions/object-id-string" }, "iid": { "$ref": "common#/definitions/iid" }, "name": { "$ref": "projects-common#/definitions/name" }, "description": { "$ref": "projects-common#/definitions/description" }, "thumbnail": { "$ref": "#/definitions/thumbnail" }, "backgroundColor": { "$ref": "#/definitions/backgroundColor" }, "components": { "$ref": "#/definitions/components" }, "folders": { "$ref": "#/definitions/folders" }, "created": { "$ref": "common#/definitions/iso-date-string" }, "createdBy": { "$ref": "common-http#/definitions/account" }, "lastUpdated": { "$ref": "common#/definitions/iso-date-string" }, "lastUpdatedBy": { "$ref": "common-http#/definitions/account" }, "versionHistory": { "$ref": "projects-common#/definitions/versionHistory" } }, "definitions": { "thumbnail": { "description": "Base64 string encoding binary image data for project thumbnail", "type": "string" }, "backgroundColor": { "description": "Thumbnail background color", "type": "string", "default": "#FFFFFF" }, "versionHistory": { "type": "array", "items": { "$ref": "#/definitions/version" } }, "version": { "type": "object", "additionalProperties": false, "required": [ "versionNumber", "commitMessage", "author", "branchName" ], "properties": { "versionNumber": { "type": "integer" }, "commitMessage": { "type": "string" }, "author": { "type": "string" }, "branchName": { "type": "string" } } }, "component": { "type": "object", "additionalProperties": false, "required": [ "iid", "type", "reference", "folder", "document" ], "properties": { "iid": { "$ref": "common#/definitions/iid" }, "type": { "$ref": "projects-common#/definitions/componentType" }, "reference": { "type": "string" }, "folder": { "$ref": "projects-common#/definitions/componentFolder" }, "document": { "title": "Component export", "description": "Full component document", "type": "object" } } }, "folders": { "type": "array", "items": { "oneOf": [ { "$ref": "common-http#/definitions/folderNodeExpanded" }, { "$ref": "common-http#/definitions/componentNodeExpanded" } ] } }, "components": { "type": "array", "items": { "$ref": "#/definitions/component" } } } }