swagger: '2.0'
info:
  description: Configuration for NetScaler Interface resource.
  version: 'v2'
  title: ns_interface
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_interface
    description: NetScaler Interface
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
   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_interface:
    get:
      tags:
        - ns_interface
      summary: GET all ns_interface
      operationId: getall_ns_interface
      description: Use this operation to get VM Physical and Virtual Interface list
      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_interface 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_interface 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_interface resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_interface
          schema: 
              $ref: '#/definitions/getns_interfacesResponse'
        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_interface/{ip_address}:
    get:
      tags:
        - ns_interface
      summary: GET by key for ns_interface
      operationId: getbykey_ns_interface
      description: Use this operation to get VM Physical and Virtual Interface list
      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_interface
          schema: 
              $ref: '#/definitions/getns_interfaceResponse'
        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_interfaceResponse:
    type: object
    required:
      - ns_interface
    properties:
      ns_interface:
        $ref: '#/definitions/ns_interface'
    title: getns_interfaceResponse
    example:
      ns_interface:
        is_cluster_node: "false"
        vif_list: ["string_value1","string_value2"]
        pif_list: ["string_value1","string_value2"]
        nodeid: "-1"
        ip_address: "1.1.1.1"

  getns_interfacesResponse:
    type: object
    required:
      - ns_interface
    properties:
      ns_interface:
        type: array
        items:
          $ref: '#/definitions/ns_interface'
    title: getns_interfacesResponse
    example:
      ns_interface:
        is_cluster_node: "false"
        vif_list: ["string_value1","string_value2"]
        pif_list: ["string_value1","string_value2"]
        nodeid: "-1"
        ip_address: "1.1.1.1"

  ns_interface_readwrite:
    type: object
    properties:
      is_cluster_node:
        description: "Is the node is part of cluster or not"
        type: boolean
        format: boolean
      vif_list:
        description: "Virtual Interface List"
        type: array
        items:
          type: string
          format: string
      pif_list:
        description: "Physical Interface List"
        type: array
        items:
          type: string
          format: string
      nodeid:
        description: "Node Id applicable on cluster"
        type: integer
        format: int32

  ns_interface:
    allOf:
      -
        properties:
          ip_address:
            description: NetScaler IP Address
            type: string
            format: ipaddress
      - $ref: '#/definitions/ns_interface_readwrite'

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