swagger: '2.0'
info:
  description: Configuration for Appflow configuration for Citrix SD-WANOpt resource.
  version: 'v2'
  title: cbwanopt_appflowconfig
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: cbwanopt_appflowconfig
    description: Appflow configuration for Citrix SD-WANOpt
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/cbwanopt_appflowconfig:
    get:
      tags:
        - cbwanopt_appflowconfig
      summary: GET all cbwanopt_appflowconfig
      operationId: getall_cbwanopt_appflowconfig
      description: get Citrix SD-WAN appflow policy state
      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 cbwanopt_appflowconfig 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 cbwanopt_appflowconfig 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 cbwanopt_appflowconfig resources.
          enum:
            - yes
      responses:
        200:
          description:  for cbwanopt_appflowconfig
          schema: 
              $ref: '#/definitions/getcbwanopt_appflowconfigsResponse'
        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:
  addcbwanopt_appflowconfigRequest:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        $ref: '#/definitions/cbwanopt_appflowconfig_readwrite'
    title: addcbwanopt_appflowconfigRequest
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  addcbwanopt_appflowconfigResponse:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        $ref: '#/definitions/cbwanopt_appflowconfig'
    title: addcbwanopt_appflowconfigResponse
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  getcbwanopt_appflowconfigResponse:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        $ref: '#/definitions/cbwanopt_appflowconfig'
    title: getcbwanopt_appflowconfigResponse
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  getcbwanopt_appflowconfigsResponse:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        type: array
        items:
          $ref: '#/definitions/cbwanopt_appflowconfig'
    title: getcbwanopt_appflowconfigsResponse
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  modifycbwanopt_appflowconfigRequest:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        $ref: '#/definitions/cbwanopt_appflowconfig_readwrite'
    title: modifycbwanopt_appflowconfigRequest
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  modifycbwanopt_appflowconfigResponse:
    type: object
    required:
      - cbwanopt_appflowconfig
    properties:
      cbwanopt_appflowconfig:
        $ref: '#/definitions/cbwanopt_appflowconfig'
    title: modifycbwanopt_appflowconfigResponse
    example:
      cbwanopt_appflowconfig:
        tcp: "boolean_value"
        tcp_hdx: "boolean_value"
        agent_list: "[\"10.10.10.26\", \"10.10.10.27\"]"
        wanOpt: "boolean_value"
        geo_support: "false"
        hdx: "boolean_value"
        id: "10.102.40.60"
        ip_address: "10.102.40.60"
        appflowfeature: "false"

  cbwanopt_appflowconfig_readwrite:
    type: object
    properties:
      tcp:
        description: "tcp"
        type: boolean
        format: boolean
      tcp_hdx:
        description: "tcp_hdx"
        type: boolean
        format: boolean
      agent_list:
        description: "Agent List, on which traffic will flow"
        type: array
        items:
          type: string
          format: string
      wanOpt:
        description: "wanOpt"
        type: boolean
        format: boolean
      geo_support:
        description: "Is this Citrix SD-WAN device configured to support GEO location."
        type: boolean
        format: boolean
      hdx:
        description: "hdx"
        type: boolean
        format: boolean
      id:
        description: "Citrix SD-WANOpt IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      ip_address:
        description: "BR IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      appflowfeature:
        description: "appflowfeature"
        type: boolean
        format: boolean

  cbwanopt_appflowconfig:
    allOf:
      - $ref: '#/definitions/cbwanopt_appflowconfig_readwrite'

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