From 2a6c6d67ae120331febadc2debecd75a6d3de6de Mon Sep 17 00:00:00 2001 From: seanmcc-msft Date: Fri, 27 Sep 2019 11:51:33 -0700 Subject: [PATCH] Updated DataLake swagger --- .../stable/2018-11-09/DataLakeStorage.json | 2292 +++++++++-------- 1 file changed, 1286 insertions(+), 1006 deletions(-) diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json index 62bed5b267ac..16df89d8c00e 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json @@ -6,173 +6,36 @@ "version": "2018-11-09", "x-ms-code-generation-settings": { "internalConstructors": true, - "name": "DataLakeStorageClient" + "name": "DataLakeStorageClient", + "header": "MIT", + "strictSpecAdherence": false } }, "x-ms-parameterized-host": { - "hostTemplate": "{accountName}.{dnsSuffix}", + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", "parameters": [ { - "$ref": "#/parameters/accountName" - }, - { - "$ref": "#/parameters/dnsSuffix" + "$ref": "#/parameters/Url" } ] }, "schemes": [ - "http", "https" ], - "produces": [ + "consumes": [ "application/json" ], - "tags": [ - { - "name": "Account Operations" - }, - { - "name": "Filesystem Operations" - }, - { - "name": "File and Directory Operations" - } + "produces": [ + "application/json" ], - "parameters": { - "Version": { - "description": "Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.", - "in": "header", - "name": "x-ms-version", - "required": false, - "type": "string", - "x-ms-parameter-location": "client" - }, - "accountName": { - "description": "The Azure Storage account name.", - "in": "path", - "name": "accountName", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - }, - "dnsSuffix": { - "default": "dfs.core.windows.net", - "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", - "in": "path", - "name": "dnsSuffix", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - }, - "definitions": { - "DataLakeStorageError": { - "properties": { - "error": { - "description": "The service error response object.", - "properties": { - "code": { - "description": "The service error code.", - "type": "string" - }, - "message": { - "description": "The service error message.", - "type": "string" - } - } - } - } - }, - "Path": { - "properties": { - "name": { - "type": "string" - }, - "isDirectory": { - "default": false, - "type": "boolean" - }, - "lastModified": { - "type": "string" - }, - "eTag": { - "type": "string" - }, - "contentLength": { - "type": "integer", - "format": "int64" - }, - "owner": { - "type": "string" - }, - "group": { - "type": "string" - }, - "permissions": { - "type": "string" - } - } - }, - "PathList": { - "properties": { - "paths": { - "type": "array", - "items": { - "$ref": "#/definitions/Path" - } - } - } - }, - "Filesystem": { - "properties": { - "name": { - "type": "string" - }, - "lastModified": { - "type": "string" - }, - "eTag": { - "type": "string" - } - } - }, - "FilesystemList": { - "properties": { - "filesystems": { - "type": "array", - "items": { - "$ref": "#/definitions/Filesystem" - } - } - } - } - }, - "responses": { - "ErrorResponse": { - "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specified resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", - "headers": { - "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/DataLakeStorageError" - } - } - }, - "paths": { + "paths": {}, + "x-ms-paths": { "/": { "get": { - "operationId": "Filesystem_List", - "summary": "List Filesystems", + "operationId": "Service_ListFileSystems", + "summary": "List FileSystems", "description": "List filesystems and their properties in given account.", "x-ms-pageable": { "itemName": "filesystems", @@ -181,24 +44,62 @@ "tags": [ "Account Operations" ], + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "The value must be \"account\" for all account operations.", + "required": true, + "type": "string", + "enum": [ + "account" + ], + "x-ms-enum": { + "name": "AccountResourceType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], "responses": { "200": { "description": "OK", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-continuation": { + "x-ms-client-name": "Continuation", "description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", "type": "string" }, @@ -212,285 +113,151 @@ } }, "default": { - "$ref": "#/responses/ErrorResponse" - } - }, - "parameters": [ - { - "name": "resource", - "in": "query", - "description": "The value must be \"account\" for all account operations.", - "required": true, - "type": "string", - "enum": [ - "account" - ], - "x-ms-enum": { - "name": "AccountResourceType", - "modelAsString": false + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" } - }, - { - "name": "prefix", - "in": "query", - "description": "Filters results to filesystems within the specified prefix.", - "required": false, - "type": "string" - }, - { - "name": "continuation", - "in": "query", - "description": "The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", - "required": false, - "type": "string" - }, - { - "name": "maxResults", - "in": "query", - "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer" - }, - { - "name": "x-ms-client-request-id", - "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", - "in": "header", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string", - "x-ms-client-request-id": true - }, - { - "name": "timeout", - "in": "query", - "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer" - }, - { - "name": "x-ms-date", - "in": "header", - "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/Version" } - ] + } } }, "/{filesystem}": { "put": { - "operationId": "Filesystem_Create", - "summary": "Create Filesystem", + "operationId": "FileSystem_Create", + "summary": "Create FileSystem", "description": "Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.", "tags": [ "Filesystem Operations" ], + "parameters": [ + { + "$ref": "#/parameters/Properties" + } + ], "responses": { "201": { "description": "Created", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the filesystem.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "ClientRequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-namespace-enabled": { - "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "x-ms-client-name": "NamespaceEnabled", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" - } - }, - "parameters": [ - { - "name": "x-ms-properties", - "description": "User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "in": "header", - "required": false, - "type": "string" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } - ] + } }, "patch": { - "operationId": "Filesystem_SetProperties", - "summary": "Set Filesystem Properties", + "operationId": "FileSystem_SetProperties", + "summary": "Set FileSystem Properties", "description": "Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", "tags": [ "Filesystem Operations" ], + "parameters": [ + { + "$ref": "#/parameters/Properties" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ], "responses": { "200": { "description": "Ok", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" - } - }, - "parameters": [ - { - "name": "x-ms-properties", - "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", - "in": "header", - "required": false, - "type": "string" - }, - { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" - }, - { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } - ] - }, - "get": { - "operationId": "Path_List", - "summary": "List Paths", - "description": "List filesystem paths and their properties.", - "x-ms-pageable": { - "itemName": "paths", - "nextLinkName": null - }, - "tags": [ - "Filesystem Operations" - ], - "responses": { - "200": { - "description": "Ok", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" - }, - "ETag": { - "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", - "type": "string" - }, - "Last-Modified": { - "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", - "type": "string" - }, - "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", - "type": "string" - }, - "x-ms-continuation": { - "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", - "type": "string" - } - }, - "schema": { - "$ref": "#/definitions/PathList" - } - }, - "default": { - "$ref": "#/responses/ErrorResponse" - } - }, - "parameters": [ - { - "name": "directory", - "in": "query", - "description": "Filters results to paths within the specified directory. An error occurs if the directory does not exist.", - "required": false, - "type": "string" - }, - { - "name": "recursive", - "in": "query", - "description": "If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If \"directory\" is specified, the list will only include paths that share the same root.", - "required": true, - "type": "boolean" - }, - { - "name": "continuation", - "in": "query", - "description": "The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", - "required": false, - "type": "string" - }, - { - "name": "maxResults", - "in": "query", - "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer" - }, - { - "name": "upn", - "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", - "required": false, - "type": "boolean" - } - ] + } }, "head": { - "operationId": "Filesystem_GetProperties", - "summary": "Get Filesystem Properties.", + "operationId": "FileSystem_GetProperties", + "summary": "Get FileSystem Properties.", "description": "All system and user-defined filesystem properties are specified in the response headers.", "tags": [ "Filesystem Operations" @@ -501,43 +268,59 @@ "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-properties": { + "x-ms-client-name": "Properties", "description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-namespace-enabled": { - "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "x-ms-client-name": "NamespaceEnabled", + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem.", "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } } }, "delete": { - "operationId": "Filesystem_Delete", - "summary": "Delete Filesystem", + "operationId": "FileSystem_Delete", + "summary": "Delete FileSystem", "description": "Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", "tags": [ "Filesystem Operations" @@ -547,52 +330,46 @@ "description": "Accepted", "headers": { "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" } } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } }, "parameters": [ { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" } ] }, "parameters": [ - { - "name": "filesystem", - "in": "path", - "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.", - "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", - "minLength": 3, - "maxLength": 63, - "required": true, - "type": "string" - }, { "name": "resource", "in": "query", @@ -608,86 +385,136 @@ } }, { - "name": "x-ms-client-request-id", - "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", - "in": "header", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string", - "x-ms-client-request-id": true - }, - { - "name": "timeout", - "in": "query", - "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer" + "$ref": "#/parameters/ClientRequestId" }, { - "name": "x-ms-date", - "in": "header", - "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", - "required": false, - "type": "string" + "$ref": "#/parameters/Timeout" }, { - "$ref": "#/parameters/Version" + "$ref": "#/parameters/ApiVersionParameter" } ] }, - "/{filesystem}/{path}": { - "put": { - "operationId": "Path_Create", - "summary": "Create File | Create Directory | Rename File | Rename Directory", - "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", - "consumes": [ - "application/octet-stream" - ], + "/{filesystem}?resource=filesystem": { + "get": { + "operationId": "FileSystem_ListPaths", + "summary": "List Paths", + "description": "List filesystem paths and their properties.", + "x-ms-pageable": { + "itemName": "paths", + "nextLinkName": null + }, "tags": [ - "File and Directory Operations" + "Filesystem Operations" + ], + "parameters": [ + { + "$ref": "#/parameters/Continuation" + }, + { + "$ref": "#/parameters/Directory" + }, + { + "$ref": "#/parameters/RecursiveRequired" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Upn" + } ], "responses": { - "201": { - "description": "The file or directory was created.", + "200": { + "description": "Ok", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "format": "etag", "type": "string" }, "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-continuation": { - "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "x-ms-client-name": "Continuation", + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", "type": "string" - }, - "Content-Length": { - "description": "The size of the resource in bytes.", - "type": "integer", - "format": "int64" } + }, + "schema": { + "$ref": "#/definitions/PathList" } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FilesystemResourceType", + "modelAsString": false } }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ] + }, + "/{filesystem}/{path}": { + "put": { + "operationId": "Path_Create", + "summary": "Create File | Create Directory | Rename File | Rename Directory", + "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], "parameters": [ { "name": "resource", @@ -705,16 +532,12 @@ } }, { - "name": "continuation", - "in": "query", - "description": "Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", - "required": false, - "type": "string" + "$ref": "#/parameters/Continuation" }, { "name": "mode", "in": "query", - "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\". ", + "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\".", "required": false, "type": "string", "enum": [ @@ -727,275 +550,129 @@ } }, { - "name": "Cache-Control", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations for \"Read File\" operations.", - "required": false, - "type": "string" - }, - { - "name": "Content-Encoding", - "in": "header", - "description": "Optional. Specifies which content encodings have been applied to the file. This value is returned to the client when the \"Read File\" operation is performed.", - "required": false, - "type": "string" - }, - { - "name": "Content-Language", - "in": "header", - "description": "Optional. Specifies the natural language used by the intended audience for the file.", - "required": false, - "type": "string" - }, - { - "name": "Content-Disposition", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", - "required": false, - "type": "string" - }, - { - "name": "x-ms-cache-control", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/CacheControl" }, { - "name": "x-ms-content-type", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentEncoding" }, { - "name": "x-ms-content-encoding", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentLanguage" }, { - "name": "x-ms-content-language", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentDisposition" }, { - "name": "x-ms-content-disposition", - "in": "header", - "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentType" }, { - "name": "x-ms-rename-source", - "in": "header", - "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "required": false, - "type": "string" + "$ref": "#/parameters/RenameSource" }, { - "name": "x-ms-lease-id", - "in": "header", - "description": "Optional. A lease ID for the path specified in the URI. The path to be overwritten must have an active lease and the lease ID must match.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "x-ms-source-lease-id", - "in": "header", - "description": "Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/SourceLeaseId" }, { - "name": "x-ms-properties", - "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Properties" }, { - "name": "x-ms-permissions", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Permissions" }, { - "name": "x-ms-umask", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Umask" }, { - "name": "If-Match", - "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" }, { - "name": "If-None-Match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfNoneMatch" }, { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" }, { - "name": "x-ms-source-if-match", - "description": "Optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/SourceIfMatch" }, { - "name": "x-ms-source-if-none-match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/SourceIfNoneMatch" }, { - "name": "x-ms-source-if-modified-since", - "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/SourceIfModifiedSince" }, { - "name": "x-ms-source-if-unmodified-since", - "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/SourceIfUnmodifiedSince" } - ] - }, - "patch": { - "operationId": "Path_Update", - "summary": "Append Data | Flush Data | Set Properties | Set Access Control", - "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "consumes": [ - "application/octet-stream", - "text/plain" - ], - "tags": [ - "File and Directory Operations" ], "responses": { - "200": { - "description": "The data was flushed (written) to the file or the properties were set successfully.", + "201": { + "description": "The file or directory was created.", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" - }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", - "type": "string" - }, - "Content-Disposition": { - "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, - "Content-Encoding": { - "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", "type": "string" }, - "Content-Language": { - "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "x-ms-continuation": { + "x-ms-client-name": "Continuation", + "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", "type": "string" }, "Content-Length": { "description": "The size of the resource in bytes.", "type": "integer", "format": "int64" - }, - "Content-Range": { - "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", - "type": "string" - }, - "Content-Type": { - "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", - "type": "string" - }, - "Content-MD5": { - "description": "An MD5 hash of the request content. This header is only returned for \"Flush\" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.", - "type": "string" - }, - "x-ms-properties": { - "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", - "type": "string" - }, - "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", - "type": "string" } } }, - "202": { - "description": "The uploaded data was accepted.", + "default": { + "description": "Failure", "headers": { - "Content-MD5": { - "description": "An MD5 hash of the request content. This header is only returned for \"Append\" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers.", - "type": "string" - }, - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" - }, - "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" - }, - "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", "type": "string" } + }, + "schema": { + "$ref": "#/definitions/StorageError" } - }, - "default": { - "$ref": "#/responses/ErrorResponse" } - }, + } + }, + "patch": { + "operationId": "Path_Update", + "summary": "Append Data | Flush Data | Set Properties | Set Access Control", + "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], "parameters": [ { "name": "action", @@ -1046,236 +723,177 @@ "format": "int64" }, { - "name": "Content-MD5", - "in": "header", - "description": "Optional. An MD5 hash of the request content. This header is valid on \"Append\" and \"Flush\" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file. This header is associated with the request content, and not with the stored content of the file itself.", - "type": "string" - }, - { - "name": "x-ms-lease-id", - "in": "header", - "description": "The lease ID must be specified if there is an active lease.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentMD5" }, { - "name": "x-ms-cache-control", - "in": "header", - "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "x-ms-content-type", - "in": "header", - "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/CacheControl" }, { - "name": "x-ms-content-disposition", - "in": "header", - "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentType" }, { - "name": "x-ms-content-encoding", - "in": "header", - "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentDisposition" }, { - "name": "x-ms-content-language", - "in": "header", - "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentEncoding" }, { - "name": "x-ms-content-md5", - "in": "header", - "description": "Optional and only valid for \"Flush & Set Properties\" operations. The service stores this value and includes it in the \"Content-Md5\" response header for \"Read & Get Properties\" operations. If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to \"Read & Get Properties\" will not return this property unless it is explicitly set on that file again.", - "required": false, - "type": "string" + "$ref": "#/parameters/ContentLanguage" }, { - "name": "x-ms-properties", - "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Properties" }, { - "name": "x-ms-owner", - "description": "Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Owner" }, { - "name": "x-ms-group", - "description": "Optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Group" }, { - "name": "x-ms-permissions", - "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Permissions" }, { - "name": "x-ms-acl", - "description": "Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\". The scope must be \"default\" to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: \"user\" grants rights to the owner or a named user, \"group\" grants rights to the owning group or a named group, \"mask\" restricts rights granted to named users and the members of groups, and \"other\" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type \"mask\" and \"other\". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: \"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx\". Invalid in conjunction with x-ms-permissions.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Acl" }, { - "name": "If-Match", - "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" }, { - "name": "If-None-Match", - "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfNoneMatch" }, { - "name": "If-Modified-Since", - "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" }, { - "name": "requestBody", - "description": "Valid only for append operations. The data to be uploaded and appended to the file.", - "in": "body", - "required": false, - "schema": { - "type": "object", - "format": "file" - } + "$ref": "#/parameters/Body" } - ] - }, - "post": { - "operationId": "Path_Lease", - "summary": "Lease Path", - "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" ], "responses": { "200": { - "description": "The \"renew\", \"change\" or \"release\" action was successful.", + "description": "The data was flushed (written) to the file or the properties were set successfully.", "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { - "description": "An HTTP entity tag associated with the file.", + "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", "type": "string" }, "Last-Modified": { - "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, - "x-ms-request-id": { - "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", "type": "string" }, - "x-ms-version": { - "description": "The version of the REST protocol used to process the request.", + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", "type": "string" }, - "x-ms-lease-id": { - "description": "A successful \"renew\" action returns the lease ID.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", "type": "string" - } - } - }, - "201": { - "description": "A new lease has been created. The \"acquire\" action was successful.", - "headers": { - "Date": { - "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", "type": "string" }, - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", "type": "string" }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Content-MD5": { + "description": "An MD5 hash of the request content. This header is only returned for \"Flush\" operation. This header is returned so that the client can check for message content integrity. This header refers to the content of the request, not actual file content.", + "type": "string" + }, + "x-ms-properties": { + "x-ms-client-name": "Properties", + "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" - }, - "x-ms-lease-id": { - "description": "A successful \"acquire\" action returns the lease ID.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "type": "string" } } }, "202": { - "description": "The \"break\" lease action was successful.", + "description": "The uploaded data was accepted.", "headers": { - "ETag": { - "description": "An HTTP entity tag associated with the file or directory.", + "Content-MD5": { + "description": "An MD5 hash of the request content. This header is only returned for \"Append\" operation. This header is returned so that the client can check for message content integrity. The value of this header is computed by the service; it is not necessarily the same value specified in the request headers.", "type": "string" }, - "Last-Modified": { - "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", - "type": "string" + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" - }, - "x-ms-lease-time": { - "description": "The time remaining in the lease period in seconds.", - "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } - }, + } + }, + "post": { + "operationId": "Path_Lease", + "summary": "Lease Path", + "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], "parameters": [ { "name": "x-ms-lease-action", @@ -1312,76 +930,195 @@ "type": "integer" }, { - "name": "x-ms-lease-id", - "in": "header", - "description": "Required when \"x-ms-lease-action\" is \"renew\", \"change\" or \"release\". For the renew and release actions, this must match the current lease ID.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "x-ms-proposed-lease-id", - "in": "header", - "description": "Required when \"x-ms-lease-action\" is \"acquire\" or \"change\". A lease will be acquired with this lease ID if the operation is successful.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/ProposedLeaseIdOptional" }, { - "name": "If-Match", - "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" }, { - "name": "If-None-Match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfNoneMatch" }, { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" } - ] - }, - "get": { - "operationId": "Path_Read", - "summary": "Read File", - "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "produces": [ - "application/json", - "application/octet-stream", - "text/plain" - ], - "tags": [ - "File and Directory Operations" ], "responses": { "200": { - "description": "Ok", + "description": "The \"renew\", \"change\" or \"release\" action was successful.", "headers": { - "Accept-Ranges": { - "description": "Indicates that the service supports requests for partial file content.", - "type": "string" + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" }, - "Cache-Control": { - "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "ETag": { + "description": "An HTTP entity tag associated with the file.", + "format": "etag", "type": "string" }, - "Content-Disposition": { + "Last-Modified": { + "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "description": "A successful \"renew\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "201": { + "description": "A new lease has been created. The \"acquire\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "description": "A successful \"acquire\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "202": { + "description": "The \"break\" lease action was successful.", + "headers": { + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", + "type": "string" + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "description": "The time remaining in the lease period in seconds.", + "type": "string" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "operationId": "Path_Read", + "summary": "Read File", + "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "parameters": [ + { + "in": "header", + "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "required": false, + "type": "string", + "name": "Range" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "name": "x-ms-range-get-content-md5", + "in": "header", + "description": "Optional. When this header is set to \"true\" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).", + "required": false, + "type": "boolean" + }, + { + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", "type": "string" }, @@ -1412,48 +1149,59 @@ }, "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", "type": "string" }, "x-ms-properties": { + "x-ms-client-name": "Properties", "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string" }, "x-ms-lease-state": { - "description": "Lease state of the resource. ", + "x-ms-client-name": "LeaseState", + "description": "Lease state of the resource.", "type": "string" }, "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", "description": "The lease status of the resource.", "type": "string" } }, "schema": { - "type": "file" + "type": "object", + "format": "file" } }, "206": { @@ -1502,113 +1250,116 @@ }, "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", "type": "string" }, "x-ms-properties": { + "x-ms-client-name": "Properties", "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string" }, "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", "description": "Lease state of the resource. ", "type": "string" }, "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", "description": "The lease status of the resource.", "type": "string" } }, "schema": { - "type": "file" + "type": "object", + "format": "file" } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } - }, + } + }, + "head": { + "operationId": "Path_GetProperties", + "summary": "Get Properties | Get Status | Get Access Control List", + "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], "parameters": [ { - "in": "header", - "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "name": "action", + "in": "query", + "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", "required": false, "type": "string", - "name": "Range" + "enum": [ + "getAccessControl", + "getStatus" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false + } }, { - "name": "x-ms-lease-id", - "in": "header", - "description": "Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/Upn" }, { - "name": "x-ms-range-get-content-md5", - "in": "header", - "description": "Optional. When this header is set to \"true\" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request).", - "required": false, - "type": "boolean" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "If-Match", - "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" }, { - "name": "If-None-Match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfNoneMatch" }, { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" } - ] - }, - "head": { - "operationId": "Path_GetProperties", - "summary": "Get Properties | Get Status | Get Access Control List", - "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" ], "responses": { "200": { @@ -1653,134 +1404,120 @@ }, "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "ETag": { "description": "An HTTP entity tag associated with the file or directory.", + "format": "etag", "type": "string" }, "Last-Modified": { "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "format": "date-time-rfc1123", "type": "string" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-resource-type": { + "x-ms-client-name": "ResourceType", "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", "type": "string" }, "x-ms-properties": { + "x-ms-client-name": "Properties", "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", "type": "string" }, "x-ms-owner": { + "x-ms-client-name": "Owner", "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", "type": "string" }, "x-ms-group": { + "x-ms-client-name": "Group", "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", "type": "string" }, "x-ms-permissions": { + "x-ms-client-name": "Permissions", "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", "type": "string" }, "x-ms-acl": { + "x-ms-client-name": "ACL", "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", "type": "string" }, "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", "type": "string" }, "x-ms-lease-state": { - "description": "Lease state of the resource. ", + "x-ms-client-name": "LeaseState", + "description": "Lease state of the resource.", "type": "string" }, "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", "description": "The lease status of the resource.", "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } - }, + } + }, + "delete": { + "operationId": "Path_Delete", + "summary": "Delete File | Delete Directory", + "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], "parameters": [ { - "name": "action", - "in": "query", - "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", - "required": false, - "type": "string", - "enum": [ - "getAccessControl", - "getStatus" - ], - "x-ms-enum": { - "name": "PathGetPropertiesAction", - "modelAsString": false - } + "$ref": "#/parameters/RecursiveOptional" }, { - "name": "upn", - "in": "query", - "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", - "required": false, - "type": "boolean" + "$ref": "#/parameters/Continuation" }, { - "name": "x-ms-lease-id", - "in": "header", - "description": "Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "If-Match", - "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" }, { - "name": "If-None-Match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfNoneMatch" }, { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfModifiedSince" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfUnmodifiedSince" } - ] - }, - "delete": { - "operationId": "Path_Delete", - "summary": "Delete File | Delete Directory", - "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", - "tags": [ - "File and Directory Operations" ], "responses": { "200": { @@ -1788,127 +1525,670 @@ "headers": { "Date": { "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", - "type": "string" + "type": "string", + "format": "date-time-rfc1123" }, "x-ms-request-id": { + "x-ms-client-name": "RequestId", "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", "type": "string" }, "x-ms-version": { + "x-ms-client-name": "Version", "description": "The version of the REST protocol used to process the request.", "type": "string" }, "x-ms-continuation": { + "x-ms-client-name": "Continuation", "description": "When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", "type": "string" } } }, "default": { - "$ref": "#/responses/ErrorResponse" + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestId" }, - "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ] + }, + "/{filesystem}/{path}?action=setAccessControl": { + "patch": { + "tags": [ + "directory" + ], + "operationId": "Path_SetAccessControl", + "description": "Set the owner, group, permissions, or access control list for a path.", + "parameters": [ { - "name": "recursive", - "in": "query", - "description": "Required and valid only when the resource is a directory. If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs.", - "required": false, - "type": "boolean" + "$ref": "#/parameters/Timeout" }, { - "name": "continuation", - "in": "query", - "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", - "required": false, - "type": "string" + "$ref": "#/parameters/LeaseIdOptional" }, { - "name": "x-ms-lease-id", - "in": "header", - "description": "The lease ID must be specified if there is an active lease.", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string" + "$ref": "#/parameters/Owner" }, { - "name": "If-Match", - "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Group" }, { - "name": "If-None-Match", - "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Permissions" }, { - "name": "If-Modified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/Acl" }, { - "name": "If-Unmodified-Since", - "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", - "in": "header", - "required": false, - "type": "string" + "$ref": "#/parameters/IfMatch" + }, + { + "$ref": "#/parameters/IfNoneMatch" + }, + { + "$ref": "#/parameters/IfModifiedSince" + }, + { + "$ref": "#/parameters/IfUnmodifiedSince" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } - ] + ], + "responses": { + "200": { + "description": "Set directory access control response.", + "headers": { + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "ETag": { + "type": "string", + "format": "etag", + "description": "An HTTP entity tag associated with the file or directory." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "The version of the REST protocol used to process the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } }, "parameters": [ { - "name": "filesystem", - "in": "path", - "description": "The filesystem identifier.", - "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", - "minLength": 3, - "maxLength": 63, + "name": "action", + "in": "query", "required": true, + "type": "string", + "enum": [ + "setAccessControl" + ] + } + ] + } + }, + "parameters": { + "Url": { + "name": "url", + "description": "The URL of the service account, container, or blob that is the targe of the desired operation.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-client-name": "version", + "in": "header", + "required": true, + "type": "string", + "description": "Specifies the version of the operation to use for this request.", + "enum": [ + "2019-02-02" + ] + }, + "accountName": { + "description": "The Azure Storage account name.", + "in": "path", + "name": "accountName", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "dnsSuffix": { + "default": "dfs.core.windows.net", + "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", + "in": "path", + "name": "dnsSuffix", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations." + }, + "IfMatch": { + "name": "If-Match", + "x-ms-client-name": "ifMatch", + "in": "header", + "required": false, + "type": "string", + "format": "etag", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "IfModifiedSince": { + "name": "If-Modified-Since", + "x-ms-client-name": "ifModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "IfNoneMatch": { + "name": "If-None-Match", + "x-ms-client-name": "ifNoneMatch", + "in": "header", + "required": false, + "type": "string", + "format": "etag", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "IfUnmodifiedSince": { + "name": "If-Unmodified-Since", + "x-ms-client-name": "ifUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "RecursiveOptional": { + "name": "recursive", + "x-ms-client-name": "recursive", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Required", + "required": false, + "type": "boolean" + }, + "RecursiveRequired": { + "name": "recursive", + "x-ms-client-name": "recursive", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Required", + "required": true, + "type": "boolean" + }, + "Continuation": { + "name": "continuation", + "x-ms-client-name": "continuation", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + "Directory": { + "name": "directory", + "x-ms-client-name": "Path", + "x-ms-parameter-location": "method", + "in": "query", + "description": "Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.", + "required": false, + "type": "string" + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string" + }, + "MaxResults": { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + "Properties": { + "name": "x-ms-properties", + "x-ms-client-name": "properties", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string" + }, + "SourceIfMatch": { + "name": "x-ms-source-if-match", + "x-ms-client-name": "sourceIfMatch", + "in": "header", + "required": false, + "type": "string", + "format": "etag", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs with a matching value." + }, + "SourceIfModifiedSince": { + "name": "x-ms-source-if-modified-since", + "x-ms-client-name": "sourceIfModifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has been modified since the specified date/time." + }, + "SourceIfNoneMatch": { + "name": "x-ms-source-if-none-match", + "x-ms-client-name": "sourceIfNoneMatch", + "in": "header", + "required": false, + "type": "string", + "format": "etag", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify an ETag value to operate only on blobs without a matching value." + }, + "SourceIfUnmodifiedSince": { + "name": "x-ms-source-if-unmodified-since", + "x-ms-client-name": "sourceIfUnmodifiedSince", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify this header value to operate only on a blob if it has not been modified since the specified date/time." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "A lease ID for the source path. If specified, the source path must have an active lease and the leaase ID must match." + }, + "Filesystem": { + "name": "filesystem", + "in": "path", + "description": "The filesystem identifier.", + "pattern": "^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "minLength": 3, + "maxLength": 63, + "required": true, + "type": "string" + }, + "Path": { + "name": "path", + "in": "path", + "description": "The file or directory path.", + "required": true, + "type": "string" + }, + "CacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "cacheControl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "contentDisposition", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's Content-Disposition header." + }, + "ContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "contentEncoding", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "path-HTTP-headers" + }, + "description": "Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "contentLanguage", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "contentType", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "blob-HTTP-headers" + }, + "description": "Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request." + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "transactionalContentMD5", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the transactional md5 for the body, to be validated by the service." + }, + "Umask": { + "name": "x-ms-umask", + "x-ms-client-name": "umask", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p bitwise and not u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", + "in": "header", + "required": false, + "type": "string" + }, + "Permissions": { + "name": "x-ms-permissions", + "x-ms-client-name": "permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "in": "header", + "required": false, + "type": "string" + }, + "RenameSource": { + "name": "x-ms-rename-source", + "x-ms-client-name": "renameSource", + "in": "header", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set.", + "required": false, + "type": "string" + }, + "Owner": { + "name": "x-ms-owner", + "x-ms-client-name": "owner", + "in": "header", + "required": false, + "type": "string", + "description": "Optional. The owner of the blob or directory.", + "x-ms-parameter-location": "method" + }, + "Group": { + "name": "x-ms-group", + "x-ms-client-name": "group", + "in": "header", + "required": false, + "type": "string", + "description": "Optional. The owning group of the blob or directory.", + "x-ms-parameter-location": "method" + }, + "Acl": { + "name": "x-ms-acl", + "description": "Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries. Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\".", + "x-ms-client-name": "acl", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Body": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method", + "description": "Initial data" + }, + "Upn": { + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names.", + "required": false, + "type": "boolean" + } + }, + "definitions": { + "Path": { + "type": "object", + "properties": { + "name": { "type": "string" }, - { - "name": "path", - "in": "path", - "description": "The file or directory path.", - "required": true, + "isDirectory": { + "default": false, + "type": "boolean" + }, + "lastModified": { "type": "string" }, - { - "name": "x-ms-client-request-id", - "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", - "in": "header", - "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", - "required": false, - "type": "string", - "x-ms-client-request-id": true + "eTag": { + "type": "string" }, - { - "name": "timeout", - "in": "query", - "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", - "format": "int32", - "minimum": 1, - "required": false, - "type": "integer" + "contentLength": { + "type": "integer", + "format": "int64" }, - { - "name": "x-ms-date", - "in": "header", - "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", - "required": false, + "owner": { "type": "string" }, - { - "$ref": "#/parameters/Version" + "group": { + "type": "string" + }, + "permissions": { + "type": "string" } - ] + } + }, + "PathList": { + "type": "object", + "properties": { + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "Filesystem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + } + } + }, + "FilesystemList": { + "type": "object", + "properties": { + "filesystems": { + "type": "array", + "items": { + "$ref": "#/definitions/Filesystem" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "error": { + "type": "object", + "description": "The service error response object.", + "properties": { + "Code": { + "description": "The service error code.", + "type": "string" + }, + "Message": { + "description": "The service error message.", + "type": "string" + } + } + } + } } } }