swagger: '2.0'
info:
  description: Configuration for Backup file of system resource.
  version: 'v2'
  title: backup_file
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: backup_file
    description: Backup file of system
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: file_name
   in: path
   type: string
   description: File Name
   required: true
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/backup_file:
    get:
      tags:
        - backup_file
      summary: GET all backup_file
      operationId: getall_backup_file
      description: Use this operation to get backup file
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the backup_file resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the backup_file resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of backup_file resources.
          enum:
            - yes
      responses:
        200:
          description:  for backup_file
          schema: 
              $ref: '#/definitions/getbackup_filesResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/config/backup_file/{file_name}:
    get:
      tags:
        - backup_file
      summary: GET by key for backup_file
      operationId: getbykey_backup_file
      description: Use this operation to get backup file
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        200:
          description:  for backup_file
          schema: 
              $ref: '#/definitions/getbackup_fileResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

    delete:
      tags:
        - backup_file
      summary: Delete for backup_file
      operationId: deletebykey_backup_file
      description: Use this operation to delete backup file
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
      responses:
        204:
          description:  for backup_file
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/upload/backup_file:
    post:
      tags:
        - backup_file
      summary: Upload operation for backup_file
      operationId: upload_backup_file
      description: Use this operation to upload  backup file
      consumes:
        - multipart/form-data
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: formData
          name: backup_file
          description: backup_file file
          type: file
          required: true
      responses:
        200:
          description: Successful upload for backup_file
          schema: 
              $ref: '#/definitions/Done'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

  /massvc/{customerid}/nitro/v2/download/backup_file/{file_name}:
    get:
      tags:
        - backup_file
      summary: Download operation for backup_file
      operationId: download_backup_file
      description: Use this operation to download backup file
      consumes:
        - application/json
      produces:
        - attachment
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: path
          name: file_name
          type: string
          required: true
          description: File Name
      responses:
        200:
          description: Successful download for backup_file
          schema: 
              type: file
              format: binary
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getbackup_fileResponse:
    type: object
    required:
      - backup_file
    properties:
      backup_file:
        $ref: '#/definitions/backup_file'
    title: getbackup_fileResponse
    example:
      backup_file:
        encrypted: "false"
        file_location_path: "C:\\myfiles"
        file_size: "8156768"
        external_storage_info: {        parent_name: "string_value"
,        delete_from_svm: "boolean_value"
,        port: "integer_value"
,        parent_id: "string_value"
,        username: "string_value"
,        transfer_protocol: "string_value"
,        password: "string_value"
,        directory_path: "string_value"
,        id: "string_value"
,        server: "string_value"
}
        file_name: "filename"
        file_last_modified: "1579734319"

  getbackup_filesResponse:
    type: object
    required:
      - backup_file
    properties:
      backup_file:
        type: array
        items:
          $ref: '#/definitions/backup_file'
    title: getbackup_filesResponse
    example:
      backup_file:
        encrypted: "false"
        file_location_path: "C:\\myfiles"
        file_size: "8156768"
        external_storage_info: {        parent_name: "string_value"
,        delete_from_svm: "boolean_value"
,        port: "integer_value"
,        parent_id: "string_value"
,        username: "string_value"
,        transfer_protocol: "string_value"
,        password: "string_value"
,        directory_path: "string_value"
,        id: "string_value"
,        server: "string_value"
}
        file_name: "filename"
        file_last_modified: "1579734319"

  backup_file_readwrite:
    type: object
    properties:
      encrypted:
        description: "Encrypted backup files"
        type: boolean
        format: boolean
      file_location_path:
        description: "File Location on Client for upload/download"
        type: string
        format: string
        minLength: 1
      external_storage_info:
        $ref: '#/definitions/backup_external_storage_readwrite'

  backup_file:
    allOf:
      -
        properties:
          file_name:
            description: File Name
            type: string
            format: string
          file_size:
             description: "File Size"
             type: number
             format: int64
          file_last_modified:
             description: "Last Modified"
             type: number
             format: int64
      - $ref: '#/definitions/backup_file_readwrite'

  backup_external_storage_readwrite:
    type: object
    properties:
      parent_name:
        type: string
        format: string
      delete_from_svm:
        description: "Password for backup file encryption"
        type: boolean
        format: boolean
      port:
        description: "External transfer server port"
        type: integer
        format: int32
      parent_id:
        type: string
        format: string
      username:
        description: "Username"
        type: string
        format: string
      transfer_protocol:
        description: "File transfer Protocol: SCP, SFTP or FTP"
        type: string
        format: string
      password:
        description: "Password"
        type: string
        format: password
      directory_path:
        description: "External server directory path where backup file will be uploaded"
        type: string
        format: string
      server:
        description: "External server IP Address/Hostname"
        type: string
        format: string

  backup_external_storage:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key for all backed up files
            type: string
            format: string
      - $ref: '#/definitions/backup_external_storage_readwrite'

  Done:
    properties:
      errorcode:
        type: number
        format: int32
        example: 0
      errormessage:
        type: string
        format: string
        example: "Done"
  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
