You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by ro...@apache.org on 2014/11/12 02:15:11 UTC
[06/45] incubator-usergrid git commit: First commit to ApacheUsergrid
for new PHP5 sdks.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/1f8a4920/sdks/php5/apache-usergrid/src/Manifests/Application.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/Application.php b/sdks/php5/apache-usergrid/src/Manifests/Application.php
new file mode 100644
index 0000000..06dc86c
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/Application.php
@@ -0,0 +1,985 @@
+<?php
+/**
+ * Copyright 2010-2014 baas-platform.com, Pty Ltd. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+return [
+
+ 'name' => 'Application',
+ 'apiVersion' => '1.1',
+ 'baseUrl' => 'http://baas-platform.com',
+ 'description' => 'Client to Usergrid application service',
+ 'operations' => [
+ 'AuthPasswordGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/token',
+ 'notes' => 'Get the app access token. See the OAuth2 specification for details.',
+ 'summary' => 'Get app access token',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'grant_type' => [
+ 'description' => 'Grant type.',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'defaultValue' => 'password',
+ 'required' => true,
+ ],
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'username' => [
+ 'description' => 'Username (for grant_type=password).',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'password' => [
+ 'description' => 'Password (for grant_type=password).',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_id' => [
+ 'description' => 'Client ID (for grant_type=client_credentials).',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_secret' => [
+ 'description' => 'Client Secret (for grant_type=client_credentials).',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ]
+ ],
+ 'AuthPasswordPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/token',
+ 'notes' => 'Get the app access token. See the OAuth2 specification for details.',
+ 'summary' => 'Get app access token',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'grant_type' => [
+ 'description' => 'Grant type.',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'defaultValue' => 'password',
+ 'required' => true,
+ ],
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'username' => [
+ 'description' => 'Username (for grant_type=password).',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'password' => [
+ 'description' => 'Password (for grant_type=password).',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_id' => [
+ 'description' => 'Client ID (for grant_type=client_credentials).',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_secret' => [
+ 'description' => 'Client Secret (for grant_type=client_credentials).',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ]
+ ],
+ 'AuthorizeGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/authorize',
+ 'notes' => 'Authorize the app client. See the OAuth2 specification.',
+ 'summary' => 'Authorize app client',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'response_type' => [
+ 'description' => 'Response type',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ 'default' => 'token'
+ ],
+ 'redirect_uri' => [
+ 'description' => 'Redirect URI',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_id' => [
+ 'description' => 'Client ID',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'scope' => [
+ 'description' => 'Access Token Scope.',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'state' => [
+ 'description' => 'Client State.',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ]
+ ],
+ 'AuthorizePost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/authorize',
+ 'notes' => 'Authorize the app client. See the OAuth2 specification.',
+ 'summary' => 'Authorize app client',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'response_type' => [
+ 'description' => 'Response type',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ 'default' => 'token'
+ ],
+ 'redirect_uri' => [
+ 'description' => 'Redirect URI',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'client_id' => [
+ 'description' => 'Client ID',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'scope' => [
+ 'description' => 'Access Token Scope.',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'state' => [
+ 'description' => 'Client State.',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ]
+ ],
+ 'CredentialsGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/credentials',
+ 'notes' => 'Get the app client credentials.',
+ 'summary' => 'Get app client credentials',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'access_token' => [
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'The OAuth2 access token'
+ ],
+ ]
+ ],
+ 'CredentialsPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/credentials',
+ 'notes' => 'Generate new app client credentials',
+ 'summary' => 'Generate app client credentials',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'access_token' => [
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'The OAuth2 access token'
+ ],
+ ]
+ ],
+ 'UserJsonPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/users',
+ 'notes' => 'Create new app user',
+ 'summary' => 'Create new app user. See Usergrid documentation for JSON format of body.',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'username' => [
+ 'location' => 'json',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Username'
+ ],
+ 'name' => [
+ 'location' => 'json',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Name'
+ ],
+ 'email' => [
+ 'location' => 'json',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Email'
+ ],
+ 'password' => [
+ 'location' => 'json',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Password'
+ ]
+ ]
+ ],
+ 'UserFormPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/users',
+ 'notes' => 'Create new app user',
+ 'summary' => 'Create new app user using form post parameters.',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'username' => [
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Username'
+ ],
+ 'name' => [
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Name'
+ ],
+ 'email' => [
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Email'
+ ],
+ 'password' => [
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Admin Password'
+ ]
+ ]
+ ],
+ 'UserPasswordRestGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/resetpw',
+ 'notes' => 'Initiate a user password reset. Returns browser-viewable HTML page.',
+ 'summary' => 'Initiate a user password reset',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserPasswordFormPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/users/resetpw',
+ 'notes' => 'Complete a user password reset. Handles form POST response.',
+ 'summary' => 'Complete a user password reset',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'email' => [
+ 'description' => 'User Email',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'recaptcha_challenge_field' => [
+ 'description' => 'Recaptcha Challenge Field',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'recaptcha_response_field' => [
+ 'description' => 'Recaptcha Response Field',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}',
+ 'notes' => 'Returns the app user details.',
+ 'summary' => 'Returns the app user details',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserJsonPut' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}',
+ 'notes' => 'Updates the app user details.',
+ 'summary' => 'Updates the app user details',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ],
+ 'additionalParameters' => [
+ 'location' => 'json'
+ ]
+ ],
+ 'UserActivateGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/activate',
+ 'notes' => 'Activates the app user from link provided in email notification.',
+ 'summary' => 'Activates the app user',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'token' => [
+ 'description' => 'Activation Token (supplied via email)',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'confirm' => [
+ 'description' => 'Send confirmation email',
+ 'location' => 'query',
+ 'type' => 'boolean',
+ 'required' => true,
+ ],
+ ]
+ ],
+ 'UserReactivateGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/reactivate',
+ 'notes' => 'Request app user reactivation.',
+ 'summary' => 'Reactivates the app user',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserFeedGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/feed',
+ 'notes' => 'Get app user activity feed.',
+ 'summary' => 'Get app user activity feed',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserPasswordJsonPut' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/password',
+ 'notes' => 'Set app user password. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Set app user password',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Old and new password",
+ 'location' => 'json'
+ ]
+ ],
+ 'UserResetPasswordGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw',
+ 'notes' => 'Initiate a user password reset. Returns browser-viewable HTML page.',
+ 'summary' => 'Initiate a user password reset',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'UserResetPasswordFormPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw',
+ 'notes' => 'Complete a user password reset. Handles form POST response.',
+ 'summary' => 'Complete a user password reset',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "User not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'user_username_email_or_uuid' => [
+ 'description' => 'User username, email or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'recaptcha_challenge_field' => [
+ 'description' => 'Recaptcha Challenge Field',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'recaptcha_response_field' => [
+ 'description' => 'Recaptcha Response Field',
+ 'location' => 'postField',
+ 'type' => 'string',
+ 'required' => true,
+ ]
+ ]
+ ],
+ 'EntityGet' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/apps/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query an app collection.',
+ 'summary' => 'Query an app collection',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'ql' => [
+ 'description' => 'a query in the query language',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'reversed' => [
+ 'description' => 'return results in reverse order',
+ 'location' => 'query',
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ 'start' => [
+ 'description' => 'the first entity UUID to return',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'cursor' => [
+ 'description' => 'an encoded representation of the query position for paging',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'limit' => [
+ 'description' => 'an encoded representation of the query position for paging',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ],
+ 'filter' => [
+ 'description' => 'a condition to filter on',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ]
+ ]
+ ],
+ 'EntityJsonPost' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/apps/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Create new app entity. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Create new app entity',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'EntityPut' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/apps/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Update an app entity in a collection.',
+ 'summary' => 'Update an app entity',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'entity_name_or_uuid' => [
+ 'description' => 'entity name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'EntityDelete' => [
+ 'httpMethod' => 'DELETE',
+ 'uri' => '/apps/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Delete an app entity.',
+ 'summary' => 'Delete an app entity',
+ 'responseClass' => 'Response',
+ 'errorResponses' => [
+ [
+ "reason" => "Invalid ID supplied",
+ "code" => 400
+ ],
+ [
+ "reason" => "Application not found",
+ "code" => 404
+ ]
+ ],
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'entity_name_or_uuid' => [
+ 'description' => 'entity name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ]
+ ]
+ ],
+
+ ]
+];
\ No newline at end of file