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:16 UTC
[11/45] incubator-usergrid git commit: Updated the README.md file and
added the version 1.0.1 manifest files
Updated the README.md file and added the version 1.0.1 manifest files
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/bf7aaba0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/bf7aaba0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/bf7aaba0
Branch: refs/heads/master
Commit: bf7aaba0dc53545b30e4e12dcb65e0344803ab8a
Parents: 1f8a492
Author: Jason Kristian <ja...@apps4u.com.au>
Authored: Sun Oct 26 15:53:26 2014 +1000
Committer: Jason Kristian <ja...@apps4u.com.au>
Committed: Sun Oct 26 15:53:26 2014 +1000
----------------------------------------------------------------------
sdks/php5/apache-usergrid/README.md | 38 +-
.../src/Manifests/1.0.1/Activities.php | 24 ++
.../src/Manifests/1.0.1/Assets.php | 24 ++
.../src/Manifests/1.0.1/Devices.php | 381 +++++++++++++++++++
.../src/Manifests/1.0.1/Events.php | 24 ++
.../src/Manifests/1.0.1/Groups.php | 381 +++++++++++++++++++
.../src/Manifests/1.0.1/Notifications.php | 24 ++
.../src/Manifests/1.0.1/Notifiers.php | 24 ++
.../src/Manifests/1.0.1/Receipts.php | 24 ++
.../src/Manifests/1.0.1/Roles.php | 381 +++++++++++++++++++
.../src/Manifests/1.0.1/Users.php | 381 +++++++++++++++++++
11 files changed, 1693 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/README.md
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/README.md b/sdks/php5/apache-usergrid/README.md
index fe436e2..424e895 100644
--- a/sdks/php5/apache-usergrid/README.md
+++ b/sdks/php5/apache-usergrid/README.md
@@ -74,10 +74,9 @@ $res = Usergrid::application()->EntityGet(['collection' => 'shops']);
### Laravel ###
-In Laravel you then publish the config file like ```php artisan config:publish apache/usergrid ``` which will publish the config file to the app/config/packages/apache/usergrid/config.php
-then add your client_id and secret to the config file and setup the service provider to app/config providers array ```Apache\Usergrid\Laravel\ApacheUsergridServiceProvider``` and add the alias to
-the aliases array ```'Usergrid' => 'Apache\Usergrid\Laravel\Facades\Usergrid``` to be able to access class via a Facade
-example for Laravel
+In Laravel once you have install the composer package you then publish the config file like ```php artisan config:publish apache/usergrid ``` which will publish the config file to the app/config/packages/apache/usergrid/config.php
+then add your client_id and secret to the config file the set the service provider in the app/config.php providers array ```Apache\Usergrid\Laravel\ApacheUsergridServiceProvider``` and add the alias to
+the aliases array ```'Usergrid' => 'Apache\Usergrid\Laravel\Facades\Usergrid``` to be able to access class via a Facade. Example for Laravel
```
$collection = Usergrid::application()->getEntity(['collection' => 'shops']);
@@ -95,7 +94,7 @@ example for Laravel
AWS PHP SDK when calling enableFacades() on the AWS factory method.
### Error Handling ###
-All HTTP and Server error returned by the Usergrid API have error classes attached to the services descriptors so to handle error's that you want to just catch the correct exception eg. resource not found.
+All HTTP and Server error returned by the Usergrid API have error classes attached to the services descriptors so to handle error's that you want too, Just catch the correct exception eg. resource not found.
```
try {
@@ -107,8 +106,8 @@ try {
```
### Authentication ###
- You can manage your own Oauth 2 flow by setting the enable_oauth2_plugin config setting to false then you need to call the Token api and then set the token on the usergrid instance
- by default this will manage Oauth2 for you but if you want to do it your self set the config setting to false and then do some like this.
+ You can manage your own Oauth 2 flow by setting the enable_oauth2_plugin config setting to false then you need to call the Token api or get the token from elsewhere and then set the token on the usergrid instance.
+ By default this will manage Oauth2 flow for you and I recommend that you leave it set to true. But if you want to do it yourself set the config setting to false and then do something like this.
```
$res = Usergrid::management()->authPasswordGet($array);
@@ -123,15 +122,28 @@ try {
* Application Token -- Per Application token that is for the application
* Application User Token -- User level access this token is for a logged in user.
- The Organization and Application token's when using client_credentials should only be used in a server side application as it has full access to each resource
- the Organization Token can access all applications and edit Organization details. The Application token has full access to all application
+ The Organization and Application token's when using client_credentials should only be used in a server side application as it has full access to all resources.
+ The Organization Token can access all applications and edit Organization details. The Application token has full access to all application
resources. The Admin user token is the organization admin user so it too has access to all Applications and Organizations and the last level which is a User
- Token that is a per application users and will have access to all resources that roles attached to that user can access.
+ Token that is a per application user and will have access to all resources that roles attached to that user can access.
So there are two settings in the config that controls which type of token you get.
the ```'auth_type' => 'application' ``` controls the level you get Organization or Application and the ``` 'grant_type' => 'client_credentials'``` controls
-which type of credentials you use which can be either client_id & client_secret or username & password
+which type of credentials you use which can be either client_id & client_secret or username & password.
+### Result Iteration ###
+Apache Usergrid has a default paging size of 10 records so if you ask for a collection that has more then 10 result (entities) then it will return
+a Cursor so you can pass it to the next request to get then next lot of 10 results so Ive made this easier. Using manifest version 1.0.1 and above you can now use a resource iterator
+that will return all entities for you in one request. So again let the SDK do the hard work for you.
+
+```
+//The SDK will check each response to see if their is a cursor and if there is it will get the next set till all entities are returned.
+$allDevices = Usergrid::DevicesIterator();
+
+foreach($allDevices as $device) {
+// this will have all devices.
+}
+```
## Manifest Files (Guzzle & Swagger Service Descriptors) ##
All the files in the manifest folder are just temp file the final Service Descriptors are versioned so
@@ -139,10 +151,10 @@ the real files are in the manifest/1.0.0 folder so as usergrid is updated new ve
Ill leave the other manifest file there for now but will cleanup when Apache Usergrid accepts this library.
## designs guidelines ##
-The design of this is to make it easy to add to existing project and be able to map Model objects in yor project
+The design of this is to make it easy to add to existing project and be able to map Model objects in your project
to response models for example in my project I have a organization object that is saved in a mysql database and I can
call a Usergrid Api call on that model object just like using the Usergrid api class eg:
-``` Usergrid::Mangement->putOrganization($data_array) ``` is the same as
+``` Usergrid::Management->putOrganization($data_array) ``` is the same as
``` Organization::put($data_array) ``` how to do this is beyond the scope of the SDK but its not hard to create
Gateway Objects using php Traits
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Activities.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Assets.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Assets.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Assets.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Assets.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Devices.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Devices.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Devices.php
new file mode 100644
index 0000000..b688575
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Devices.php
@@ -0,0 +1,381 @@
+<?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 [
+
+ 'all' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Get All devices.',
+ 'summary' => 'Get all Device collection limit 10000',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Collection',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'devices'
+ ],
+ '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,
+ 'default' => 10000
+ ],
+ 'filter' => [
+ 'description' => 'a condition to filter on',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'find' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query Devices.',
+ 'summary' => 'Query the devices collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'devices'
+ ],
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'findById' => ['httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{uuid}',
+ 'notes' => 'Find Device by uuid.',
+ 'summary' => 'Find device by uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'devices'
+ ],
+ 'uuid' => [
+ 'description' => 'Group UUID (entity uuid)',
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'create' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Create new Device. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Create new Device entity',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'devices'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'destroy' => [
+ 'httpMethod' => 'DELETE',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Delete a Device entity.',
+ 'summary' => 'Delete a Device entity by name or uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'devices'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ]
+ ],
+ 'update' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Update a Device entity.',
+ 'summary' => 'Update a Device entity by name or uuid and using JSON data',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'devices'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ]
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Events.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Events.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Events.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Events.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Groups.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Groups.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Groups.php
new file mode 100644
index 0000000..e874ce9
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Groups.php
@@ -0,0 +1,381 @@
+<?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 [
+
+ 'all' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query an app collection.',
+ 'summary' => 'Query an app collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Collection',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'groups'
+ ],
+ '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,
+ 'default' => 10000
+ ],
+ 'filter' => [
+ 'description' => 'a condition to filter on',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'find' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query Groups.',
+ 'summary' => 'Query the groups collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'groups'
+ ],
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'findById' => ['httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{uuid}',
+ 'notes' => 'Find group by uuid.',
+ 'summary' => 'Find group by uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'groups'
+ ],
+ 'uuid' => [
+ 'description' => 'Group UUID (entity uuid)',
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'create' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Create new Group. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Create new Group entity',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'groups'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'destroy' => [
+ 'httpMethod' => 'DELETE',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Delete a Group entity.',
+ 'summary' => 'Delete a Group entity by name or uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'groups'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ]
+ ],
+ 'update' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Update a Group entity.',
+ 'summary' => 'Update a Group entity by name or uuid and using JSON data',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'groups'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ]
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifications.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifications.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifications.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifications.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifiers.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifiers.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifiers.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Notifiers.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Receipts.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Receipts.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Receipts.php
new file mode 100644
index 0000000..a51055f
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Receipts.php
@@ -0,0 +1,24 @@
+<?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 [
+
+ 'all' => [],
+ 'find' => [],
+ 'create' => [],
+ 'destroy' => [],
+ 'update' => []
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Roles.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Roles.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Roles.php
new file mode 100644
index 0000000..a0f7c43
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Roles.php
@@ -0,0 +1,381 @@
+<?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 [
+
+ 'all' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query an app collection.',
+ 'summary' => 'Query an app collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Collection',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'roles'
+ ],
+ '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,
+ 'default' => 10000
+ ],
+ 'filter' => [
+ 'description' => 'a condition to filter on',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'find' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query Roles.',
+ 'summary' => 'Query the roles collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'roles'
+ ],
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'findById' => ['httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{uuid}',
+ 'notes' => 'Find Role by uuid.',
+ 'summary' => 'Find role by uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'roles'
+ ],
+ 'uuid' => [
+ 'description' => 'Group UUID (entity uuid)',
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'create' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Create new Role. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Create new Role entity',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'roles'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'destroy' => [
+ 'httpMethod' => 'DELETE',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Delete a Role entity.',
+ 'summary' => 'Delete a Role entity by name or uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'roles'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ]
+ ],
+ 'update' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Update a Role entity.',
+ 'summary' => 'Update a Roles entity by name or uuid and using JSON data',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Entity',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'roles'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ]
+];
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/bf7aaba0/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Users.php
----------------------------------------------------------------------
diff --git a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Users.php b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Users.php
new file mode 100644
index 0000000..2b8e199
--- /dev/null
+++ b/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Users.php
@@ -0,0 +1,381 @@
+<?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 [
+
+ 'all' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query an app collection.',
+ 'summary' => 'Query an app collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\Collection',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'users'
+ ],
+ '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,
+ 'default' => 10000
+ ],
+ 'filter' => [
+ 'description' => 'a condition to filter on',
+ 'location' => 'query',
+ 'type' => 'integer',
+ 'required' => false,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'find' => [
+ 'httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Query Users.',
+ 'summary' => 'Query the users collection',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\User',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'users'
+ ],
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'findById' => ['httpMethod' => 'GET',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{uuid}',
+ 'notes' => 'Find User by uuid.',
+ 'summary' => 'Find user by uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\User',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ 'parameters' => [
+ 'app_name_or_uuid' => [
+ 'description' => 'app name or uuid',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ],
+ 'collection' => [
+ 'description' => 'collection name (entity type)',
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'default' => 'users'
+ ],
+ 'uuid' => [
+ 'description' => 'User UUID (entity uuid)',
+ '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,
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Other parameters",
+ 'location' => 'query'
+ ]
+ ],
+ 'create' => [
+ 'httpMethod' => 'POST',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}',
+ 'notes' => 'Create new User. See Usergrid documentation for JSON format of body.',
+ 'summary' => 'Create new User entity',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\User',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'users'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ],
+ 'destroy' => [
+ 'httpMethod' => 'DELETE',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Delete a User entity.',
+ 'summary' => 'Delete a User entity by name or uuid',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\User',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'users'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ]
+ ],
+ 'update' => [
+ 'httpMethod' => 'PUT',
+ 'uri' => '/{org_name_or_uuid}/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}',
+ 'notes' => 'Update a User entity.',
+ 'summary' => 'Update a User entity by name or uuid and using JSON data',
+ 'responseClass' => 'Apache\Usergrid\Api\Models\User',
+ 'responseType' => 'class',
+ 'errorResponses' => $errors,
+ '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,
+ 'default' => 'users'
+ ],
+ 'access_token' => [
+ 'description' => 'The OAuth2 access token',
+ 'location' => 'query',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'org_name_or_uuid' => [
+ 'location' => 'uri',
+ 'type' => 'string',
+ 'required' => true,
+ 'description' => 'Organization name or uuid'
+ ]
+ ],
+ 'additionalParameters' => [
+ "description" => "Entity data",
+ 'location' => 'json'
+ ]
+ ]
+];
\ No newline at end of file