api_data.json

[
  {
    "type": "post",
    "url": "/api/auth/login",
    "title": "Login",
    "name": "Login",
    "version": "0.9.1",
    "group": "Auth",
    "examples": [
      {
        "title": "Example usage:",
        "content": "http://api.bwg.com/api/auth/login",
        "type": "json"
      }
    ],
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "session_token",
            "description": "<p>Session token.</p> "
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "first_name",
            "description": "<p>First name of user.</p> "
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "last_name",
            "description": "<p>Last name of user.</p> "
          },
          {
            "group": "Success 200",
            "type": "Bool",
            "optional": false,
            "field": "is_manager",
            "description": "<p>User is manager: true /false.</p> "
          },
          {
            "group": "Success 200",
            "type": "Array",
            "optional": false,
            "field": "campaigns",
            "description": "<p>Array of campaign ids user can access.</p> "
          }
        ]
      }
    },
    "filename": "webapp/api1.php",
    "groupTitle": "Auth",
    "sampleRequest": [
      {
        "url": "@SAMPLEURL/api/auth/login"
      }
    ]
  },
  {
    "type": "get",
    "url": "/auth/logout",
    "title": "Logout",
    "name": "Logout",
    "group": "Auth",
    "description": "<p>Destroy user session</p> ",
    "version": "0.0.0",
    "filename": "webapp/api1.php",
    "groupTitle": "Auth",
    "sampleRequest": [
      {
        "url": "@SAMPLEURL/auth/logout"
      }
    ]
  },
  {
    "success": {
      "fields": {
        "Success 200": [
          {
            "group": "Success 200",
            "optional": false,
            "field": "varname1",
            "description": "<p>No type.</p> "
          },
          {
            "group": "Success 200",
            "type": "String",
            "optional": false,
            "field": "varname2",
            "description": "<p>With type.</p> "
          }
        ]
      }
    },
    "type": "",
    "url": "",
    "version": "0.0.0",
    "filename": "webapp/public/doc/main.js",
    "group": "_Users_pives_Proj_hrc_server_webapp_public_doc_main_js",
    "groupTitle": "_Users_pives_Proj_hrc_server_webapp_public_doc_main_js",
    "name": ""
  }
]