swagger: '2.0'
info:
  description: Configuration for AF WEB Summary Report table resource.
  version: 'v2'
  title: web_summary
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: web_summary
    description: AF WEB Summary Report table
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/web_summary:
    get:
      tags:
        - web_summary
      summary: GET all web_summary
      operationId: getall_web_summary
      description: Af Report for Web Summary being Count Managed by this AF Collector
      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: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: cr_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate cr is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: asc
          type: string
          required: false
          description: Use this query-parameter to specify whether the results should be in ascending order or not
          enum:
            - yes
            - no
        - in: query
          name: order_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is ordered by the given property
          enum:
            - total_requests
            - load_time
            - render_time
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - total_requests
            - load_time
            - render_time
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the web_summary 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 web_summary 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 web_summary resources.
          enum:
            - yes
      responses:
        200:
          description:  for web_summary
          schema: 
              $ref: '#/definitions/getweb_summarysResponse'
        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:
  getweb_summaryResponse:
    type: object
    required:
      - web_summary
    properties:
      web_summary:
        $ref: '#/definitions/web_summary'
    title: getweb_summaryResponse
    example:
      web_summary:
        ssl_error_type: "integer_value"
        __count: "0"
        application_name: "Exchange"
        sslVersion_frontend: "integer_value"
        network_latency_client_side: "0"
        app_unit_name: "test_vserver"
        render_time: "0"
        ip_address: "1.1.1.1"
        id: "news.google.com"
        cipherstrength_frontend: "integer_value"
        total_bytes: "0"
        rpt_sample_time: "0"
        device_ip_address: "1.1.1.1"
        ctnsappname_b: "test_vserver"
        srvr_cert_hash_frontend: "integer_value"
        server_response_time: "0"
        load_time: "0"
        network_latency_server_side: "0"
        servercertsize_frontend: "integer_value"
        application_response_time: "0"
        total_dist_count: "0"
        total_requests: "0"
        app_unit_ip_address: "1.1.1.1"

  getweb_summarysResponse:
    type: object
    required:
      - web_summary
    properties:
      web_summary:
        type: array
        items:
          $ref: '#/definitions/web_summary'
    title: getweb_summarysResponse
    example:
      web_summary:
        ssl_error_type: "integer_value"
        __count: "0"
        application_name: "Exchange"
        sslVersion_frontend: "integer_value"
        network_latency_client_side: "0"
        app_unit_name: "test_vserver"
        render_time: "0"
        ip_address: "1.1.1.1"
        id: "news.google.com"
        cipherstrength_frontend: "integer_value"
        total_bytes: "0"
        rpt_sample_time: "0"
        device_ip_address: "1.1.1.1"
        ctnsappname_b: "test_vserver"
        srvr_cert_hash_frontend: "integer_value"
        server_response_time: "0"
        load_time: "0"
        network_latency_server_side: "0"
        servercertsize_frontend: "integer_value"
        application_response_time: "0"
        total_dist_count: "0"
        total_requests: "0"
        app_unit_ip_address: "1.1.1.1"

  web_summary_readwrite:
    type: object
    properties:
      ssl_error_type:
        description: "SSL Error Type. frontend=1, backend=2."
        type: integer
        format: int32
      __count:
        description: "count."
        type: number
        format: int64
      sslVersion_frontend:
        description: "SSL Error Type. frontend=1, backend=2."
        type: integer
        format: int32
      network_latency_client_side:
        description: "Network latency client side."
        type: number
        format: double
      render_time:
        description: "Render time."
        type: number
        format: double
      ip_address:
        description: "Source IP Address"
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      id:
        description: "Id is HTTP Req URL."
        type: string
        format: string
        maxLength: 2000
      cipherstrength_frontend:
        description: "SSL Error Type. frontend=1, backend=2."
        type: integer
        format: int32
      total_bytes:
        description: "Total bytes accounted by this URL in sampled timeframe."
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: int64
      srvr_cert_hash_frontend:
        description: "SSL Error Type. frontend=1, backend=2."
        type: integer
        format: int32
      server_response_time:
        description: "Server response time."
        type: number
        format: double
      load_time:
        description: "URI Load time."
        type: number
        format: double
      network_latency_server_side:
        description: "Network latency server side."
        type: number
        format: double
      servercertsize_frontend:
        description: "SSL Error Type. frontend=1, backend=2."
        type: integer
        format: int32
      application_response_time:
        description: "Application response time."
        type: number
        format: double
      total_dist_count:
        description: " Total Distinct entity count"
        type: number
        format: int64
      total_requests:
        description: "Count of this URL in given sampled timeframe."
        type: number
        format: double

  web_summary:
    allOf:
      - $ref: '#/definitions/web_summary_readwrite'

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