# (C) Copyright 2015 Riverbed Technology, Inc.
# All rights reserved.

name: cmc.webproxy_reporting
version: "1.0"
title: webproxy_reporting service
description: REST API for webproxy_reporting service.
$schema: 'http://support.riverbed.com/apis/service_def/2.2'
id: 'http://support.riverbed.com/apis/webproxy_reporting/1.0'
provider: 'riverbed'

resources:
    cache_hit_ratio:
        description: "Cache hit Ratio for all sites"
        type: object
        additionalProperties: false
        properties:
            time_stamp:
                type: array
                items: { type: number }
            hit:
                type: array
                items: { type: number }
            requests:
                type: array
                items: { type: number }
            percentage:
                type: array
                items: { type: number }

        links:
            self:
                path: "$/cache_hit_ratio"
                params:
                    site_id: {type: integer}
                    site_type_id: {type: integer}
                    all_sites: {type: boolean}

            get:
                method: GET
                response:
                    $ref: '#/resources/cache_hit_ratio'

    optimization_report:
        description: "Optimization report for sites being requested"
        type: object
        additionalProperties: false
        properties:
            time_stamp:
                type: array
                items: { type: number }
            lan:
                type: array
                items: { type: number }
            wan:
                type: array
                items: { type: number }
            percentage:
                type: array
                items: { type: number }
        links:
            self:
                path: "$/optimization_report"
                params:
                    site_id: {type: integer}
                    site_type_id: {type: integer}
                    all_sites: {type: boolean}

            get:
                method: GET
                response:
                    $ref: '#/resources/optimization_report'

    top_domains_by_requests:
        description: "Top 10 domains visited by number of requests. "
        type: object
        properties:
            site_id:
                type: integer
            site_type_id:
                type: integer
            all_sites:
                type: integer
        links:
            self:
                path: "$/top_domains_by_requests"
                params:
                    site_id: {type: integer}
                    site_type_id: {type: integer}
                    all_sites: {type: boolean}
            get:
                method: GET
                response:
                    $ref: '#/resources/top_domains_by_requests'

    top_domains_by_size:
        description: "Top 10 domains visit by size. "
        type: object
        properties:
            site_id:
                type: integer
            site_type_id:
                type: integer
            all_sites:
                type: integer
        links:
            self:
                path: "$/top_domains_by_size"
                params:
                    site_id: {type: integer}
                    site_type_id: {type: integer}
                    all_sites: {type: boolean}
            get:
                method: GET
                response:
                    $ref: '#/resources/top_domains_by_size'
    top_url_by_size:
        description: "Top 10 URLs visit by size. "
        type: object
        properties:
            site_id:
                type: integer
            site_type_id:
                type: integer
            all_sites:
                type: integer
        links:
            self:
                path: "$/top_url_by_size"
                params:
                    site_id: {type: integer}
                    site_type_id: {type: integer}
                    all_sites: {type: boolean}
            get:
                method: GET
                response:
                    $ref: '#/resources/top_url_by_size'