@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Azure Data Lake Storage REST API
@version 2019-10-31
@endpoints 12
@toc root(1), {filesystem}(11)

@group root
@endpoint GET /
@required {resource: any}
@optional {prefix: any, continuation: any, maxResults: any, x-ms-client-request-id: any, timeout: any, x-ms-date: any, x-ms-version: any}
@returns(200)

@endgroup

@group {filesystem}
@endpoint PUT /{filesystem}
@optional {x-ms-properties: any}
@returns(201)

@endpoint PATCH /{filesystem}
@optional {x-ms-properties: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint GET /{filesystem}
@required {recursive: any}
@optional {directory: any, continuation: any, maxResults: any, upn: any}
@returns(200)

@endpoint HEAD /{filesystem}
@returns(200)

@endpoint DELETE /{filesystem}
@optional {If-Modified-Since: any, If-Unmodified-Since: any}
@returns(202)

@endpoint PUT /{filesystem}/{path}
@optional {resource: any, continuation: any, mode: any, Cache-Control: any, Content-Encoding: any, Content-Language: any, Content-Disposition: any, x-ms-cache-control: any, x-ms-content-type: any, x-ms-content-encoding: any, x-ms-content-language: any, x-ms-content-disposition: any, x-ms-rename-source: any, x-ms-lease-id: any, x-ms-source-lease-id: any, x-ms-properties: any, x-ms-permissions: any, x-ms-umask: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any, x-ms-source-if-match: any, x-ms-source-if-none-match: any, x-ms-source-if-modified-since: any, x-ms-source-if-unmodified-since: any}
@returns(201)

@endpoint PATCH /{filesystem}/{path}
@required {action: any}
@optional {position: any, retainUncommittedData: any, close: any, Content-Length: any, Content-MD5: any, x-ms-lease-id: any, x-ms-cache-control: any, x-ms-content-type: any, x-ms-content-disposition: any, x-ms-content-encoding: any, x-ms-content-language: any, x-ms-content-md5: any, x-ms-properties: any, x-ms-owner: any, x-ms-group: any, x-ms-permissions: any, x-ms-acl: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any, requestBody: map}
@returns(200)
@returns(202)

@endpoint POST /{filesystem}/{path}
@required {x-ms-lease-action: any}
@optional {x-ms-lease-duration: any, x-ms-lease-break-period: any, x-ms-lease-id: any, x-ms-proposed-lease-id: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)
@returns(201)
@returns(202)

@endpoint GET /{filesystem}/{path}
@optional {Range: any, x-ms-lease-id: any, x-ms-range-get-content-md5: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)
@returns(206)

@endpoint HEAD /{filesystem}/{path}
@optional {action: any, upn: any, fsAction: any, x-ms-lease-id: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endpoint DELETE /{filesystem}/{path}
@optional {recursive: any, continuation: any, x-ms-lease-id: any, If-Match: any, If-None-Match: any, If-Modified-Since: any, If-Unmodified-Since: any}
@returns(200)

@endgroup

@end
