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": [
  
    # GetCurrentDate
    {
      "is_preset": false,
      "name": "GetCurrentDate",
      "type": "GET",
      "request_params": [
      ],
      "response_type": "JSON",
      "response_params": [
        {
          "name": "year",
          "type": "int",
          "is_array": false
        },
        {
          "name": "month",
          "type": "int",
          "is_array": false
        },
        {
          "name": "day",
          "type": "int",
          "is_array": false
        }
      ]
    },
  
    # GetCategoryActions
    {
      "is_preset": false,
      "name": "GetCategoryActions",
      "type": "GET",
      "request_params": [
        {
          "name": "category_name_short",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": false,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        {
          "name": "category_name_short",
          "type": "String",
          "is_array": false
        }
        # array of action_class_prefix > actions ids
      ]
    },
  
    # GetTotalActionCounters
    {
      "is_preset": false,
      "name": "GetTotalActionCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "class_prefix",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "action_id",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        {
          "name": "class_prefix",
          "type": "String",
          "is_array": false
        }
        # array of action_id > counter paris
      ]
    },

    # GetAnnualActionCounters
    {
      "is_preset": false,
      "name": "GetAnnualActionCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "class_prefix",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "action_id",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        },
        {
          "name": "from_year",
          "type": "INT",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "to_year",
          "type": "INT",
          "is_array": false,
          "optionality": "OPTIONAL"
        }
      ],
      "response_type": "JSON",
      "response_params": [
        {
          "name": "class_prefix",
          "type": "String",
          "is_array": false
        }
        # array of action_id > counter paris
      ]
    },

    # GetMonthlyActionCounters
    {
      "is_preset": false,
      "name": "GetMonthlyActionCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "class_prefix",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "action_id",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        },
        {
          "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": [
        {
          "name": "class_prefix",
          "type": "String",
          "is_array": false
        }
        # array of action_id > counter paris
      ]
    },

    # GetDailyActionCounters
    {
      "is_preset": false,
      "name": "GetDailyActionCounters",
      "type": "GET",
      "request_params": [
        {
          "name": "class_prefix",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": false,
          "optionality": "MANDATORY"
        },
        {
          "name": "action_id",
          "type": "ALPHA_NUMERIC_DASH_UNDERSCORE",
          "is_array": true,
          "optionality": "MANDATORY"
        },
        {
          "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": [
        {
          "name": "class_prefix",
          "type": "String",
          "is_array": false
        }
        # array of action_id > counter paris
      ]
    },

    # ReloadProperties
    {
      "is_preset": false,
      "name": "ReloadProperties",
      "type": "GET",
      "request_params": [
      ],
      "response_type": "JSON",
      "response_params": [
      ]
    }

  ]
}