swagger: '2.0'
info:
  description: Configuration for Appflow param configuration on NetScaler resource.
  version: 'v2'
  title: ns_appflow_param_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_appflow_param_config
    description: Appflow param configuration 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/ns_appflow_param_config:
    get:
      tags:
        - ns_appflow_param_config
      summary: GET all ns_appflow_param_config
      operationId: getall_ns_appflow_param_config
      description: Use this operation to get appflow configuration on NetScaler Instance
      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_appflow_param_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 ns_appflow_param_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 ns_appflow_param_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_appflow_param_config
          schema: 
              $ref: '#/definitions/getns_appflow_param_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'

definitions:
  getns_appflow_param_configResponse:
    type: object
    required:
      - ns_appflow_param_config
    properties:
      ns_appflow_param_config:
        $ref: '#/definitions/ns_appflow_param_config'
    title: getns_appflow_param_configResponse
    example:
      ns_appflow_param_config:
        observationDomainName: "domain name"
        is_clip: "false"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        observationDomainID: "1543223"
        ns_ip_address: "1.1.1.1"

  getns_appflow_param_configsResponse:
    type: object
    required:
      - ns_appflow_param_config
    properties:
      ns_appflow_param_config:
        type: array
        items:
          $ref: '#/definitions/ns_appflow_param_config'
    title: getns_appflow_param_configsResponse
    example:
      ns_appflow_param_config:
        observationDomainName: "domain name"
        is_clip: "false"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        observationDomainID: "1543223"
        ns_ip_address: "1.1.1.1"

  modifyns_appflow_param_configRequest:
    type: object
    required:
      - ns_appflow_param_config
    properties:
      ns_appflow_param_config:
        $ref: '#/definitions/ns_appflow_param_config_readwrite'
    title: modifyns_appflow_param_configRequest
    example:
      ns_appflow_param_config:
        observationDomainName: "domain name"
        is_clip: "false"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        observationDomainID: "1543223"
        ns_ip_address: "1.1.1.1"

  modifyns_appflow_param_configResponse:
    type: object
    required:
      - ns_appflow_param_config
    properties:
      ns_appflow_param_config:
        $ref: '#/definitions/ns_appflow_param_config'
    title: modifyns_appflow_param_configResponse
    example:
      ns_appflow_param_config:
        observationDomainName: "domain name"
        is_clip: "false"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        observationDomainID: "1543223"
        ns_ip_address: "1.1.1.1"

  ns_appflow_param_config_readwrite:
    type: object
    properties:
      observationDomainName:
        description: "NetScaler observationDomainName"
        type: string
        format: string
        minLength: 1
        maxLength: 256
      is_clip:
        description: "Is Clip"
        type: boolean
        format: boolean
      template_interval:
        description: "Template refresh interval"
        type: integer
        format: int32
      httpxforwardedfor:
        type: string
        format: string
        minLength: 1
        maxLength: 10
      observationDomainID:
        description: "observationDomainID"
        type: number
        format: int64
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64

  ns_appflow_param_config:
    allOf:
      - $ref: '#/definitions/ns_appflow_param_config_readwrite'

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