swagger: '2.0'
info:
  description: Configuration for Virtual server appflow config on NetScaler resource.
  version: 'v2'
  title: adc_vserver_appflow_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: adc_vserver_appflow_config
    description: Virtual server appflow config 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_config:
    get:
      tags:
        - adc_vserver_appflow_config
      summary: GET all adc_vserver_appflow_config
      operationId: getall_adc_vserver_appflow_config
      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_config 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_config 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_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for adc_vserver_appflow_config
          schema: 
              $ref: '#/definitions/getadc_vserver_appflow_configsResponse'
        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_config
      summary: POST operation for adc_vserver_appflow_config
      operationId: post_adc_vserver_appflow_config
      description: POST operation for adc_vserver_appflow_config
      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_config
          description: adc_vserver_appflow_config object
          schema:
              $ref: '#/definitions/addadc_vserver_appflow_configRequest'
      responses:
        200:
          description: add for adc_vserver_appflow_config
          schema: 
              $ref: '#/definitions/addadc_vserver_appflow_configResponse'
        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_configRequest:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        $ref: '#/definitions/adc_vserver_appflow_config_readwrite'
    title: addadc_vserver_appflow_configRequest
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        is_internal: "false"

  addadc_vserver_appflow_configResponse:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        $ref: '#/definitions/adc_vserver_appflow_config'
    title: addadc_vserver_appflow_configResponse
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        partition_name: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        act_id: "00000000-0000-375c-0000-300411114"
        is_internal: "false"

  getadc_vserver_appflow_configResponse:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        $ref: '#/definitions/adc_vserver_appflow_config'
    title: getadc_vserver_appflow_configResponse
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        partition_name: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        act_id: "00000000-0000-375c-0000-300411114"
        is_internal: "false"

  getadc_vserver_appflow_configsResponse:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        type: array
        items:
          $ref: '#/definitions/adc_vserver_appflow_config'
    title: getadc_vserver_appflow_configsResponse
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        partition_name: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        act_id: "00000000-0000-375c-0000-300411114"
        is_internal: "false"

  modifyadc_vserver_appflow_configRequest:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        $ref: '#/definitions/adc_vserver_appflow_config_readwrite'
    title: modifyadc_vserver_appflow_configRequest
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        is_internal: "false"

  modifyadc_vserver_appflow_configResponse:
    type: object
    required:
      - adc_vserver_appflow_config
    properties:
      adc_vserver_appflow_config:
        $ref: '#/definitions/adc_vserver_appflow_config'
    title: modifyadc_vserver_appflow_configResponse
    example:
      adc_vserver_appflow_config:
        feature_flag_enabled: "false"
        adc_params_info: [{        httpquerywithurl: "string_value"
,        template_interval: "integer_value"
,        httpxforwardedfor: "string_value"
,        gateway_deployment: "boolean_value"
,        ns_ip_address: "string_value"
,        geo_support: "boolean_value"
,        httpcookie: "string_value"
,        id: "string_value"
}]
        adc_appflow_info: [{        export_option: ["string_value1","string_value2"]
,        appflow_policy_rule: "string_value"
,        es4nslog: "string_value"
,        name: "string_value"
,        ns_ip_address: "string_value"
,        partition_name: "string_value"
,        transport_mode: "string_value"
,        type: "string_value"
,        netprofile: "string_value"
}]
        tenant_id: "00000000-0000-375c-0000-000400000004"
        feature_flag_disabled: "false"
        act_id: "00000000-0000-375c-0000-300411114"
        is_internal: "false"

  adc_vserver_appflow_config_readwrite:
    type: object
    properties:
      feature_flag_enabled:
        description: "Suggests if the enable-request is based on feature_flag"
        type: boolean
        format: boolean
      adc_params_info:
        type: array
        items:
          $ref: '#/definitions/adc_params_readwrite'
      adc_appflow_info:
        type: array
        items:
          $ref: '#/definitions/adc_vserver_appflow_info_readwrite'
      tenant_id:
        description: "TenantID"
        type: string
        format: uuid
      feature_flag_disabled:
        description: "Suggests if the disable-request is based on feature_flag"
        type: boolean
        format: boolean
      is_internal:
        description: "Suggests if the request is internal"
        type: boolean
        format: boolean

  adc_vserver_appflow_config:
    allOf:
      -
        properties:
          act_id:
             description: "Activity Id"
             type: string
             format: uuid
      - $ref: '#/definitions/adc_vserver_appflow_config_readwrite'

  adc_params_readwrite:
    type: object
    properties:
      httpquerywithurl:
        description: "URL query param flag."
        type: string
        format: string
        minLength: 1
        maxLength: 10
      template_interval:
        description: "Template refresh interval"
        type: integer
        format: int32
      httpxforwardedfor:
        description: "HTTP x-Forwarded for header flag."
        type: string
        format: string
        minLength: 1
        maxLength: 10
      gateway_deployment:
        description: "Is this device acting as Gateway."
        type: boolean
        format: boolean
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      geo_support:
        description: "Is this device configured to support GEO location."
        type: boolean
        format: boolean
      httpcookie:
        description: "Cookie-Header flag."
        type: string
        format: string
        minLength: 1
        maxLength: 10
      id:
        description: "Netscaler ID."
        type: string
        format: string
        minLength: 1

  adc_params:
    allOf:
      - $ref: '#/definitions/adc_params_readwrite'

  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"
