Updating swagger files.

This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2026-03-24 22:08:29 +00:00
1 parent 24045be2ef
commit 1b707cc416
37 files changed
+1902 -135

No files matched your search

+25 -1
View File
@@ -507,7 +507,7 @@
"readOnly": true
},
"triggerers": {
"description": "The triggerers status.",
"description": "The triggerers status for the Airflow environment. When set to `Disabled`, triggerers do not run. When set to `Enabled`, triggerers resume running. Disabling triggerers does not delete any environment settings.",
"$ref": "#/definitions/TriggerersStatus",
"readOnly": true
}
@@ -546,6 +546,30 @@
]
}
},
"AirflowEnvironmentSettingsRequest": {
"description": "The request payload for updating Apache Airflow environment settings.",
"type": "object",
"properties": {
"environmentVariables": {
"description": "Environment variables to configure for the Airflow environment. When updating, users must submit the complete set of desired values; existing values will be replaced.",
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"airflowConfigurationOverrides": {
"description": "Airflow configuration overrides. When updating, users must submit the complete set of desired values; existing values will be replaced.",
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"triggerers": {
"description": "The triggerers status for the Airflow environment. When set to `Disabled`, triggerers do not run. When set to `Enabled`, triggerers resume running. Disabling triggerers does not delete any environment settings.",
"$ref": "#/definitions/TriggerersStatus"
}
}
},
"AirflowComputeResponse": {
"description": "Apache Airflow compute configuration response.",
"type": "object",
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true,
"requirementsContent": "apache-airflow-providers-google==10.0.0\npandas==2.0.0\nrequests==2.31.0"
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/12345678-1234-1234-1234-123456789012",
"x-ms-operation-id": "12345678-1234-1234-1234-123456789012",
"Retry-After": 30
}
}
}
}
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true,
"filePath": "dags/requirements.txt"
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/12345678-1234-1234-1234-123456789012",
"x-ms-operation-id": "12345678-1234-1234-1234-123456789012",
"Retry-After": 30
}
}
}
}
@@ -0,0 +1,17 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true,
"requirementsContentRequest": "apache-airflow-providers-google==10.0.0\npandas==2.0.0\nrequests==2.31.0\nnumpy==1.24.0\nscikit-learn==1.3.0"
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/12345678-1234-1234-1234-123456789012",
"x-ms-operation-id": "12345678-1234-1234-1234-123456789012",
"Retry-After": 30
}
}
}
}
@@ -0,0 +1,16 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/3d8c27d6-0f77-4db9-a8d5-fb2722eb9df9",
"x-ms-operation-id": "3d8c27d6-0f77-4db9-a8d5-fb2722eb9df9",
"Retry-After": 30
}
}
}
}
@@ -0,0 +1,16 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/9f9f1a64-0f73-4c0f-b3f9-93c01872ae07",
"x-ms-operation-id": "9f9f1a64-0f73-4c0f-b3f9-93c01872ae07",
"Retry-After": 30
}
}
}
}
@@ -0,0 +1,35 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"apacheAirflowJobId": "5b218778-e7a5-4d73-8187-f10824047715",
"beta": true,
"airflowEnvironmentSettingsRequest": {
"environmentVariables": [
{
"name": "MY_ENV_VAR",
"value": "my_value"
},
{
"name": "ANOTHER_VAR",
"value": "another_value"
}
],
"airflowConfigurationOverrides": [
{
"name": "core.parallelism",
"value": "32"
}
],
"triggerers": "Enabled"
}
},
"responses": {
"202": {
"headers": {
"Location": "https://api.fabric.microsoft.com/v1/operations/12345678-1234-1234-1234-123456789012",
"x-ms-operation-id": "12345678-1234-1234-1234-123456789012",
"Retry-After": 30
}
}
}
}
+382
View File
@@ -562,6 +562,180 @@
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/start?beta=true": {
"post": {
"summary": "Starts an Apache Airflow job environment.",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *execute* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Airflow.Execute.All or Item.Execute.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Environment"
],
"operationId": "Environment_Start_Apache_Airflow_Job_Environment_(beta)",
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "apacheAirflowJobId",
"description": "The Apache Airflow job ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "beta",
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
"type": "boolean",
"required": true,
"default": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. Starting the environment is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"429": {
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
"x-ms-error-response": true,
"headers": {
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
},
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested Apache Airflow job was not found.\n\n* Forbidden - The caller doesn't have permissions to call the API.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Start Apache Airflow environment example": {
"$ref": "./examples/StartApacheAirflowEnvironment.json"
}
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/stop?beta=true": {
"post": {
"summary": "Stops an Apache Airflow job environment.",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *execute* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Airflow.Execute.All or Item.Execute.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Environment"
],
"operationId": "Environment_Stop_Apache_Airflow_Job_Environment_(beta)",
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "apacheAirflowJobId",
"description": "The Apache Airflow job ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "beta",
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
"type": "boolean",
"required": true,
"default": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. Stopping the environment is in progress.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"429": {
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
"x-ms-error-response": true,
"headers": {
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
},
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested Apache Airflow job was not found.\n\n* Forbidden - The caller doesn't have permissions to call the API.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Stop Apache Airflow environment example": {
"$ref": "./examples/StopApacheAirflowEnvironment.json"
}
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment?beta=true": {
"get": {
"summary": "Gets the Apache Airflow environment for the specified Apache Airflow job.",
@@ -714,6 +888,115 @@
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/deployRequirements?beta=true": {
"post": {
"summary": "Deploys requirements for an Apache Airflow job environment.",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Airflow.Write.All or Item.Write.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**You can deploy requirements by either including the `filePath` query parameter pointing to an existing requirements file, or by providing the requirements file content directly in the request body.**\n\n**When calling this API, the Apache Airflow job must be in 'Started' state.**\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Requirements"
],
"operationId": "Requirements_Deploy_Apache_Airflow_Job_Requirements_(beta)",
"consumes": [
"text/plain"
],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "apacheAirflowJobId",
"description": "The Apache Airflow job ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "beta",
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
"type": "boolean",
"required": true,
"default": true
},
{
"in": "query",
"name": "filePath",
"description": "The path to an existing requirements file to deploy. If not provided, the request body should contain the requirements file content.",
"type": "string",
"required": false
},
{
"in": "body",
"name": "requirementsContentRequest",
"description": "The requirements file content (UTF-8 encoded text). Required if filePath is not provided.",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. The environment will be updated in the background.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"429": {
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
"x-ms-error-response": true,
"headers": {
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
},
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested Apache Airflow job was not found.\n\n* Forbidden - The caller doesn't have permissions to call the API.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Deploy Apache Airflow job requirements with file path example": {
"$ref": "./examples/DeployApacheAirflowJobRequirementsQueryParam.json"
},
"Deploy Apache Airflow job requirements with request body example": {
"$ref": "./examples/DeployApacheAirflowJobRequirementsRequestBody.json"
}
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/settings?beta=true": {
"get": {
"summary": "Returns the environment settings for the specified Apache Airflow job.",
@@ -785,6 +1068,105 @@
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/updateSettings?beta=true": {
"post": {
"summary": "Updates the settings for an Apache Airflow job environment.",
"description": "> [!NOTE]\n> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n## Permissions\n\n The caller must have *write* permissions for the Apache Airflow job. \n\n## Required Delegated Scopes\n\n Airflow.Write.All or Item.Write.All\n\nSet the `beta` query parameter to `true` to call this API.\n\n**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**\n\n**When updating list values (environmentVariables, airflowConfigurationOverrides), users must submit the complete set of desired values; existing values will be replaced.**\n\n## Microsoft Entra supported identities\n\nThis API supports the Microsoft [identities](/rest/api/fabric/articles/identity-support) listed in this section.\n\n| Identity | Support |\n|-|-|\n| User | Yes |\n| [Service principal](/entra/identity-platform/app-objects-and-service-principals#service-principal-object) and [Managed identities](/entra/identity/managed-identities-azure-resources/overview) | Yes |\n\n## Interface",
"tags": [
"Settings"
],
"operationId": "Settings_Update_Apache_Airflow_Job_Settings_(beta)",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"x-ms-fabric-sdk-long-running-operation": true,
"parameters": [
{
"in": "path",
"name": "workspaceId",
"description": "The workspace ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "path",
"name": "apacheAirflowJobId",
"description": "The Apache Airflow job ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "beta",
"description": "This required parameter must be set to `true` to access this API, which is currently in beta.",
"type": "boolean",
"required": true,
"default": true
},
{
"in": "body",
"name": "airflowEnvironmentSettingsRequest",
"description": "Update Apache Airflow environment settings request payload.",
"schema": {
"$ref": "./definitions.json#/definitions/AirflowEnvironmentSettingsRequest"
},
"required": true
}
],
"responses": {
"200": {
"description": "Request completed successfully."
},
"202": {
"description": "Request accepted. The environment will be updated in the background.",
"headers": {
"Location": {
"description": "The URL of the operation status, which can be used to track the operation state.",
"type": "string"
},
"x-ms-operation-id": {
"description": "The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.",
"type": "string",
"format": "uuid"
},
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
}
},
"429": {
"description": "The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.",
"x-ms-error-response": true,
"headers": {
"Retry-After": {
"type": "integer",
"description": "The number of seconds to wait before retrying the request."
}
},
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested Apache Airflow job was not found.\n\n* Forbidden - The caller doesn't have permissions to call the API.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Update Apache Airflow job environment settings example": {
"$ref": "./examples/UpdateApacheAirflowJobSettings.json"
}
}
}
},
"/workspaces/{workspaceId}/apacheAirflowJobs/{apacheAirflowJobId}/environment/compute?beta=true": {
"get": {
"summary": "Returns the compute configuration for the specified Apache Airflow job environment.",