controllers.json

# "First, solve the problem. Then, write the code. -John Johnson"
# "Or use Vangav M"
# www.vangav.com

# MIT License
#
# Copyright (c) 2016 Vangav
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Community
# Facebook Group: Vangav Open Source - Backend
#   fb.com/groups/575834775932682/
# Facebook Page: Vangav
#   fb.com/vangav.f
#
# Third party communities for Vangav Backend
#   - play framework
#   - cassandra
#   - datastax
#
# Tag your question online (e.g.: stack overflow, etc ...) with
#   #vangav_backend
#   to easier find questions/answers online

# @author mustapha
# fb.com/mustapha.abdallah

{
  "java_package": "com.vangav",
  "check_source": true,
  "throttle": true,
  "validate_param": true,
  "authenticate": true,
  "after_response": true,
  "after_processing": true,
  "default_operations": true,
  "notifications": true,
  "analysis": true,
  "logging": true,
  
  "controllers": [
  
    # GetAnnualRegionalCounters
    {
      "is_preset": false,
      "name": "GetAnnualRegionalCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "from_year",
          "type": "INT",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_year",
          "type": "INT",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "regions",
          "type": "ALPHA_NUMERIC_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of annual regional counters grouped per-year per-region
      ]
    },

    # GetDailyRegionalCounters
    {
      "is_preset": false,
      "name": "GetDailyRegionalCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "regions",
          "type": "ALPHA_NUMERIC_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of daily regional counters grouped per-day per-region
      ]
    },

    # GetDailyRequestsCounters
    {
      "is_preset": false,
      "name": "GetDailyRequestsCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "controllers",
          "type": "ALPHA_NUMERIC_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of daily requests counters grouped per-day per-controller
      ]
    },

    # GetHourlyRequestsCounters
    {
      "is_preset": false,
      "name": "GetHourlyRequestsCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "from_hour",
          "type": "INT",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_hour",
          "type": "INT",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "controllers",
          "type": "ALPHA_NUMERIC_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of daily requests counters grouped per-day per-hour per-controller
      ]
    },

    # GetHourlyControllersErrorLogs
    {
      "is_preset": false,
      "name": "GetHourlyControllersErrorLogs",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "from_hour",
          "type": "INT",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_hour",
          "type": "INT",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "controllers",
          "type": "ALPHA_NUMERIC_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of controllers' error logs grouped per-day per-hour per-controller
      ]
    },

    # GetDailyUsersErrorLogs
    {
      "is_preset": false,
      "name": "GetDailyUsersErrorLogs",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "user_emails",
          "type": "EMAIL",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of users' error logs grouped per-day per-user
      ]
    },

    # GetDailyUsersLogs
    {
      "is_preset": false,
      "name": "GetDailyUsersLogs",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        },
        {
          "name": "user_emails",
          "type": "EMAIL",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of users' logs grouped per-day per-user
      ]
    },

    # GetTopPosts
    {
      "is_preset": false,
      "name": "GetTopPosts",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of top posts' info grouped by day
      ]
    },

    # GetTopUsers
    {
      "is_preset": false,
      "name": "GetTopUsers",
      "type": "GET",
      "request_params": [
        {
          "name": "from_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_date",
          "type": "DATE",
          "is_array": false,
          "optionality": "OPTIONAL"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        # an array of top users' info grouped by week
      ]
    }

  ]
}