swagger: '2.0'
info:
  description: Configuration for ns.conf file upgrade history on NetScaler resource.
  version: 'v2'
  title: ns_conf_upgrade_history
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_conf_upgrade_history
    description: ns.conf file upgrade history on NetScaler
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: ns_ip_address
   in: path
   type: string
   description: NetScaler IP Address
   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/ns_conf_upgrade_history:
    get:
      tags:
        - ns_conf_upgrade_history
      summary: GET all ns_conf_upgrade_history
      operationId: getall_ns_conf_upgrade_history
      description: Use this operation to get ns.conf file upgrade history
      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 ns_conf_upgrade_history 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 ns_conf_upgrade_history 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 ns_conf_upgrade_history resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_conf_upgrade_history
          schema: 
              $ref: '#/definitions/getns_conf_upgrade_historysResponse'
        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/ns_conf_upgrade_history/{ns_ip_address}:
    get:
      tags:
        - ns_conf_upgrade_history
      summary: GET by key for ns_conf_upgrade_history
      operationId: getbykey_ns_conf_upgrade_history
      description: Use this operation to get ns.conf file upgrade history
      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 ns_conf_upgrade_history
          schema: 
              $ref: '#/definitions/getns_conf_upgrade_historyResponse'
        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:
  getns_conf_upgrade_historyResponse:
    type: object
    required:
      - ns_conf_upgrade_history
    properties:
      ns_conf_upgrade_history:
        $ref: '#/definitions/ns_conf_upgrade_history'
    title: getns_conf_upgrade_historyResponse
    example:
      ns_conf_upgrade_history:
        ns_conf_upgradefile: "Configuration Release -11.1-61.7( Mon 10 Jun 06:27:24 2019 )"
        ns_ip_address: "1.1.1.1"

  getns_conf_upgrade_historysResponse:
    type: object
    required:
      - ns_conf_upgrade_history
    properties:
      ns_conf_upgrade_history:
        type: array
        items:
          $ref: '#/definitions/ns_conf_upgrade_history'
    title: getns_conf_upgrade_historysResponse
    example:
      ns_conf_upgrade_history:
        ns_conf_upgradefile: "Configuration Release -11.1-61.7( Mon 10 Jun 06:27:24 2019 )"
        ns_ip_address: "1.1.1.1"


  ns_conf_upgrade_history:
    allOf:
      -
        properties:
          ns_ip_address:
            description: NetScaler IP Address
            type: string
            format: ipaddress
          ns_conf_upgradefile:
             description: "ns.conf upgrade history file"
             type: string
             format: string

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