Microsoft Azure FileSystem API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector File System API
tags:
- name: FileSystem
paths:
  /WebHdfsExt/{path}:
    put:
      tags:
      - FileSystem
      operationId: microsoftAzureFilesystemSetfileexpiry
      description: Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.
      parameters:
      - name: path
        in: path
        required: true
        description: The Data Lake Store path (starting with '/') of the file on which to set or remove the expiration time.
        schema:
          type: string
      - name: expiryOption
        in: query
        required: true
        x-ms-enum:
          name: ExpiryOptionType
          modelAsString: false
        description: 'Indicates the type of expiration to use for the file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is an integer in milliseconds representing the expiration date relative to when file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an integer in milliseconds representing the expiration date relative to file creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00.'
        schema:
          type: string
          enum:
          - NeverExpire
          - RelativeToNow
          - RelativeToCreationDate
          - Absolute
      - name: expireTime
        in: query
        required: false
        description: The time that the file will expire, corresponding to the ExpiryOption that was set.
        schema:
          type: integer
          format: int64
      - name: op
        in: query
        required: true
        description: The constant value for the operation.
        schema:
          type: string
          enum:
          - SETEXPIRY
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully set the expiration time on the specified file.
        default:
          description: An unexpected error from the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdlsError'
      x-ms-examples:
        ? Sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported
        : $ref: ./examples/FileSystem_SetFileExpiry.json
      summary: Microsoft Azure Put Webhdfsext Path
    post:
      tags:
      - FileSystem
      operationId: microsoftAzureFilesystemConcurrentappend
      description: 'Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.'
      parameters:
      - name: path
        in: path
        required: true
        description: The Data Lake Store path (starting with '/') of the file to which to append using concurrent append.
        schema:
          type: string
      - name: appendMode
        in: query
        required: false
        x-ms-enum:
          name: AppendModeType
          modelAsString: false
        description: Indicates the concurrent append call should create the file if it doesn't exist or just open the existing file for append
        schema:
          type: string
          enum:
          - autocreate
      - name: op
        in: query
        required: true
        description: The constant value for the operation.
        schema:
          type: string
          enum:
          - CONCURRENTAPPEND
      - name: Transfer-Encoding
        in: header
        required: true
        description: Indicates the data being sent to the server is being streamed in chunks.
        schema:
          type: string
          enum:
          - chunked
      - name: syncFlag
        in: query
        required: false
        description: Optionally indicates what to do after completion of the concurrent append. DATA indicates that more data will be sent immediately by the client, the file handle should remain open/locked, and file metadata (including file length, last modified time) should NOT get updated. METADATA indicates that more data will be sent immediately by the client, the file handle should remain open/locked, and file metadata should get updated. CLOSE indicates that the client is done sending data, the file handle should be closed/unlocked, and file metadata should get updated.
        x-ms-enum:
          name: SyncFlag
          modelAsString: false
        schema:
          type: string
          enum:
          - DATA
          - METADATA
          - CLOSE
          default: DATA
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: An unexpected error from the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdlsError'
      x-ms-examples:
        ? 'Appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file'
        : $ref: ./examples/FileSystem_ConcurrentAppend.json
      summary: Microsoft Azure Post Webhdfsext Path
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: object
              format: file
        description: The file contents to include when appending to the file.  The maximum content size is 4MB.  For content larger than 4MB you must append the content in 4MB chunks.
        required: true
  /webhdfs/v1/{path}:
    get:
      tags:
      - FileSystem
      operationId: microsoftAzureFilesystemCheckaccess
      description: Checks if the specified access is available at the given path.
      parameters:
      - name: path
        in: path
        required: true
        description: The Data Lake Store path (starting with '/') of the file or directory for which to check access.
        schema:
          type: string
      - name: fsaction
        in: query
        required: true
        description: File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}'
        schema:
          type: string
      - name: op
        in: query
        required: true
        description: The constant value for the operation.
        schema:
          type: string
          enum:
          - CHECKACCESS
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
        default:
          description: An unexpected error from the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdlsError'
      x-ms-examples:
        Checks if the specified access is available at the given path:
          $ref: ./examples/FileSystem_CheckAccess.json
      summary: Microsoft Azure Get Webhdfs Path
components:
  schemas:
    AdlsError:
      properties:
        remoteException:
          $ref: '#/components/schemas/AdlsRemoteException'
          readOnly: true
          description: the object representing the actual WebHDFS exception being returned.
      description: Data Lake Store filesystem error containing a specific WebHDFS exception.
    AdlsRemoteException:
      discriminator:
        propertyName: exception
      required:
      - exception
      properties:
        exception:
          type: string
          description: the class name of the exception thrown, such as 'IllegalArgumentException'.
        javaClassName:
          type: string
          readOnly: true
          description: the full class package name for the exception thrown, such as 'java.lang.IllegalArgumentException'.
        message:
          type: string
          readOnly: true
          description: the message associated with the exception that was thrown, such as 'Invalid value for webhdfs parameter "permission":...'.
      description: Data Lake Store filesystem exception based on the WebHDFS definition for RemoteExceptions. This is a WebHDFS 'catch all' exception
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'