swagger: '2.0'
info:
  description: Configuration for NetScaler Version Information resource.
  version: 'v2'
  title: ns_version
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_version
    description: NetScaler Version Information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: ip_address
   in: path
   type: string
   description: NetScaler IP Address for callhome
   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_version:
    get:
      tags:
        - ns_version
      summary: GET all ns_version
      operationId: getall_ns_version
      description: Use this operation to get Version 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 ns_version 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_version 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_version resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_version
          schema: 
              $ref: '#/definitions/getns_versionsResponse'
        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_version/{ip_address}:
    get:
      tags:
        - ns_version
      summary: GET by key for ns_version
      operationId: getbykey_ns_version
      description: Use this operation to get Version 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 ns_version
          schema: 
              $ref: '#/definitions/getns_versionResponse'
        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_versionResponse:
    type: object
    required:
      - ns_version
    properties:
      ns_version:
        $ref: '#/definitions/ns_version'
    title: getns_versionResponse
    example:
      ns_version:
        version: "NetScaler NS12.1: Build 54.13.nc"
        ip_address: "1.1.1.1"

  getns_versionsResponse:
    type: object
    required:
      - ns_version
    properties:
      ns_version:
        type: array
        items:
          $ref: '#/definitions/ns_version'
    title: getns_versionsResponse
    example:
      ns_version:
        version: "NetScaler NS12.1: Build 54.13.nc"
        ip_address: "1.1.1.1"

  ns_version_readwrite:
    type: object
    properties:
      version:
        description: "The contact person's E-mail address"
        type: string
        format: string
        maxLength: 78

  ns_version:
    allOf:
      -
        properties:
          ip_address:
            description: NetScaler IP Address for callhome
            type: string
            format: ipaddress
      - $ref: '#/definitions/ns_version_readwrite'

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