swagger: '2.0'
info:
  description: Configuration for L7 Latency configuration on NetScaler resource.
  version: 'v2'
  title: ns_l7_latency_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_l7_latency_config
    description: L7 Latency 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_l7_latency_config:
    get:
      tags:
        - ns_l7_latency_config
      summary: GET all ns_l7_latency_config
      operationId: getall_ns_l7_latency_config
      description: Use this operation to get NetScaler L7 Latency Configuration
      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_l7_latency_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_l7_latency_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_l7_latency_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_l7_latency_config
          schema: 
              $ref: '#/definitions/getns_l7_latency_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_l7_latency_configResponse:
    type: object
    required:
      - ns_l7_latency_config
    properties:
      ns_l7_latency_config:
        $ref: '#/definitions/ns_l7_latency_config'
    title: getns_l7_latency_configResponse
    example:
      ns_l7_latency_config:
        vserverType: "string_value"
        l7LatencyThresholdNotifyIntetval: "30"
        l7LatencyNotifyCount: "4"
        l7LatencyThresholdWaitInterval: "20"
        ns_ip_address: "1.1.1.1"
        l7LatencyThresholdFactor: "4"
        latencyName: "string_value"
        vserverName: "string_value"
        l7LatencyMonitoring: "DISABLED"

  getns_l7_latency_configsResponse:
    type: object
    required:
      - ns_l7_latency_config
    properties:
      ns_l7_latency_config:
        type: array
        items:
          $ref: '#/definitions/ns_l7_latency_config'
    title: getns_l7_latency_configsResponse
    example:
      ns_l7_latency_config:
        vserverType: "string_value"
        l7LatencyThresholdNotifyIntetval: "30"
        l7LatencyNotifyCount: "4"
        l7LatencyThresholdWaitInterval: "20"
        ns_ip_address: "1.1.1.1"
        l7LatencyThresholdFactor: "4"
        latencyName: "string_value"
        vserverName: "string_value"
        l7LatencyMonitoring: "DISABLED"

  modifyns_l7_latency_configRequest:
    type: object
    required:
      - ns_l7_latency_config
    properties:
      ns_l7_latency_config:
        $ref: '#/definitions/ns_l7_latency_config_readwrite'
    title: modifyns_l7_latency_configRequest
    example:
      ns_l7_latency_config:
        vserverType: "string_value"
        l7LatencyThresholdNotifyIntetval: "30"
        l7LatencyNotifyCount: "4"
        l7LatencyThresholdWaitInterval: "20"
        ns_ip_address: "1.1.1.1"
        l7LatencyThresholdFactor: "4"
        vserverName: "string_value"
        l7LatencyMonitoring: "DISABLED"

  modifyns_l7_latency_configResponse:
    type: object
    required:
      - ns_l7_latency_config
    properties:
      ns_l7_latency_config:
        $ref: '#/definitions/ns_l7_latency_config'
    title: modifyns_l7_latency_configResponse
    example:
      ns_l7_latency_config:
        vserverType: "string_value"
        l7LatencyThresholdNotifyIntetval: "30"
        l7LatencyNotifyCount: "4"
        l7LatencyThresholdWaitInterval: "20"
        ns_ip_address: "1.1.1.1"
        l7LatencyThresholdFactor: "4"
        latencyName: "string_value"
        vserverName: "string_value"
        l7LatencyMonitoring: "DISABLED"

  ns_l7_latency_config_readwrite:
    type: object
    properties:
      vserverType:
        description: "Virtual server type(lb/sslvpn/CR)"
        type: string
        format: string
        minLength: 2
        maxLength: 64
      l7LatencyThresholdNotifyIntetval:
        description: "L7 Latency Threshold Notify Intetval"
        type: integer
        format: int32
      l7LatencyNotifyCount:
        description: "L7 Latency Notify Count"
        type: integer
        format: int32
      l7LatencyThresholdWaitInterval:
        description: "L7 Latency Threshold Wait Interval"
        type: integer
        format: int32
      ns_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: IP Address
        minLength: 1
        maxLength: 64
      l7LatencyThresholdFactor:
        description: "L7 Latency Threshold Factor Value"
        type: integer
        format: int32
      vserverName:
        description: "Virtual server name"
        type: string
        format: string
        maxLength: 255
      l7LatencyMonitoring:
        description: "ENABLE/DISABLE"
        type: string
        format: string
        maxLength: 512

  ns_l7_latency_config:
    allOf:
      -
        properties:
          latencyName:
             description: "Name of latency profile"
             type: string
             format: string
             maxLength: 1024
      - $ref: '#/definitions/ns_l7_latency_config_readwrite'

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