nprasad2077/fabric-rest-api-specs
1
0 Fork 0
mirror of https://github.com/microsoft/fabric-rest-api-specs.git synced 2026-11-04 12:04:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updating swagger files.

Browse Source
This commit is contained in:
Fabric-APIs-Publish-Specification-Pipeline committed 2026-03-19 13:39:02 +00:00
1 parent 6b1a22c096
commit 24045be2ef
400 files changed
+7673 -1755
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

eventSchemaSet/definitions.json
+6 -1
View File
@@ -70,6 +70,11 @@
"description": "The EventSchemaSet public definition.",
"$ref": "#/definitions/EventSchemaSetPublicDefinition",
"readOnly": false
},
"sensitivityLabelSettings": {
"description": "The sensitivity label settings for the EventSchemaSet.",
"$ref": "../common/definitions.json#/definitions/SensitivityLabelSettings",
"readOnly": false
}
}
},
@@ -97,7 +102,7 @@
"type": "string"
},
"EventSchemaSetPublicDefinition": {
"description": "EventSchemaSet public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/event-schema-set) for more details on how to craft a EventSchemaSet public definition.",
"description": "EventSchemaSet public definition object. Refer to this [article](/rest/api/fabric/articles/item-management/definitions/eventschemaset-definition) for more details on the structure of the EventSchemaSet definition.",
"type": "object",
"required": [ "parts" ],
"properties": {
eventSchemaSet/examples/CreateEventSchemaSet.json
+4 -1
View File
@@ -27,7 +27,10 @@
"description": "A EventSchemaSet description.",
"type": "EventSchemaSet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"sensitivityLabel": {
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
}
}
},
"202": {
eventSchemaSet/examples/CreateEventSchemaSetWithoutDefinition.json
+4 -1
View File
@@ -13,7 +13,10 @@
"description": "A EventSchemaSet description.",
"type": "EventSchemaSet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"id": "5b218778-e7a5-4d73-8187-f10824047715"
"id": "5b218778-e7a5-4d73-8187-f10824047715",
"sensitivityLabel": {
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
}
}
},
"202": {
eventSchemaSet/examples/DeleteEventSchemaSet.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"EventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715"
"eventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715"
},
"responses": {
"200": {}
eventSchemaSet/examples/GetEventSchemaSet.json
+5 -2
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
"EventSchemaSetId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
"eventSchemaSetId": "41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"responses": {
"200": {
@@ -10,7 +10,10 @@
"displayName": "EventSchemaSet 1",
"description": "A EventSchemaSet description.",
"type": "EventSchemaSet",
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"sensitivityLabel": {
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
}
}
}
}
eventSchemaSet/examples/GetEventSchemaSetDefinition.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "6e335e92-a2a2-4b5a-970a-bd6a89fbb765",
"EventSchemaSetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
"eventSchemaSetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
},
"responses": {
"200": {
eventSchemaSet/examples/HardDeleteEventSchemaSet.json
+10
View File
@@ -0,0 +1,10 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"eventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715",
"hardDelete": true
},
"responses": {
"200": {}
}
}
eventSchemaSet/examples/ListEventSchemaSetsInWorkspace.json
+6
View File
@@ -14,6 +14,9 @@
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87"
},
"sensitivityLabel": {
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
}
},
{
@@ -24,6 +27,9 @@
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"properties": {
"oneLakeRootPath": "https://onelake.dfs.fabric.microsoft.com/f089354e-8366-4e18-aea3-4cb4a3a50b48/d8f6cf16-3aac-4440-9d76-a03d86b7ae3e"
},
"sensitivityLabel": {
"id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
}
}
]
eventSchemaSet/examples/RunOnDemandEventSchemaSetNoBody.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
"EventSchemaSetId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"eventSchemaSetId": "431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7",
"jobType": "publicFacingJobName"
},
"responses": {
eventSchemaSet/examples/UpdateEventSchemaSet.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"EventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715",
"eventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateEventSchemaSetRequest": {
"displayName": "EventSchemaSet's New name",
"description": "EventSchemaSet's New description"
eventSchemaSet/examples/UpdateEventSchemaSetDefinition.json
+1 -1
View File
@@ -1,7 +1,7 @@
{
"parameters": {
"workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
"EventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715",
"eventSchemaSetId": "5b218778-e7a5-4d73-8187-f10824047715",
"updateMetadata" : true,
"updateEventSchemaSetDefinitionRequest": {
"definition": {
eventSchemaSet/swagger.json
+22 -12
View File
@@ -91,7 +91,7 @@
},
"post": {
"summary": "Creates an EventSchemaSet in the specified workspace.",
"description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an EventSchemaSet with a public definition, refer to [EventSchemaSet](/rest/api/fabric/articles/item-management/definitions/event-schema-set) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create a EventSchemaSet the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\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) | No |\n\n## Interface",
"description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n To create an EventSchemaSet with a public definition, refer to [EventSchemaSet](/rest/api/fabric/articles/item-management/definitions/eventschemaset-definition) article. \n\n ## Permissions \n The caller must have a *contributor* workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All \n\n## Limitations \n- To create an EventSchemaSet the workspace must be on a supported Fabric capacity. For more information see: [Microsoft Fabric license types](/fabric/enterprise/licenses#microsoft-fabric-license-types).\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) | No |\n\n## Interface",
"tags": [
"Items"
],
@@ -177,7 +177,7 @@
}
}
},
"/workspaces/{workspaceId}/EventSchemaSets/{EventSchemaSetId}": {
"/workspaces/{workspaceId}/eventSchemaSets/{eventSchemaSetId}": {
"get": {
"summary": "Returns properties of the specified EventSchemaSet.",
"description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\n## Permissions\n\n The caller must have *read* permissions for the workspace . \n\n## Required Delegated Scopes\n\n Item.Read.All or Item.ReadWrite.All\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) | No |\n\n## Interface",
@@ -199,7 +199,7 @@
},
{
"in": "path",
"name": "EventSchemaSetId",
"name": "eventSchemaSetId",
"description": "The EventSchemaSet ID.",
"type": "string",
"format": "uuid",
@@ -263,7 +263,7 @@
},
{
"in": "path",
"name": "EventSchemaSetId",
"name": "eventSchemaSetId",
"description": "The EventSchemaSet ID.",
"type": "string",
"format": "uuid",
@@ -333,11 +333,18 @@
},
{
"in": "path",
"name": "EventSchemaSetId",
"name": "eventSchemaSetId",
"description": "The EventSchemaSet ID.",
"type": "string",
"format": "uuid",
"required": true
},
{
"in": "query",
"name": "hardDelete",
"description": "Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to `false` or not specified, the item is soft-deleted if the item type supports it.",
"type": "boolean",
"required": false
}
],
"responses": {
@@ -358,20 +365,23 @@
}
},
"default": {
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
"description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.\n\n* InsufficientWorkspaceRole - User doesn't have sufficient workspace role.\n\n* FeatureNotAvailable - This could be due to the soft deletion feature not being available.\n\n* UnsupportedItemType - This could be due to the soft deletion feature not supported by the requested item type.\n\n* TenantSwitchDisabled - This could be due to the soft deletion feature being disabled by the tenant admin.\n\n* InvalidTargetItemStateForSoftDeletion - The item is in invalid states for soft deletion.\n\n* InvalidParentItemStateForSoftDeletion - The item's parent item is not in Active state.",
"schema": {
"$ref": "../common/definitions.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a EventSchemaSet example": {
"Delete an EventSchemaSet example": {
"$ref": "./examples/DeleteEventSchemaSet.json"
},
"Hard delete an EventSchemaSet set example": {
"$ref": "./examples/HardDeleteEventSchemaSet.json"
}
}
}
},
"/workspaces/{workspaceId}/EventSchemaSets/{EventSchemaSetId}/getDefinition": {
"/workspaces/{workspaceId}/eventSchemaSets/{eventSchemaSetId}/getDefinition": {
"post": {
"summary": "Returns the specified EventSchemaSet definition.",
"description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\nWhen you get a EventSchemaSet's public definition, the sensitivity label is not a part of the definition.\n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace role. \n\n## Required Delegated Scopes\n\n Item.ReadWrite.All\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) | No |\n\n## Interface",
@@ -394,7 +404,7 @@
},
{
"in": "path",
"name": "EventSchemaSetId",
"name": "eventSchemaSetId",
"description": "The EventSchemaSet ID.",
"type": "string",
"format": "uuid",
@@ -460,7 +470,7 @@
}
}
},
"/workspaces/{workspaceId}/EventSchemaSets/{EventSchemaSetId}/updateDefinition": {
"/workspaces/{workspaceId}/eventSchemaSets/{eventSchemaSetId}/updateDefinition": {
"post": {
"summary": "Overrides the definition for the specified EventSchemaSet.",
"description": "> [!NOTE]\n> EventSchemaSets item is currently in Preview ([learn more](/fabric/fundamentals/preview)).\n\nThis API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n \nUpdating the EventSchemaSet's definition, does not affect its sensitivity label. \n\n## Permissions\n\n The caller must have *read and write* permissions for the workspace role. \n## Required Delegated Scopes\n\n Item.ReadWrite.All\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) | No |\n\n## Interface",
@@ -483,7 +493,7 @@
},
{
"in": "path",
"name": "EventSchemaSetId",
"name": "eventSchemaSetId",
"description": "The EventSchemaSet ID.",
"type": "string",
"format": "uuid",
@@ -559,4 +569,4 @@
"responses": {},
"security": [],
"tags": []
}
}