swagger: '2.0'
info:
  description: Configuration for Session Hop Distribution Report resource.
  version: 'v2'
  title: session_hop_distribution
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: session_hop_distribution
    description: Session Hop Distribution Report
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/session_hop_distribution:
    get:
      tags:
        - session_hop_distribution
      summary: GET all session_hop_distribution
      operationId: getall_session_hop_distribution
      description: AfReportforTopURLbeingCountManagedbythisAFCollector
      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 session_hop_distribution 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 session_hop_distribution 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 session_hop_distribution resources.
          enum:
            - yes
      responses:
        200:
          description:  for session_hop_distribution
          schema: 
              $ref: '#/definitions/getsession_hop_distributionsResponse'
        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:
  getsession_hop_distributionResponse:
    type: object
    required:
      - session_hop_distribution
    properties:
      session_hop_distribution:
        $ref: '#/definitions/session_hop_distribution'
    title: getsession_hop_distributionResponse
    example:
      session_hop_distribution:
        source: "1.1.1.1"
        __count: "1"
        rpt_sample_time: "1542828383"
        exporter_id: "10244533"
        target: "1.1.1.1"
        hop_count: "1"
        source_type: "Client"
        id: "00000000-0000-375c-0000-000400000004"
        target_type: "NetScaler"
        latency: "0"

  getsession_hop_distributionsResponse:
    type: object
    required:
      - session_hop_distribution
    properties:
      session_hop_distribution:
        type: array
        items:
          $ref: '#/definitions/session_hop_distribution'
    title: getsession_hop_distributionsResponse
    example:
      session_hop_distribution:
        source: "1.1.1.1"
        __count: "1"
        rpt_sample_time: "1542828383"
        exporter_id: "10244533"
        target: "1.1.1.1"
        hop_count: "1"
        source_type: "Client"
        id: "00000000-0000-375c-0000-000400000004"
        target_type: "NetScaler"
        latency: "0"

  session_hop_distribution_readwrite:
    type: object
    properties:
      source:
        description: "Text to display for the source [e.g.: User name, NetScaler IP, Server IP, etc.]"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 128
      __count:
        description: "count."
        type: number
        format: double
      rpt_sample_time:
        description: "ReportSampletime."
        type: number
        format: double
      exporter_id:
        description: "Exported ID."
        type: string
        format: string
      target:
        description: "Text to display for the target [e.g.: User name, NetScaler IP, Server IP, etc.]"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 128
      hop_count:
        description: "Index of the hop [1, 2, 3, etc.] "
        type: number
        format: double
      source_type:
        description: "Type of the source, this will decide the icon to show in the UI for source [Client, NetScaler, Server, etc.] "
        type: string
        format: string
        minLength: 1
        maxLength: 128
      id:
        description: "Id is ICA Session ID"
        type: string
        format: uuid
        minLength: 1
        maxLength: 64
      target_type:
        description: "Type of the source, this will decide the icon to show in the UI for source [Client, NetScaler, Server, etc.]"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      latency:
        description: "ica session client latency."
        type: number
        format: double

  session_hop_distribution:
    allOf:
      - $ref: '#/definitions/session_hop_distribution_readwrite'

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