swagger: '2.0'
info:
  description: Configuration for backup components resource.
  version: 'v2'
  title: backup_component
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: backup_component
    description: backup components
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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_component:
    get:
      tags:
        - backup_component
      summary: GET all backup_component
      operationId: getall_backup_component
      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_component 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_component 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_component resources.
          enum:
            - yes
      responses:
        200:
          description:  for backup_component
          schema: 
              $ref: '#/definitions/getbackup_componentsResponse'
        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_componentResponse:
    type: object
    required:
      - backup_component
    properties:
      backup_component:
        $ref: '#/definitions/backup_component'
    title: getbackup_componentResponse
    example:
      backup_component:
        component_message: "string_value"
        component_versions: "string_value"
        component_minimum_version: "string_value"
        backup_file_name: "string_value"
        component: "string_value"
        component_name: "string_value"
        component_ip: "string_value"
        component_version_bit: "string_value"
        component_hostname: "string_value"
        component_error_severity: "0"

  getbackup_componentsResponse:
    type: object
    required:
      - backup_component
    properties:
      backup_component:
        type: array
        items:
          $ref: '#/definitions/backup_component'
    title: getbackup_componentsResponse
    example:
      backup_component:
        component_message: "string_value"
        component_versions: "string_value"
        component_minimum_version: "string_value"
        backup_file_name: "string_value"
        component: "string_value"
        component_name: "string_value"
        component_ip: "string_value"
        component_version_bit: "string_value"
        component_hostname: "string_value"
        component_error_severity: "0"

  backup_component_readwrite:
    type: object
    properties:
      component_message:
        description: "Information about the componenet"
        type: string
        format: string
      component_versions:
        description: "Backup component version"
        type: string
        format: string
      component_minimum_version:
        description: "Minimum version supported by the NetScaler"
        type: string
        format: string
      backup_file_name:
        description: "Backup file name"
        type: string
        format: string
        maxLength: 64
      component:
        description: "Backup component"
        type: string
        format: string
      component_name:
        description: "Backup component Name"
        type: string
        format: string
      component_ip:
        description: "Backup component IPaddress"
        type: string
        format: string
      component_version_bit:
        description: "(32/64 bit) information for backup component version"
        type: string
        format: string
      component_hostname:
        description: "Backup component VM Name"
        type: string
        format: string
      component_error_severity:
        description: "Severity of error for the component"
        type: integer
        format: int32

  backup_component:
    allOf:
      - $ref: '#/definitions/backup_component_readwrite'

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