http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/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 deleted file mode 100644 index 4006819..0000000 --- a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Roles.php +++ /dev/null @@ -1,381 +0,0 @@ -<?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\Role', - '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' - ] - ], - '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\Role', - '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\Role', - '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\Role', - '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\Role', - '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\Role', - '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' => 'r' - ], - '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/usergrid/blob/867060fa/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 deleted file mode 100644 index 0f28d4d..0000000 --- a/sdks/php5/apache-usergrid/src/Manifests/1.0.1/Users.php +++ /dev/null @@ -1,381 +0,0 @@ -<?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\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' - ] - ], - '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 http://git-wip-us.apache.org/repos/asf/usergrid/blob/867060fa/sdks/php5/apache-usergrid/src/Manifests/swagger-json/applications.json ---------------------------------------------------------------------- diff --git a/sdks/php5/apache-usergrid/src/Manifests/swagger-json/applications.json b/sdks/php5/apache-usergrid/src/Manifests/swagger-json/applications.json deleted file mode 100644 index f747154..0000000 --- a/sdks/php5/apache-usergrid/src/Manifests/swagger-json/applications.json +++ /dev/null @@ -1,1262 +0,0 @@ -{ - "basePath": "${basePath}", - "swaggerVersion": "1.1-SHAPSHOT.121026", - "apiVersion": "0.1", - "apis": [ - { - "path": "/apps/{app_name_or_uuid}/token", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_auth_password_get", - "summary": "Get app access token", - "notes": "Get the app access token. See the OAuth2 specification for details.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "grant_type", - "dataType": "string", - "description": "Grant type", - "defaultValue": "password", - "allowableValues": { - "values": [ - "password", - "client_credentials", - "refresh_token", - "authorization_code" - ], - "valueType": "LIST" - }, - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "username", - "dataType": "string", - "description": "Username (for grant_type=password)", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "password", - "dataType": "string", - "description": "Password (for grant_type=password)", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "client_id", - "dataType": "string", - "description": "Client ID (for grant_type=client_credentials)", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "client_secret", - "dataType": "string", - "description": "Client Secret (for grant_type=client_credentials)", - "required": false, - "allowMultiple": false, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_auth_password_post", - "summary": "Get app access token", - "notes": "Get the app access token. See the OAuth2 specification for details.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "grant_type", - "dataType": "string", - "description": "Grant type", - "defaultValue": "password", - "allowableValues": { - "values": [ - "password", - "client_credentials", - "refresh_token", - "authorization_code" - ], - "valueType": "LIST" - }, - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "username", - "dataType": "string", - "description": "Username (for grant_type=password)", - "required": false, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "password", - "dataType": "string", - "description": "Password (for grant_type=password)", - "required": false, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "client_id", - "dataType": "string", - "description": "Client ID (for grant_type=client_credentials)", - "required": false, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "client_secret", - "dataType": "string", - "description": "Client Secret (for grant_type=client_credentials)", - "required": false, - "allowMultiple": false, - "paramType": "post" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/authorize", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_authorize_get", - "summary": "Authorize app client", - "notes": "Authorize the app client. See the OAuth2 specification.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "response_type", - "dataType": "string", - "description": "Response type", - "defaultValue": "token", - "allowableValues": { - "values": [ - "token", - "code" - ], - "valueType": "LIST" - }, - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "client_id", - "dataType": "string", - "description": "Client ID", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "redirect_uri", - "dataType": "string", - "description": "Redirect URI", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "scope", - "dataType": "string", - "description": "Access Token Scope", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "state", - "dataType": "string", - "description": "Client State", - "required": false, - "allowMultiple": false, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_authorize_post", - "summary": "Authorize app client", - "notes": "Authorize the app client. See the OAuth2 specification.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "response_type", - "dataType": "string", - "description": "Response type", - "defaultValue": "token", - "allowableValues": { - "values": [ - "token", - "code" - ], - "valueType": "LIST" - }, - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "client_id", - "dataType": "string", - "description": "Client ID", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "redirect_uri", - "dataType": "string", - "description": "Redirect URI", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "scope", - "dataType": "string", - "description": "Access Token Scope", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "state", - "dataType": "string", - "description": "Client State", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "username", - "dataType": "string", - "description": "Username", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "password", - "dataType": "string", - "description": "Password", - "required": false, - "allowMultiple": false, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/credentials", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_credentials_get", - "summary": "Get app client credentials", - "notes": "Get the app client credentials.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_credentials_post", - "summary": "Generate app client credentials", - "notes": "Generate new app client credentials.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users", - "description": "Applications", - "operations": [ - { - "httpMethod": "POST", - "nickname": "app_user_json_post", - "summary": "Create new app user", - "notes": "Create new app user. See Usergrid documentation for JSON format of body.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "json", - "dataType": "string", - "description": "User to post", - "required": true, - "allowMultiple": false, - "paramType": "body" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_user_form_post", - "summary": "Create new app user", - "notes": "Create new app user using form post parameters.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "username", - "dataType": "string", - "description": "Username", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "name", - "dataType": "string", - "description": "User Full Name", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "email", - "dataType": "string", - "description": "User Email", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "password", - "dataType": "string", - "description": "User Password", - "required": true, - "allowMultiple": false, - "paramType": "post" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/resetpw", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_users_reset_password_get", - "summary": "Initiate a user password reset", - "notes": "Initiate a user password reset. Returns browser-viewable HTML page.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_users_reset_password_form_post", - "summary": "Complete a user password reset", - "notes": "Complete a user password reset. Handles form POST response.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "email", - "dataType": "string", - "description": "User Email", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "recaptcha_challenge_field", - "dataType": "string", - "description": "Recaptcha Challenge Field", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "recaptcha_response_field", - "dataType": "string", - "description": "Recaptcha Response Field", - "required": true, - "allowMultiple": false, - "paramType": "post" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_user_get", - "summary": "Returns the app user details", - "notes": "Returns the app user details.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "PUT", - "nickname": "app_user_json_put", - "summary": "Updates the app user details", - "notes": "Updates the app user details.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "json", - "dataType": "string", - "description": "App user details", - "required": true, - "allowMultiple": false, - "paramType": "body" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/activate", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_user_activate_get", - "summary": "Activates the app user", - "notes": "Activates the app user from link provided in email notification.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "token", - "dataType": "string", - "description": "Activation Token (supplied via email)", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "confirm", - "dataType": "boolean", - "description": "Send confirmation email", - "required": false, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/reactivate", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_user_reactivate_get", - "summary": "Reactivates the app user", - "notes": "Request app user reactivation.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/feed", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_user_feed_get", - "summary": "Get app user activity feed", - "notes": "Get app user activity feed.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/password", - "description": "Applications", - "operations": [ - { - "httpMethod": "PUT", - "nickname": "app_user_password_json_put", - "summary": "Set app user password", - "notes": "Set app user password. See Usergrid documentation for JSON format of body.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "access_token", - "dataType": "string", - "description": "The OAuth2 access token", - "required": true, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "json", - "dataType": "string", - "description": "Old and new password", - "required": true, - "allowMultiple": false, - "paramType": "body" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "User not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/users/{user_username_email_or_uuid}/resetpw", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_user_reset_password_get", - "summary": "Initiate a user password reset", - "notes": "Initiate a user password reset. Returns browser-viewable HTML page.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_user_reset_password_form_post", - "summary": "Complete a user password reset", - "notes": "Complete a user password reset. Handles form POST response.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "user_username_email_or_uuid", - "dataType": "string", - "description": "User username, email or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "recaptcha_challenge_field", - "dataType": "string", - "description": "Recaptcha Challenge Field", - "required": true, - "allowMultiple": false, - "paramType": "post" - }, - { - "name": "recaptcha_response_field", - "dataType": "string", - "description": "Recaptcha Response Field", - "required": true, - "allowMultiple": false, - "paramType": "post" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/{collection}", - "description": "Applications", - "operations": [ - { - "httpMethod": "GET", - "nickname": "app_entity_get", - "summary": "Query an app collection", - "notes": "Query an app collection.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "collection", - "dataType": "string", - "description": "collection name (entity type)", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "ql", - "dataType": "string", - "description": "a query in the query language", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "reversed", - "dataType": "boolean", - "description": "return results in reverse order", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "start", - "dataType": "string", - "description": "the first entity UUID to return", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "cursor", - "dataType": "string", - "description": "an encoded representation of the query position for paging", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "limit", - "dataType": "integer", - "description": "an encoded representation of the query position for paging", - "required": false, - "allowMultiple": false, - "paramType": "query" - }, - { - "name": "filter", - "dataType": "integer", - "description": "a condition to filter on", - "required": false, - "allowMultiple": true, - "paramType": "query" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "POST", - "nickname": "app_entity_json_post", - "summary": "Create new app entity", - "notes": "Create new app entity. See Usergrid documentation for JSON format of body.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "collection", - "dataType": "string", - "description": "collection name (entity type)", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "json", - "dataType": "string", - "description": "User to post", - "required": true, - "allowMultiple": false, - "paramType": "body" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - }, - { - "path": "/apps/{app_name_or_uuid}/{collection}/{entity_name_or_uuid}", - "description": "Applications", - "operations": [ - { - "httpMethod": "PUT", - "nickname": "app_entity_put", - "summary": "Update an app entity", - "notes": "Update an app entity in a collection.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "collection", - "dataType": "string", - "description": "collection name (entity type)", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "entity_name_or_uuid", - "dataType": "string", - "description": "entity name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "json", - "dataType": "string", - "description": "User to post", - "required": true, - "allowMultiple": false, - "paramType": "body" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - }, - { - "httpMethod": "DELETE", - "nickname": "app_entity_delete", - "summary": "Delete an app entity", - "notes": "Delete an app entity.", - "responseTypeInternal": "", - "responseClass": "response", - "parameters": [ - { - "name": "app_name_or_uuid", - "dataType": "string", - "description": "app name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "collection", - "dataType": "string", - "description": "collection name (entity type)", - "required": true, - "allowMultiple": false, - "paramType": "path" - }, - { - "name": "entity_name_or_uuid", - "dataType": "string", - "description": "entity name or uuid", - "required": true, - "allowMultiple": false, - "paramType": "path" - } - ], - "errorResponses": [ - { - "reason": "Invalid ID supplied", - "code": 400 - }, - { - "reason": "Application not found", - "code": 404 - } - ] - } - ] - } - ], - "models": { - "response": { - "properties": { - "id": { - "type": "long" - }, - "name": { - "type": "string" - } - }, - "id": "response" - } - } -} \ No newline at end of file
