Updating swagger files.

2026-11-04 12:04:23 +00:00 · 2025-04-03 11:31:31 +00:00
1 parent 68bb579aa1
commit 2c1133f40b
@@ -0,0 +1,198 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "v1",
+    "title": "Warehouse data types"
+  },
+  "paths": {},
+  "definitions": {
+    "Warehouses": {
+      "description": "A list of warehouses.",
+      "required": ["value"],
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "A list of warehouses.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Warehouse"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "../common/definitions.json#/definitions/PaginatedResponse"
+        }
+      ]
+    },
+    "Warehouse": {
+      "description": "A warehouse object.",
+      "type": "object",
+      "required": ["type"],
+      "allOf": [
+        {
+            "$ref": "../common/definitions.json#/definitions/Item"
+        }
+      ],
+      "properties": {
+          "properties": {
+              "description": "The warehouse properties.",
+              "$ref": "#/definitions/WarehouseProperties"
+          }
+      }
+    },
+    "WarehouseProperties": {
+      "description": "The warehouse item properties.",
+      "type": "object",
+      "required": ["connectionString", "createdDate", "lastUpdatedTime"],
+      "properties": {
+        "connectionString": {
+          "description": "The SQL connection string connected to the workspace containing this warehouse.",
+          "type": "string"
+        },
+        "createdDate": {
+          "description": "The date and time the warehouse was created.",
+          "type": "string",
+          "format": "date-time"
+        },
+        "lastUpdatedTime": {
+          "description": "The date and time the warehouse was last updated",
+          "type": "string",
+          "format": "date-time"
+        },
+        "collationType": {
+          "description": "The collation type of the warehouse.",
+          "$ref": "#/definitions/CollationType"
+        }
+      }
+    },
+    "CollationType": {
+      "type": "string",
+        "description": "Warehouse collation. Additional `collations` may be added over time.",
+        "enum": ["Latin1_General_100_BIN2_UTF8", "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"],
+        "x-ms-enum": {
+          "name": "CollationType",
+          "modelAsString": true,
+          "values": [
+            {
+                "value": "Latin1_General_100_BIN2_UTF8",
+                "description": "The default - case-sensitive (CS) collation"
+            },
+            {
+                "value": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8",
+                "description": "case-insensitive (CI) collation"
+            }
+          ]
+        }
+    },
+    "CreateWarehouseRequest": {
+      "description": "Create warehouse request payload.",
+      "required": ["displayName"],
+      "properties": {
+        "displayName": {
+          "description": "The warehouse display name. The display name must follow naming rules according to item type.",
+          "type": "string",
+          "readOnly": false
+        },
+        "description": {
+          "description": "The warehouse description. Maximum length is 256 characters.",
+          "type": "string",
+          "readOnly": false
+        },
+        "creationPayload": {
+            "description": "The warehouse creation payload. Use `creationPayload`. You can't use `definition` or `creationPayload` at the same time.",
+            "$ref": "#/definitions/WarehouseCreationPayload",
+            "readOnly": false
+        }
+      }
+    },
+    "WarehouseCreationPayload": {
+      "description": "Warehouse item payload",
+      "type": "object",
+      "required": [
+        "collationType"
+      ],
+      "properties": {
+        "collationType": {
+          "description": "The default collation type of the warehouse.",
+          "$ref": "#/definitions/CollationType"
+        }
+      }
+    },
+    "UpdateWarehouseDefinitionRequest": {
+      "description": "Update warehouse public definition request payload.",
+      "required": ["definition"],
+      "properties": {
+        "definition": {
+          "$ref": "#/definitions/WarehouseDefinition"
+        }
+      }
+    },
+    "WarehouseDefinitionResponse": {
+      "description": "Warehouse public definition response.",
+      "required": ["definition"],
+      "properties": {
+        "definition": {
+          "$ref": "#/definitions/WarehouseDefinition",
+          "readOnly": true
+        }
+      }
+    },
+    "WarehouseDefinition": {
+      "description": "Warehouse public definition object.",
+      "type": "object",
+      "required": ["parts"],
+      "properties": {
+        "format": {
+          "description": "The format of the item definition.",
+          "type": "string",
+          "readOnly": false
+        },
+        "parts": {
+          "description": "A list of definition parts.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/WarehouseDefinitionPart"
+          },
+          "readOnly": false
+        }
+      }
+    },
+    "WarehouseDefinitionPart": {
+      "description": "Warehouse definition part object.",
+      "type": "object",
+      "properties": {
+        "path": {
+          "description": "The warehouse part path.",
+          "type": "string",
+          "readOnly": false
+        },
+        "payload": {
+          "description": "The warehouse part payload.",
+          "type": "string",
+          "readOnly": false
+        },
+        "payloadType": {
+          "description": "The payload type.",
+          "$ref": "../common/definitions.json#/definitions/PayloadType",
+          "readOnly": false
+        }
+      }
+    },
+    "UpdateWarehouseRequest": {
+      "description": "Update warehouse request.",
+      "properties": {
+        "displayName": {
+          "description": "The warehouse display name. The display name must follow naming rules according to item type.",
+          "type": "string",
+          "readOnly": false
+        },
+        "description": {
+          "description": "The warehouse description. Maximum length is 256 characters.",
+          "type": "string",
+          "readOnly": false
+        }
+      }
+    }
+  }
+}
@@ -0,0 +1,27 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+        "createWarehouseRequest": {
+            "displayName": "Warehouse 1",
+            "description": "A warehouse description."
+        }
+    },
+    "responses": {
+        "201": {
+            "body": {
+                "displayName": "Warehouse 1",
+                "description": "A warehouse description.",
+                "type": "Warehouse",
+                "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                "id": "5b218778-e7a5-4d73-8187-f10824047715"
+            }
+        },
+        "202": {
+            "headers": {
+                "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
+                "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
+                "Retry-After": 30
+            }
+        }
+    }
+}
@@ -0,0 +1,30 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+        "createWarehouseRequest": {
+            "displayName": "Warehouse 1",
+            "description": "A warehouse description.",
+            "creationPayload": {
+                "collationType": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
+            }
+        }
+    },
+    "responses": {
+        "201": {
+            "body": {
+                "displayName": "Warehouse 1",
+                "description": "A warehouse description.",
+                "type": "Warehouse",
+                "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                "id": "5b218778-e7a5-4d73-8187-f10824047715"
+            }
+        },
+        "202": {
+            "headers": {
+                "Location": "https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6",
+                "x-ms-operation-id": "0acd697c-1550-43cd-b998-91bfbfbd47c6",
+                "Retry-After": 30
+            }
+        }
+    }
+}
@@ -0,0 +1,9 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+        "warehouseId": "5b218778-e7a5-4d73-8187-f10824047715"
+    },
+    "responses": {
+        "200": {}
+    }
+}
@@ -0,0 +1,23 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+        "warehouseId": "5b218778-e7a5-4d73-8187-f10824047715"
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "displayName": "Warehouse 1",
+                "description": "A warehouse description.",
+                "type": "Warehouse",
+                "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                "id": "5b218778-e7a5-4d73-8187-f10824047715",
+                "properties": {
+                    "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
+                    "createdDate": "2023-09-28T22:52:13.78",
+                    "lastUpdatedTime": "2023-10-04T22:56:33.283",
+                    "collationType": "Latin1_General_100_BIN2_UTF8"
+                }
+            }
+        }
+    }
+}
@@ -0,0 +1,39 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "value": [
+                    {
+                        "id": "3546052c-ae64-4526-b1a8-52af7761426f",
+                        "displayName": "Warehouse Name 1",
+                        "description": "A warehouse description.",
+                        "type": "Warehouse",
+                        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                        "properties": {
+                            "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
+                            "createdDate": "2023-09-28T22:52:13.78",
+                            "lastUpdatedTime": "2023-10-04T22:56:33.283",
+                            "collationType": "Latin1_General_100_CI_AS_KS_WS_SC_UTF8"
+                        }
+                    },
+                    {
+                        "id": "6281bf94-81b9-46b2-b8d3-79bb868fc822",
+                        "displayName": "Warehouse Name 2",
+                        "description": "A warehouse description.",
+                        "type": "Warehouse",
+                        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                        "properties": {
+                            "connectionString": "qvrmbuxie7we7glrekxgy6npqu-6xgyei3x2xiejip4iime6knh5m.datawarehouse.fabric.microsoft.com",
+                            "createdDate": "2023-11-21T13:14:30.54",
+                            "lastUpdatedTime": "2023-12-04T20:03:43.110",
+                            "collationType": "Latin1_General_100_BIN2_UTF8"
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}
@@ -0,0 +1,27 @@
+{
+    "parameters": {
+        "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+        "warehouseId": "5b218778-e7a5-4d73-8187-f10824047715",
+        "updateWarehouseRequest": {
+            "displayName": "Warehouse's New name",
+            "description": "A new description for warehouse."
+        }
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "displayName": "Warehouse's New name",
+                "description": "A new description for warehouse.",
+                "type": "Warehouse",
+                "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
+                "id": "5b218778-e7a5-4d73-8187-f10824047715",
+                "properties": {
+                    "connectionString": "x6eps4xrq2xudenlfv6naeo3i4-ro6aurrmwwpujdbmljjuqvyisi.msit-datawarehouse.fabric.microsoft.com",
+                    "createdDate": "2025-03-04T18:20:39.5261099",
+                    "lastUpdatedTime": "2025-03-05T17:23:03.3485446",
+                    "collationType": "Latin1_General_100_BIN2_UTF8"
+                }
+            }
+        }
+    }
+}
@@ -0,0 +1,298 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Warehouse REST APIs",
+    "version": "v1"
+  },
+  "schemes": [
+    "https"
+  ],
+  "host": "api.fabric.microsoft.com",
+  "basePath": "/v1",
+  "paths": {
+    "/workspaces/{workspaceId}/warehouses": {
+      "get": {
+        "summary": "Returns a list of warehouses from the specified workspace.",
+        "description": "This API supports [pagination](/rest/api/fabric/articles/pagination).\n\n## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\nWorkspace.Read.All or Workspace.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) | Yes |\n\n## Interface",
+        "tags": [
+          "Items"
+        ],
+        "operationId": "Items_ListWarehouses",
+        "x-ms-pageable": {
+          "nextLinkName": "continuationUri"
+        },
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "workspaceId",
+            "description": "The workspace ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "query",
+            "name": "continuationToken",
+            "description": "A token for retrieving the next page of results.",
+            "type": "string",
+            "required": false
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request completed successfully.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/Warehouses"
+            }
+          },
+          "default": {
+            "description": "Common error codes:\n\n* InvalidItemType - Invalid item type.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "List warehouses in workspace example": {
+            "$ref": "./examples/ListWarehousesInWorkspace.json"
+          }
+        }
+      },
+      "post": {
+        "summary": "Creates a warehouse in the specified workspace.",
+        "description": "This API supports [long running operations (LRO)](/rest/api/fabric/articles/long-running-operation).\n\n This API does not support create a warehouse with definition. \n\n ## Permissions \n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Warehouse.ReadWrite.All or Item.ReadWrite.All \n\n## Limitations \n- To create a warehouse 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) | Yes |\n\n## Interface",
+        "tags": [
+          "Items"
+        ],
+        "operationId": "Items_CreateWarehouse",
+        "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": "body",
+            "name": "createWarehouseRequest",
+            "description": "Create item request payload.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/CreateWarehouseRequest"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "201": {
+            "description": "Successfully created",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/Warehouse"
+            }
+          },
+          "202": {
+            "description": "Request accepted, warehouse provisioning 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."
+              }
+            }
+          },
+          "default": {
+            "description": "Common error codes:\n\n* InvalidItemType - Item type is invalid.\n\n* ItemDisplayNameAlreadyInUse - Item display name is already used.\n\n* CorruptedPayload - The provided payload is corrupted.\n\n* WorkspaceItemsLimitExceeded - Workspace item limit exceeded.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Create a warehouse example": {
+            "$ref": "./examples/CreateWarehouse.json"
+          },
+          "Create a warehouse example with payload": {
+            "$ref": "./examples/CreateWarehouseWithCreationPayload.json"
+          }
+        }
+      }
+    },
+    "/workspaces/{workspaceId}/warehouses/{warehouseId}": {
+      "get": {
+        "summary": "Returns properties of the specified warehouse.",
+        "description": "## Permissions\n\n The caller must have *viewer* or higher workspace role. \n\n## Required Delegated Scopes\n\n Warehouse.Read.All or Warehouse.ReadWrite.All or 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) | Yes |\n\n## Interface",
+        "tags": [
+          "Items"
+        ],
+        "operationId": "Items_GetWarehouse",
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "workspaceId",
+            "description": "The workspace ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "warehouseId",
+            "description": "The warehouse ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request completed successfully.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/Warehouse"
+            }
+          },
+          "default": {
+            "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Get a warehouse example": {
+            "$ref": "./examples/GetWarehouse.json"
+          }
+        }
+      },
+      "patch": {
+        "summary": "Updates the properties of the specified warehouse.",
+        "description": "## Permissions\n\n The caller must have *contributor* or higher workspce role.\n\n## Required Delegated Scopes\n\n Warehouse.ReadWrite.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) | Yes |\n\n## Interface",
+        "tags": [
+          "Items"
+        ],
+        "operationId": "Items_UpdateWarehouse",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "workspaceId",
+            "description": "The workspace ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "warehouseId",
+            "description": "The warehouse ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "body",
+            "name": "updateWarehouseRequest",
+            "description": "Update warehouse request payload.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/UpdateWarehouseRequest"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request completed successfully.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/Warehouse"
+            }
+          },
+          "default": {
+            "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found. \n\n* InvalidRequest - Invalid update request.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Update a warehouse example": {
+            "$ref": "./examples/UpdateWarehouse.json"
+          }
+        }
+      },
+      "delete": {
+        "summary": "Deletes the specified warehouse.",
+        "description": "## Permissions\n\n The caller must have *contributor* or higher workspace role. \n\n## Required Delegated Scopes\n\n Warehouse.ReadWrite.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) | Yes |\n\n## Interface",
+        "tags": [
+          "Items"
+        ],
+        "operationId": "Items_DeleteWarehouse",
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "workspaceId",
+            "description": "The workspace ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "warehouseId",
+            "description": "The warehouse ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request completed successfully."
+          },
+          "default": {
+            "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Delete a warehouse example": {
+            "$ref": "./examples/DeleteWarehouse.json"
+          }
+        }
+      }
+    }
+  },
+  "responses": {},
+  "security": [],
+  "tags": []
+}
@@ -0,0 +1,23 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "v1",
+    "title": "Workload Control API data types"
+  },
+  "paths": {},
+  "definitions": {
+    "ResolveItemPermissionsResponse": {
+      "type": "object",
+      "description": "Resolve item permissions response",
+      "properties": {
+        "permissions": {
+          "type": "array",
+          "description": "Item permissions",
+          "items": {
+            "$ref": "../common/definitions.json#/definitions/ItemPermissions"
+          }
+        }
+      }
+    }
+  }
+}
@@ -0,0 +1,16 @@
+{
+    "parameters": {
+        "workspaceId": "e5ef604d-e14f-4a59-9133-75d5a0cb9334",
+        "itemId": "b14cb7e7-d346-4751-9cfd-8c2767d53111"
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "permissions": [
+                    "Read",
+                    "Reshare"
+                ]
+            }
+        }
+    }
+}
@@ -0,0 +1 @@
+iltriext
@@ -0,0 +1,63 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Workload Control REST APIs",
+    "description": "Microsoft Fabric APIs for workload implementers.",
+    "version": "v1"
+  },
+  "schemes": [ "https" ],
+  "host": "api.fabric.microsoft.com",
+  "basePath": "/v1/workload-control",
+  "definitions": { },
+  "paths": {
+    "/workspaces/{workspaceId}/items/{itemId}/resolvePermissions": {
+      "get": {
+        "summary": "> [!NOTE]\n> This API is in preview.\n\nReturns permissions, the authenticated principal has for the item.",
+        "description": "This API requires SubjectAndApp authentication.\n\n## Permissions\nThe calling workload should be the owner of the item type. The subject principal does not need special permissions.\n\n## Interface",
+        "operationId": "WorkloadControl_ResolveItemPermissions",
+        "tags": [ "WorkloadControl" ],
+        "produces": [ "application/json" ],
+        "parameters": [
+          {
+            "in": "path",
+            "name": "workspaceId",
+            "description": "The workspace ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "itemId",
+            "description": "The item ID.",
+            "type": "string",
+            "format": "uuid",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Request completed successfully.",
+            "schema": {
+              "$ref": "./definitions.json#/definitions/ResolveItemPermissionsResponse"
+            }
+          },
+          "default": {
+            "description": "Common error codes:\n\n* ItemNotFound - The requested item was not found.",
+            "schema": {
+              "$ref": "../common/definitions.json#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "Resolve item permissions example": {
+            "$ref": "./examples/ResolveItemPermissions.json"
+          }
+        }
+      }
+    }
+  },
+  "responses": {},
+  "security": [],
+  "tags": []
+}