fabric-rest-api-specs/deploymentPlan/definitions.json

{
    "swagger": "2.0",
    "info": {
        "title": "Deployment plan data types",
        "version": "v1"
    },
    "paths": {},
    "definitions": {
        "DeploymentPlan": {
            "description": "A deployment plan object.",
            "type": "object",
            "required": ["type"],
            "allOf": [
                {
                    "$ref": "../common/definitions.json#/definitions/Item"
                }
            ]
        },
        "DeploymentPlans": {
            "description": "A list of deployment plans.",
            "required": ["value"],
            "type": "object",
            "properties": {
                "value": {
                    "description": "A list of deployment plans.",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/DeploymentPlan"
                    },
                    "readOnly": true
                }
            },
            "allOf": [
                {
                    "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
                }
            ]
        },
        "CreateDeploymentPlanRequest": {
            "description": "The request payload for creating a deployment plan.",
            "required": ["displayName"],
            "properties": {
                "displayName": {
                    "description": "The deployment plan display name. The display name must follow naming rules according to the item type.",
                    "type": "string",
                    "readOnly": false
                },
                "description": {
                    "description": "The deployment plan description. Maximum length is 256 characters.",
                    "type": "string",
                    "readOnly": false
                },
                "folderId": {
                    "description": "The folder ID. If not specified or null, the deployment plan is created with the workspace as its folder.",
                    "type": "string",
                    "format": "uuid",
                    "readOnly": false
                },
                "definition": {
                    "description": "The deployment plan public definition.",
                    "$ref": "#/definitions/DeploymentPlanPublicDefinition",
                    "readOnly": false
                },
                "sensitivityLabelSettings": {
                    "description": "The sensitivity label settings for the deployment plan.",
                    "$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
                    "readOnly": false
                }
            }
        },
        "UpdateDeploymentPlanDefinitionRequest": {
            "description": "The request payload for updating a deployment plan public definition.",
            "required": ["definition"],
            "properties": {
                "definition": {
                    "$ref": "#/definitions/DeploymentPlanPublicDefinition",
                    "readOnly": false
                }
            }
        },
        "DeploymentPlanDefinitionResponse": {
            "description": "The response payload for a deployment plan public definition.",
            "required": ["definition"],
            "properties": {
                "definition": {
                    "$ref": "#/definitions/DeploymentPlanPublicDefinition",
                    "readOnly": true
                }
            }
        },
        "DeploymentPlanPublicDefinition" : {
            "description": "The deployment plan public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/deployment-plan-definition) for more details on the structure of the deployment plan definition.",
            "type": "object",
            "required": ["parts"],
            "properties": {
                "format": {
                    "description": "The format of the deployment plan definition. Additional `format` types may be added over time.",
                    "type": "string",
                    "enum": [
                        "DeploymentPlanFormat"
                    ],
                    "x-ms-enum": {
                        "name": "DeploymentPlanDefinitionFormat",
                        "modelAsString": true,
                        "values": [
                            {
                            "value": "DeploymentPlanFormat",
                            "description": "The format for deployment plan definitions, designed to support CI/CD scenarios in Fabric. See [Deployment plan - DeploymentPlanV1 specification](/rest/api/fabric/articles/item-management/definitions/deployment-plan-definition) for more details."
                            }
                        ]
                    },
                    "readOnly": false
                },
                "parts": {
                    "description": "A list of definition parts.",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/DeploymentPlanPublicDefinitionPart"
                    },
                    "readOnly": false
                }
            }
        },
        "DeploymentPlanPublicDefinitionPart": {
            "description": "The deployment plan definition part object.",
            "type": "object",
            "properties": {
                "path": {
                    "description": "The deployment plan public definition part path.",
                    "type": "string",
                    "readOnly": false
                },
                "payload": {
                    "description": "The deployment plan public definition part payload.",
                    "type": "string",
                    "readOnly": false
                },
                "payloadType":{
                    "description": "The payload type.",
                    "$ref": "../common/definitions.json#/definitions/PayloadType",
                    "readOnly": false
                }
            },
            "required": [
                "path",
                "payload",
                "payloadType"
            ]
        },
        "UpdateDeploymentPlanRequest": {
            "description": "The request payload for updating a deployment plan.",
            "properties": {
                "displayName": {
                    "description": "The deployment plan display name. The display name must follow naming rules according to item type.",
                    "type": "string",
                    "readOnly": false
                },
                "description": {
                    "description": "The deployment plan description. Maximum length is 256 characters.",
                    "type": "string",
                    "readOnly": false
                }
            }
        }
    }
}