swagger: '2.0'
info:
  description: Configuration for HA Pair info resource.
  version: 'v2'
  title: ha_info
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ha_info
    description: HA Pair info
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
   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/ha_info:
    get:
      tags:
        - ha_info
      summary: GET all ha_info
      operationId: getall_ha_info
      description: Use this operation to get HA deployment 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 ha_info 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 ha_info 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 ha_info resources.
          enum:
            - yes
      responses:
        200:
          description:  for ha_info
          schema: 
              $ref: '#/definitions/getha_infosResponse'
        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'

    post:
      tags:
        - ha_info
      summary: POST operation for ha_info
      operationId: post_ha_info
      description: POST operation for ha_info
      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: onerror
          description: Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
          required: false
          type: string
          default: CONTINUE
          enum:
            - EXIT
            - CONTINUE
        - in: body
          name: ha_info
          description: ha_info object
          schema:
              $ref: '#/definitions/addha_infoRequest'
      responses:
        200:
          description: add for ha_info
          schema: 
              $ref: '#/definitions/addha_infoResponse'
        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/ha_info/{id}:
    get:
      tags:
        - ha_info
      summary: GET by key for ha_info
      operationId: getbykey_ha_info
      description: Use this operation to get HA deployment 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: add for ha_info
          schema: 
              $ref: '#/definitions/getha_infoResponse'
        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'

    post:
      tags:
        - ha_info
      summary: POST operation with actions for ha_info
      operationId: post_ha_info_actions
      description: POST operation with actions for ha_info
      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: query
          name: action
          type: string
          required: true
          enum: [force_failover,sync_secondary]
          description: >
            actions:
              * `force_failover` - Use this operation to perform force failover for NetScaler Console HA
              * `sync_secondary` - Use this operation to synchronize secondary node for NetScaler Console HA

        - in: body
          name: ha_info
          description: ha_info object
          schema:
              $ref: '#/definitions/addha_infoRequest'
      responses:
        200:
          description: sync_secondary for ha_info
          schema: 
              $ref: '#/definitions/addha_infoResponse'
        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:
        - ha_info
      summary: PUT for ha_info
      operationId: putbykey_ha_info
      description: Use this operation to modify HA deployment 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: ha_info
          description: ha_info object
          schema:
              $ref: '#/definitions/modifyha_infoRequest'
      responses:
        200:
          description: sync_secondary for ha_info
          schema: 
              $ref: '#/definitions/modifyha_infoResponse'
        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:
        - ha_info
      summary: Delete for ha_info
      operationId: deletebykey_ha_info
      description: Use this operation to delete HA deployment 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:
        204:
          description: sync_secondary for ha_info
        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:
  addha_infoRequest:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        $ref: '#/definitions/ha_info_readwrite'
    title: addha_infoRequest
    example:
      ha_info:
        vip: "string_value"

  addha_infoResponse:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        $ref: '#/definitions/ha_info'
    title: addha_infoResponse
    example:
      ha_info:
        vip: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getha_infoResponse:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        $ref: '#/definitions/ha_info'
    title: getha_infoResponse
    example:
      ha_info:
        vip: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  getha_infosResponse:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        type: array
        items:
          $ref: '#/definitions/ha_info'
    title: getha_infosResponse
    example:
      ha_info:
        vip: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  modifyha_infoRequest:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        $ref: '#/definitions/ha_info_readwrite'
    title: modifyha_infoRequest
    example:
      ha_info:
        vip: "string_value"

  modifyha_infoResponse:
    type: object
    required:
      - ha_info
    properties:
      ha_info:
        $ref: '#/definitions/ha_info'
    title: modifyha_infoResponse
    example:
      ha_info:
        vip: "string_value"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"

  ha_info_readwrite:
    type: object
    properties:
      vip:
        description: "vip."
        type: string
        format: string

  ha_info:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: string
      - $ref: '#/definitions/ha_info_readwrite'

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