swagger: '2.0'
info:
  description: Configuration for Backup File External storage resource.
  version: 'v2'
  title: backup_external_storage
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: backup_external_storage
    description: Backup File External storage
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key for all backed up files
   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_external_storage:
    get:
      tags:
        - backup_external_storage
      summary: GET all backup_external_storage
      operationId: getall_backup_external_storage
      description: Use this operation to display external transfer server information
      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_external_storage 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_external_storage 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_external_storage resources.
          enum:
            - yes
      responses:
        200:
          description:  for backup_external_storage
          schema: 
              $ref: '#/definitions/getbackup_external_storagesResponse'
        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_external_storage/{id}:
    get:
      tags:
        - backup_external_storage
      summary: GET by key for backup_external_storage
      operationId: getbykey_backup_external_storage
      description: Use this operation to display external transfer server information
      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_external_storage
          schema: 
              $ref: '#/definitions/getbackup_external_storageResponse'
        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'

    put:
      tags:
        - backup_external_storage
      summary: PUT for backup_external_storage
      operationId: putbykey_backup_external_storage
      description: Use this operation to modify the external transfer server information
      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
        - in: body
          name: backup_external_storage
          description: backup_external_storage object
          schema:
              $ref: '#/definitions/modifybackup_external_storageRequest'
      responses:
        200:
          description:  for backup_external_storage
          schema: 
              $ref: '#/definitions/modifybackup_external_storageResponse'
        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_external_storageResponse:
    type: object
    required:
      - backup_external_storage
    properties:
      backup_external_storage:
        $ref: '#/definitions/backup_external_storage'
    title: getbackup_external_storageResponse
    example:
      backup_external_storage:
        parent_name: "string_value"
        delete_from_svm: "boolean_value"
        port: "0"
        parent_id: "string_value"
        username: "nsroot"
        transfer_protocol: "string_value"
        password: "password"
        directory_path: "string_value"
        id: "2b38ae44-a824-4f51-a155-23ab334gfd"
        server: "1.1.1.1"

  getbackup_external_storagesResponse:
    type: object
    required:
      - backup_external_storage
    properties:
      backup_external_storage:
        type: array
        items:
          $ref: '#/definitions/backup_external_storage'
    title: getbackup_external_storagesResponse
    example:
      backup_external_storage:
        parent_name: "string_value"
        delete_from_svm: "boolean_value"
        port: "0"
        parent_id: "string_value"
        username: "nsroot"
        transfer_protocol: "string_value"
        password: "password"
        directory_path: "string_value"
        id: "2b38ae44-a824-4f51-a155-23ab334gfd"
        server: "1.1.1.1"

  modifybackup_external_storageRequest:
    type: object
    required:
      - backup_external_storage
    properties:
      backup_external_storage:
        $ref: '#/definitions/backup_external_storage_readwrite'
    title: modifybackup_external_storageRequest
    example:
      backup_external_storage:
        parent_name: "string_value"
        delete_from_svm: "boolean_value"
        port: "0"
        parent_id: "string_value"
        username: "nsroot"
        transfer_protocol: "string_value"
        password: "password"
        directory_path: "string_value"
        server: "1.1.1.1"

  modifybackup_external_storageResponse:
    type: object
    required:
      - backup_external_storage
    properties:
      backup_external_storage:
        $ref: '#/definitions/backup_external_storage'
    title: modifybackup_external_storageResponse
    example:
      backup_external_storage:
        parent_name: "string_value"
        delete_from_svm: "boolean_value"
        port: "0"
        parent_id: "string_value"
        username: "nsroot"
        transfer_protocol: "string_value"
        password: "password"
        directory_path: "string_value"
        id: "2b38ae44-a824-4f51-a155-23ab334gfd"
        server: "1.1.1.1"

  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'

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