swagger: '2.0'
info:
  description: Configuration for NetScaler Info Parameters resource.
  version: 'v2'
  title: adc_params
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: adc_params
    description: NetScaler Info Parameters
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_params:
    get:
      tags:
        - adc_params
      summary: GET all adc_params
      operationId: getall_adc_params
      description: get NetScaler Info params
      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_params 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_params 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_params resources.
          enum:
            - yes
      responses:
        200:
          description:  for adc_params
          schema: 
              $ref: '#/definitions/getadc_paramssResponse'
        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_params
      summary: POST operation for adc_params
      operationId: post_adc_params
      description: POST operation for adc_params
      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_params
          description: adc_params object
          schema:
              $ref: '#/definitions/addadc_paramsRequest'
      responses:
        200:
          description: add for adc_params
          schema: 
              $ref: '#/definitions/addadc_paramsResponse'
        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_paramsRequest:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        $ref: '#/definitions/adc_params_readwrite'
    title: addadc_paramsRequest
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  addadc_paramsResponse:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        $ref: '#/definitions/adc_params'
    title: addadc_paramsResponse
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  getadc_paramsResponse:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        $ref: '#/definitions/adc_params'
    title: getadc_paramsResponse
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  getadc_paramssResponse:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        type: array
        items:
          $ref: '#/definitions/adc_params'
    title: getadc_paramssResponse
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  modifyadc_paramsRequest:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        $ref: '#/definitions/adc_params_readwrite'
    title: modifyadc_paramsRequest
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  modifyadc_paramsResponse:
    type: object
    required:
      - adc_params
    properties:
      adc_params:
        $ref: '#/definitions/adc_params'
    title: modifyadc_paramsResponse
    example:
      adc_params:
        httpquerywithurl: "ENABLED"
        template_interval: "10"
        httpxforwardedfor: "ENABLED"
        gateway_deployment: "false"
        ns_ip_address: "1.1.1.1"
        geo_support: "false"
        httpcookie: "ENABLED"
        id: "154565322"

  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'

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