swagger: '2.0'
info:
  description: Configuration for Virtual server appflow info on NetScaler resource.
  version: 'v2'
  title: adc_vserver_appflow_info
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: adc_vserver_appflow_info
    description: Virtual server appflow info on NetScaler
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/adc_vserver_appflow_info:
    get:
      tags:
        - adc_vserver_appflow_info
      summary: GET all adc_vserver_appflow_info
      operationId: getall_adc_vserver_appflow_info
      description: get NA virtual server
      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 adc_vserver_appflow_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 adc_vserver_appflow_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 adc_vserver_appflow_info resources.
          enum:
            - yes
      responses:
        200:
          description:  for adc_vserver_appflow_info
          schema: 
              $ref: '#/definitions/getadc_vserver_appflow_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:
        - adc_vserver_appflow_info
      summary: POST operation for adc_vserver_appflow_info
      operationId: post_adc_vserver_appflow_info
      description: POST operation for adc_vserver_appflow_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: adc_vserver_appflow_info
          description: adc_vserver_appflow_info object
          schema:
              $ref: '#/definitions/addadc_vserver_appflow_infoRequest'
      responses:
        200:
          description: add for adc_vserver_appflow_info
          schema: 
              $ref: '#/definitions/addadc_vserver_appflow_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'

definitions:
  addadc_vserver_appflow_infoRequest:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        $ref: '#/definitions/adc_vserver_appflow_info_readwrite'
    title: addadc_vserver_appflow_infoRequest
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  addadc_vserver_appflow_infoResponse:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        $ref: '#/definitions/adc_vserver_appflow_info'
    title: addadc_vserver_appflow_infoResponse
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  getadc_vserver_appflow_infoResponse:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        $ref: '#/definitions/adc_vserver_appflow_info'
    title: getadc_vserver_appflow_infoResponse
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  getadc_vserver_appflow_infosResponse:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        type: array
        items:
          $ref: '#/definitions/adc_vserver_appflow_info'
    title: getadc_vserver_appflow_infosResponse
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  modifyadc_vserver_appflow_infoRequest:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        $ref: '#/definitions/adc_vserver_appflow_info_readwrite'
    title: modifyadc_vserver_appflow_infoRequest
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  modifyadc_vserver_appflow_infoResponse:
    type: object
    required:
      - adc_vserver_appflow_info
    properties:
      adc_vserver_appflow_info:
        $ref: '#/definitions/adc_vserver_appflow_info'
    title: modifyadc_vserver_appflow_infoResponse
    example:
      adc_vserver_appflow_info:
        export_option: "TCP"
        appflow_policy_rule: "true"
        es4nslog: "ENABLED"
        name: "vserver1"
        ns_ip_address: "1.1.1.1"
        partition_name: "p1"
        transport_mode: "logstream"
        type: "lb"
        netprofile: "netprofile_lb_vserver_1.1.1.1"

  adc_vserver_appflow_info_readwrite:
    type: object
    properties:
      export_option:
        description: "Export Options: TCP, ICA"
        type: array
        items:
          type: string
          format: string
      appflow_policy_rule:
        description: "Appflow policy rule"
        type: string
        format: string
      es4nslog:
        description: "ESNS enable"
        type: string
        format: string
      name:
        description: "Virtual server name"
        type: string
        format: string
        maxLength: 255
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      transport_mode:
        description: "Transport Mode [ Logstream/Appflow ]"
        type: string
        format: string
      type:
        description: "Tells whether virtual server type"
        type: string
        format: string
        minLength: 2
        maxLength: 64
      netprofile:
        description: "Net Proile"
        type: string
        format: string

  adc_vserver_appflow_info:
    allOf:
      -
        properties:
          partition_name:
             description: "Partition Name"
             type: string
             format: string
      - $ref: '#/definitions/adc_vserver_appflow_info_readwrite'

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