You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sf...@apache.org on 2015/08/26 17:40:41 UTC
[30/36] usergrid git commit: Cherry pick: Remove operation cross
references from Markdown representation as Sphinx will not allow me to set
anchors.
http://git-wip-us.apache.org/repos/asf/usergrid/blob/2303eeac/docs/rest-endpoints/api-docs.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.md b/docs/rest-endpoints/api-docs.md
index 3a1b748..39c1ed9 100644
--- a/docs/rest-endpoints/api-docs.md
+++ b/docs/rest-endpoints/api-docs.md
@@ -4,16 +4,16 @@ Methods are organized by tag. Follow the methods are the [Model Definitions](#mo
<h2>Table of Contents</h2>
-* [Access-Tokens](#Access-Tokens)
-* [Activities](#Activities)
-* [Admin-Users](#Admin-Users)
-* [App-Users](#App-Users)
-* [Entities-Collections](#Entities-Collections)
-* [Events](#Events)
-* [Groups](#Groups)
-* [Notifications](#Notifications)
-* [Organizations-Applications](#Organizations-Applications)
-* [Permissions-Roles](#Permissions-Roles)
+* [Access-Tokens](#access-tokens)
+* [Activities](#activities)
+* [Admin-Users](#admin-users)
+* [App-Users](#app-users)
+* [Entities-Collections](#entities-collections)
+* [Events](#events)
+* [Groups](#groups)
+* [Notifications](#notifications)
+* [Organizations-Applications](#organizations-applications)
+* [Permissions-Roles](#permissions-roles)
<br>
<br>
@@ -27,6 +27,8 @@ Methods are organized by tag. Follow the methods are the [Model Definitions](#mo
<h2 class="usergrid-POST-heading">POST /management/token</h2>
+<a name="op-g6kolrjbqc"></a>
+
Login with Admin-User or Organization credentials.
<h3>Parameters</h3>
@@ -39,16 +41,18 @@ Login credentials either username/password or id/secret. (Specified in body).
__200__
* Description: Object containing access_token.
-* Schema: [AccessTokenResponse](#AccessTokenResponse)
+* Schema: [AccessTokenResponse](#accesstokenresponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
+<a name="op-1epwdjbmq5"></a>
+
Login with App-User or Application credentials.
<h3>Parameters</h3>
@@ -61,12 +65,12 @@ Login credentials either username/password or id/secret. (Specified in body).
__200__
* Description: Object containing access_token.
-* Schema: [AccessTokenResponse](#AccessTokenResponse)
+* Schema: [AccessTokenResponse](#accesstokenresponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Activities
@@ -74,6 +78,8 @@ __default__
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed</h2>
+<a name="op-ogkiyu6hiw"></a>
+
Get a group's feed through providing all the identifications.
<h3>Parameters</h3>
@@ -90,16 +96,18 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of group's activity.
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
+<a name="op-vxk180byil"></a>
+
Create an activity in the activities collection.
<h3>Parameters</h3>
@@ -118,16 +126,18 @@ One or more sets of activity properties. (Specified in body).
__200__
* Description: An array of user's activity.
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
+<a name="op-3e8mjg3ild"></a>
+
Retrieve a user's feed through providing all the identifications.
<h3>Parameters</h3>
@@ -144,12 +154,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of user's activity feed.
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Admin-Users
@@ -157,6 +167,8 @@ __default__
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/users</h2>
+<a name="op-0h23bhc1fo"></a>
+
Retrieve details about the admin users in an organization.
<h3>Parameters</h3>
@@ -169,16 +181,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved Admin user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
+<a name="op-tslbueyidt"></a>
+
Remove an admin user from an organization through providing both Id of application and organization.
<h3>Parameters</h3>
@@ -193,16 +207,18 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of deleted Admin user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /management/users</h2>
+<a name="op-qq0xsfwrk9"></a>
+
Create a whole new admin user.
<h3>Parameters</h3>
@@ -215,16 +231,18 @@ User entity with fields required for User creation. (Specified in body).
__200__
* Description: An API Response with a entities array containing the newly created Admin User.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
+<a name="op-d5w5sa7r6g"></a>
+
Initiate the reset of an admin user's password.
<h3>Parameters</h3>
@@ -235,16 +253,18 @@ Initiate the reset of an admin user's password.
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
+<a name="op-mtjnervjog"></a>
+
Complete the password reset through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
@@ -262,11 +282,13 @@ __200__
__default__
* Description:
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
+<a name="op-pqthpqruuu"></a>
+
Retrieve details about an admin user.
<h3>Parameters</h3>
@@ -279,16 +301,18 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An API Response with a entities array containing the Admin User.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
+<a name="op-mydfdnvoxu"></a>
+
Update the info of an admin user.
<h3>Parameters</h3>
@@ -301,16 +325,18 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An API Response with a entities array containing the updated Admin User
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
+<a name="op-ydubzwoyll"></a>
+
Activate an admin user from a link provIded in an email notification.
<h3>Parameters</h3>
@@ -327,16 +353,18 @@ Query statement of whether send confimation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
+<a name="op-tojtjxiv8m"></a>
+
Update an admin user's password through getting the newpassword and the old one for identification.
<h3>Parameters</h3>
@@ -351,16 +379,18 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
+<a name="op-fcsvsgqdmf"></a>
+
Reactivate an expired admin user.
<h3>Parameters</h3>
@@ -373,12 +403,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### App-Users
@@ -386,6 +416,8 @@ __default__
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users</h2>
+<a name="op-apfodlbfvw"></a>
+
Retrieve users though query statement.
<h3>Parameters</h3>
@@ -402,16 +434,18 @@ The query statement of the User. (Specified in query).
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
+<a name="op-vcebxhfnai"></a>
+
Create a user in the users collection through providing all the identifications.
<h3>Parameters</h3>
@@ -428,16 +462,18 @@ The properties of the user. (Specified in body).
__200__
* Description: An array of created user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
+<a name="op-rxzqi79iqh"></a>
+
Retrieve a user through providing all the identifications.
<h3>Parameters</h3>
@@ -454,16 +490,18 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
+<a name="op-eqfv3kglfr"></a>
+
Update a user through providing all the identifications.
<h3>Parameters</h3>
@@ -480,16 +518,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of updated user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
+<a name="op-q0sbwpkbrn"></a>
+
Remove a user through providing all the identifications.
<h3>Parameters</h3>
@@ -506,16 +546,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
+<a name="op-tz8aby9w7l"></a>
+
Set a user's password or reset the user's existing password.
<h3>Parameters</h3>
@@ -534,12 +576,12 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Entities-Collections
@@ -547,6 +589,8 @@ __default__
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}</h2>
+<a name="op-p3wfwppylf"></a>
+
Retrieve a user's collections or connections through query statement.
<h3>Parameters</h3>
@@ -567,16 +611,18 @@ The query statement of the user. (Specified in query).
__200__
* Description: An array of user's collections info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
+<a name="op-071uvg9uhh"></a>
+
Retrieve collection through query statement.
<h3>Parameters</h3>
@@ -595,16 +641,18 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of retrieved collection's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
+<a name="op-vlva22mrqv"></a>
+
Update collection through query statement.
<h3>Parameters</h3>
@@ -623,16 +671,18 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of updated collection's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<a name="op-yhl3yuzrpo"></a>
+
Add an entity to a collection through providing all the identifications.
<h3>Parameters</h3>
@@ -655,16 +705,18 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of added entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
+<a name="op-9gfzhzym3s"></a>
+
Remove an entity from a collection through providing all the identifications.
<h3>Parameters</h3>
@@ -687,16 +739,18 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<a name="op-usi7vrth9c"></a>
+
Retrieve an entity through providing Id of application, organization, collection and entity.
<h3>Parameters</h3>
@@ -715,16 +769,18 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of retrieved entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<a name="op-grwgmcmeiv"></a>
+
One or more properties can be updated with a single request.
<h3>Parameters</h3>
@@ -745,16 +801,18 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of updated entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
+<a name="op-3pvhj9pwas"></a>
+
Delete an entity from the collection.
<h3>Parameters</h3>
@@ -773,16 +831,18 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2>
+<a name="op-yaupy7fiha"></a>
+
When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type.
<h3>Parameters</h3>
@@ -801,12 +861,12 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of created custom entity's info.
-* Schema: [Entity](#Entity)
+* Schema: [Entity](#entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Events
@@ -814,6 +874,8 @@ __default__
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/events</h2>
+<a name="op-sahbmftblc"></a>
+
Create an event through providing both Id of organization and application.
<h3>Parameters</h3>
@@ -830,12 +892,12 @@ The required property of the event. (Specified in body).
__200__
* Description: An array of created event's info.
-* Schema: [Event](#Event)
+* Schema: [Event](#event)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Groups
@@ -843,6 +905,8 @@ __default__
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups</h2>
+<a name="op-lqawyn1jf7"></a>
+
Create a new group through providing both Id of organization and application.
<h3>Parameters</h3>
@@ -859,16 +923,18 @@ The property of the created group. (Specified in body).
__200__
* Description: An array of created group's info.
-* Schema: [Group](#Group)
+* Schema: [Group](#group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
+<a name="op-kah8tippl1"></a>
+
Create an activity to a specific group. In this case the activity is created in the activities collection and is accessible at the /activities endpoint to users who have the permission to read that endpoint. In addition, a relationship is established between the activity and the group, and because of that, the activity will appear in the group’s feed. The group 'owns' the activity. Also, the activity will be published in the feed of all users that are members of the group.
<h3>Parameters</h3>
@@ -887,16 +953,18 @@ One or more sets of activity properties. (Specified in body).
__200__
* Description:
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<a name="op-lwbnuuzwdp"></a>
+
Add a user to a group through providing all the identifications.
<h3>Parameters</h3>
@@ -915,16 +983,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
+<a name="op-yrptebgezb"></a>
+
Delete user from a group through providing all the identifications.
<h3>Parameters</h3>
@@ -943,16 +1013,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<a name="op-2yavprepml"></a>
+
Get a group through through providing all the identifications.
<h3>Parameters</h3>
@@ -969,16 +1041,18 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of retrieved group's info.
-* Schema: [Group](#Group)
+* Schema: [Group](#group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
+<a name="op-1ogt6s1meu"></a>
+
Update a group through providing all the identifications.
<h3>Parameters</h3>
@@ -995,12 +1069,12 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of updated group's info.
-* Schema: [Group](#Group)
+* Schema: [Group](#group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Notifications
@@ -1008,6 +1082,8 @@ __default__
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices</h2>
+<a name="op-gtyulxpfuh"></a>
+
Create notifications for user through targeting by location and providing all the identifications.
<h3>Parameters</h3>
@@ -1026,16 +1102,18 @@ The query statement of the location of the user. (Specified in query).
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/*/notifications</h2>
+<a name="op-fmxyekvv79"></a>
+
Create notifications for all devices. This request will target all device entities.
<h3>Parameters</h3>
@@ -1052,16 +1130,18 @@ These parameters are used when forming the notification portion of the request.
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/{deviceId}/notifications</h2>
+<a name="op-iycz2tnhqk"></a>
+
Create notifications for a single device. This request will target a specific device entity.
<h3>Parameters</h3>
@@ -1080,16 +1160,18 @@ These parameters are used when forming the notification portion of the request.
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/groups/{path}/notifications</h2>
+<a name="op-cz55hca573"></a>
+
Create notifications for a group. This request will target all users associated with a specific group entity.
<h3>Parameters</h3>
@@ -1108,16 +1190,18 @@ These parameters are used when forming the notification portion of the request.
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/notifications</h2>
+<a name="op-dt0m447vtt"></a>
+
Retrieve one or more notifications through providing all the identifications.
<h3>Parameters</h3>
@@ -1132,16 +1216,18 @@ One of the application's identification which includes name or uuid (same as
__200__
* Description: An array of retrieved notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+<a name="op-x3htrvnimm"></a>
+
Update a Notification in order to cancel the notifcation or set a new expiration time.
<h3>Parameters</h3>
@@ -1160,16 +1246,18 @@ Object with Notification fields to be updated. (Specified in body).
__200__
* Description: An API Response object containing an entity of type Notification.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+<a name="op-v8fksfkydk"></a>
+
Delete an unsent Notification from the system.
<h3>Parameters</h3>
@@ -1186,16 +1274,18 @@ One of the notification's identification which includes name or uuid. (Speci
__200__
* Description: API Response containing Notification entity that was deleted.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/receipts</h2>
+<a name="op-bierhevrl4"></a>
+
Retrieve one or more receipts through providing all the identifications.
<h3>Parameters</h3>
@@ -1210,16 +1300,18 @@ One of the application's identification which includes name or uuid (same as
__200__
* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#Receipt)
+* Schema: [Receipt](#receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/users/{userId}/notifications</h2>
+<a name="op-0e0sm3lp5t"></a>
+
Create notifications for a user. This request will target a specific user entity.
<h3>Parameters</h3>
@@ -1238,16 +1330,18 @@ These parameters are used when forming the notification portion of the request.
__200__
* Description: An array of created notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{deviceId}/*/receipts</h2>
+<a name="op-dkszriccku"></a>
+
Retrieve receipts associated with one or more devices through providing all the identifications.
<h3>Parameters</h3>
@@ -1264,16 +1358,18 @@ One of the device's identification which includes name or uuid. (Specified i
__200__
* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#Receipt)
+* Schema: [Receipt](#receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/queue</h2>
+<a name="op-t8pxsqwc6d"></a>
+
Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.
<h3>Parameters</h3>
@@ -1290,16 +1386,18 @@ One of the notification's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved device's info.
-* Schema: [Device](#Device)
+* Schema: [Device](#device)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/receipts</h2>
+<a name="op-xcy3ifmfkc"></a>
+
Retrieve receipts for one or more notifications through providing all the identifications.
<h3>Parameters</h3>
@@ -1316,16 +1414,18 @@ One of the notification's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved receipt's info.
-* Schema: [Receipt](#Receipt)
+* Schema: [Receipt](#receipt)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{receiptId}/*/notifications</h2>
+<a name="op-xoeujjr9zv"></a>
+
Retrieve notifications associated with one or more receipts through providing all the identifications.
<h3>Parameters</h3>
@@ -1342,12 +1442,12 @@ One of the receipt's identification which includes name or uuid. (Specified
__200__
* Description: An array of retrieved notification's info.
-* Schema: [Notification](#Notification)
+* Schema: [Notification](#notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Organizations-Applications
@@ -1355,6 +1455,8 @@ __default__
<h2 class="usergrid-POST-heading">POST /management/orgs</h2>
+<a name="op-vcwlytogis"></a>
+
Create an organization through a form post.
<h3>Parameters</h3>
@@ -1367,16 +1469,18 @@ A set of organization properties supplied through a form. (Specified in body).
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#Organization)
+* Schema: [Organization](#organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
+<a name="op-fuenkzdzx7"></a>
+
Retrieve an organization given a specified UUID or username.
<h3>Parameters</h3>
@@ -1389,16 +1493,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#Organization)
+* Schema: [Organization](#organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
+<a name="op-rlwkfscz2c"></a>
+
Activate an organization from a link provIded in an email notification.
<h3>Parameters</h3>
@@ -1415,16 +1521,18 @@ Send confirmation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
+<a name="op-7rcjv4cu57"></a>
+
Retrieve the applications in an organization through providing both Id of application and organization.
<h3>Parameters</h3>
@@ -1437,16 +1545,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved application data.
-* Schema: [AppData](#AppData)
+* Schema: [AppData](#appdata)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
+<a name="op-ytwesqwdgc"></a>
+
Remove an application from an organization through providing both Id of application and organization.
<h3>Parameters</h3>
@@ -1461,16 +1571,18 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of deleted application info.
-* Schema: [AppData](#AppData)
+* Schema: [AppData](#appdata)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<a name="op-9xfw58hzbu"></a>
+
Retrieve the client Id and client secret credentials for an application in an organization.
<h3>Parameters</h3>
@@ -1485,16 +1597,18 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved credentials info.
-* Schema: [Credential](#Credential)
+* Schema: [Credential](#credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
+<a name="op-lcqnmroopm"></a>
+
Generate the client Id and client secret credentials for an application in an organization.
<h3>Parameters</h3>
@@ -1509,16 +1623,18 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of generated credentials info.
-* Schema: [Credential](#Credential)
+* Schema: [Credential](#credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
+<a name="op-srhannjni2"></a>
+
Retrieve the credentials for an organization client.
<h3>Parameters</h3>
@@ -1531,16 +1647,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#Credential)
+* Schema: [Credential](#credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
+<a name="op-konb0d3faz"></a>
+
Generate whole new credentials for an organization client.
<h3>Parameters</h3>
@@ -1553,16 +1671,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#Credential)
+* Schema: [Credential](#credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
+<a name="op-jmorkmmhu8"></a>
+
Retrieve an organization's activity feed.
<h3>Parameters</h3>
@@ -1575,16 +1695,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
+<a name="op-2eplhfrllc"></a>
+
Reactivate an expired organization.
<h3>Parameters</h3>
@@ -1597,16 +1719,18 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of complete messages.
-* Schema: [Action](#Action)
+* Schema: [Action](#action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
+<a name="op-yitoouap1l"></a>
+
Retrieve an admin user's activity feed.
<h3>Parameters</h3>
@@ -1619,12 +1743,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of user's activity
-* Schema: [ActivityFeed](#ActivityFeed)
+* Schema: [ActivityFeed](#activityfeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
### Permissions-Roles
@@ -1632,6 +1756,8 @@ __default__
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles</h2>
+<a name="op-gzvozr9tpx"></a>
+
Retrieve the roles in an application through providing all the identifications.
<h3>Parameters</h3>
@@ -1646,16 +1772,18 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved role's info.
-* Schema: [Role](#Role)
+* Schema: [Role](#role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
+<a name="op-6cxfmtg8qw"></a>
+
Create a new role through providing all the identifications.
<h3>Parameters</h3>
@@ -1672,16 +1800,18 @@ The required properties of the role. (Specified in body).
__200__
* Description: An array of created role's info.
-* Schema: [Role](#Role)
+* Schema: [Role](#role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
+<a name="op-xhckyqr6ab"></a>
+
Remove permissions from a role.
<h3>Parameters</h3>
@@ -1700,16 +1830,18 @@ The query statement of the url pattern. (Specified in body).
__200__
* Description: Permissions object with array of the deleated Usergrid Permission strings.
-* Schema: [Permissions](#Permissions)
+* Schema: [Permissions](#permissions)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
+<a name="op-xvyk7zreff"></a>
+
Retrieve the users in a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1726,16 +1858,18 @@ One of the role's identification which includes name or uuid. (Specified in
__200__
* Description: An API Response with a entities array of Users.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<a name="op-muyc43xgrf"></a>
+
Add a user to a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1754,16 +1888,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
+<a name="op-ozbsrlozwi"></a>
+
Remove a user from a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1782,16 +1918,18 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#User)
+* Schema: [User](#user)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
+<a name="op-1obkbxb1zd"></a>
+
Remove a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1808,16 +1946,18 @@ The name of the role. (Specified in path).
__200__
* Description: An array of deleted role's info.
-* Schema: [Role](#Role)
+* Schema: [Role](#role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
+<a name="op-bb3svhbvfj"></a>
+
Retrieve permissions for a Role.
<h3>Parameters</h3>
@@ -1834,16 +1974,18 @@ One of the role's identification which includes name or uuid. (Specified in
__200__
* Description: Permissions object with array of Usergrid Permission strings.
-* Schema: [Permissions](#Permissions)
+* Schema: [Permissions](#permissions)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
+<a name="op-mu9s1qxs5u"></a>
+
Add permissions to a role through providing all the identifications.
<h3>Parameters</h3>
@@ -1862,12 +2004,12 @@ Permissions object with array of Usergrid Permission strings to be added. (Speci
__200__
* Description: Permissions object with array of Usergrid Permission strings.
-* Schema: [Permission](#Permission)
+* Schema: [Permission](#permission)
__default__
* Description: Unexpected error.
-* Schema: [Error](#Error)
+* Schema: [Error](#error)
## Models
@@ -1912,12 +2054,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/token](#op-MhD5hWgRwK)
-* [/{orgId}/{appId}/token](#op-9TDlDc0BL3)
-
-
### Action
@@ -1974,17 +2110,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/users/resetpw](#op-AiNhPeeyiq)
-* [/{orgId}/{appId}/users/{user}/password](#op-d0NWF6YZuK)
-* [/management/orgs/{orgId}/activate](#op-5138i0P1q8)
-* [/management/users/{userId}/activate](#op-c9LsV7Ulbr)
-* [/management/orgs/{orgId}/reactivate](#op-RIuF55JkgX)
-* [/management/users/{userId}/reactivate](#op-jk8tbzHamj)
-* [/management/users/{userId}/password](#op-yjg1hntm4R)
-
-
__Referring Definitions__
* [Receipt](#receipt)
@@ -2079,16 +2204,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/users/{userId}/activities](#op-SgbcdXdHSq)
-* [/{orgId}/{appId}/users/{userId}/feed](#op-JOpALhJR9x)
-* [/management/orgs/{orgId}/feed](#op-FsWAA6TQ6j)
-* [/{orgId}/{appId}/groups/{groupId}/feed](#op-vjWBovszxD)
-* [/management/users/{userId}/feed](#op-oyQqxIeMTj)
-* [/{orgId}/{appId}/groups/{groupId}/activities](#op-Y8sHuGSnUK)
-
-
### AddRole
@@ -2121,11 +2236,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/roles](#op-77UvdX1AKS)
-
-
### AppData
@@ -2174,12 +2284,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/orgs/{orgId}/apps](#op-FxESea37Iw)
-* [/management/orgs/{orgId}/apps/{appId}](#op-dfDXMn6FHh)
-
-
__Referring Definitions__
* [Organization](#organization)
@@ -2248,12 +2352,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/users/{userId}/activities](#op-SgbcdXdHSq)
-* [/{orgId}/{appId}/groups/{groupId}/activities](#op-Y8sHuGSnUK)
-
-
### CreateAdminUser
@@ -2302,11 +2400,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/users](#op-OrsKI3OblZ)
-
-
### CreateEntities
@@ -2323,12 +2416,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/{entitytype}](#op-vhYugcLtOU)
-* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-rIFHtzBMnq)
-
-
### CreateEvent
@@ -2353,11 +2440,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/events](#op-tbL4sW2gO4)
-
-
### CreateGroup
@@ -2390,11 +2472,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/groups](#op-cSFYOwc349)
-
-
### CreateNotifications
@@ -2411,15 +2488,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/groups/{path}/notifications](#op-HcxsWWHJuW)
-* [/{orgId}/{applicationId}/devices](#op-tHQHlcVc6O)
-* [/{orgId}/{applicationId}/devices/{deviceId}/notifications](#op-DhaimEfP36)
-* [/{orgId}/{applicationId}/users/{userId}/notifications](#op-GqqUlXEpw0)
-* [/{orgId}/{applicationId}/devices/*/notifications](#op-9Av28Sb6xD)
-
-
### CreateOrg
@@ -2476,11 +2544,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/orgs](#op-10Xly2uR81)
-
-
### CreateUser
@@ -2505,11 +2568,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/users](#op-B3JxnPdQnX)
-
-
### Credential
@@ -2550,14 +2608,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/orgs/{orgId}/credentials](#op-yvf6XFwT9U)
-* [/management/orgs/{orgId}/apps/{appId}/credentials](#op-BQVtNYKbr6)
-* [/management/orgs/{orgId}/credentials](#op-x2rOvoWwdu)
-* [/management/orgs/{orgId}/apps/{appId}/credentials](#op-l2sf6CY3kb)
-
-
### Device
@@ -2630,11 +2680,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/{notificationId}/*/queue](#op-813WAQfcPn)
-
-
### Entity
@@ -2707,19 +2752,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-6bY9NIsNDh)
-* [/{orgId}/{appId}/{collectionId}](#op-uUIPNDp91Q)
-* [/{orgId}/{appId}/users/{userId}/{relation}](#op-p76OEoqzeq)
-* [/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}](#op-fqEhlK2uYz)
-* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-gMtdxV5Km7)
-* [/{orgId}/{appId}/{collectionId}](#op-JNUUZzf2XB)
-* [/{orgId}/{appId}/{entitytype}](#op-vhYugcLtOU)
-* [/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}](#op-HEKlO2fyjg)
-* [/{orgId}/{appId}/{collectionId}/{entityId}](#op-rIFHtzBMnq)
-
-
__Referring Definitions__
* [Role](#role)
@@ -2767,7 +2799,6 @@ __Properties__
</table>
-
### Event
@@ -2839,11 +2870,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/events](#op-tbL4sW2gO4)
-
-
### Group
@@ -2924,13 +2950,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/groups](#op-cSFYOwc349)
-* [/{org_Id}/{app_Id}/groups/{groupId}](#op-DN1sgDsfHL)
-* [/{org_Id}/{app_Id}/groups/{groupId}](#op-WJCUsLbpoy)
-
-
### LoginCredentials
@@ -2987,12 +3006,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/token](#op-MhD5hWgRwK)
-* [/{orgId}/{appId}/token](#op-9TDlDc0BL3)
-
-
### Notification
@@ -3089,19 +3102,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-xHUyW9SEKp)
-* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-p1JCjxXaT6)
-* [/{orgId}/{applicationId}/{receiptId}/*/notifications](#op-tMb27wddix)
-* [/{orgId}/{applicationId}/groups/{path}/notifications](#op-HcxsWWHJuW)
-* [/{orgId}/{applicationId}/devices](#op-tHQHlcVc6O)
-* [/{orgId}/{applicationId}/notifications](#op-EVJZ1t5REk)
-* [/{orgId}/{applicationId}/devices/{deviceId}/notifications](#op-DhaimEfP36)
-* [/{orgId}/{applicationId}/users/{userId}/notifications](#op-GqqUlXEpw0)
-* [/{orgId}/{applicationId}/devices/*/notifications](#op-9Av28Sb6xD)
-
-
### NotificationUpdate
@@ -3142,11 +3142,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/notifications/{notificationId}](#op-xHUyW9SEKp)
-
-
### Organization
@@ -3275,12 +3270,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/orgs](#op-10Xly2uR81)
-* [/management/orgs/{orgId}](#op-fMZQcXXAv8)
-
-
### Permissions
@@ -3329,13 +3318,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/roles/{roleId}/permissions](#op-fB9nGqslMj)
-* [/{orgId}/{appId}/roles/{roleId}/permissions](#op-kaaoh5SC55)
-* [/{orgId}/{applicationId}/roles/{roleId}/permissions](#op-9VeULLNiHw)
-
-
### Receipt
@@ -3432,13 +3414,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{applicationId}/{notificationId}/*/receipts](#op-4ltskxwFlh)
-* [/{orgId}/{applicationId}/receipts](#op-Jrx6MJpfDT)
-* [/{orgId}/{applicationId}/{deviceId}/*/receipts](#op-dcBSAaCDdl)
-
-
### ResetPW
@@ -3471,12 +3446,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/users/{user}/password](#op-d0NWF6YZuK)
-* [/management/users/{userId}/password](#op-yjg1hntm4R)
-
-
### ResetPWMsg
@@ -3517,11 +3486,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/users/resetpw](#op-XfnvemSsD8)
-
-
### Role
@@ -3610,13 +3574,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/{orgId}/{appId}/roles](#op-Xs9X9TSi8B)
-* [/{orgId}/{appId}/roles](#op-77UvdX1AKS)
-* [/{orgId}/{appId}/roles/{rolename}](#op-OVMDaZHUiZ)
-
-
### User
@@ -3753,25 +3710,6 @@ __Properties__
</tr>
</table>
-__Referring API Paths__
-
-* [/management/orgs/{orgId}/users](#op-z7AQVyIzPn)
-* [/{orgId}/{appId}/users](#op-Rq1TkYSvPN)
-* [/management/users/{userId}](#op-Vh6g9ZgYMh)
-* [/{orgId}/{appId}/groups/{groupId}/users/{userId}](#op-tTRCEhAz0z)
-* [/{orgId}/{appId}/roles/{roleId}/users/{userId}](#op-Hscxz1kxfu)
-* [/{orgId}/{appId}/groups/{groupId}/users/{userId}](#op-EeS4c1jZT1)
-* [/management/users/{userId}](#op-SrpcXlZC86)
-* [/{orgId}/{appId}/users/{userId}](#op-0bju5bw1ZH)
-* [/{orgId}/{appId}/users/{userId}](#op-tRnoDrscSy)
-* [/{orgId}/{appId}/roles/{roleId}/users/{userId}](#op-D4YceDJCBp)
-* [/{orgId}/{appId}/users](#op-B3JxnPdQnX)
-* [/management/orgs/{orgId}/users/{userId}](#op-XQZui6aKiZ)
-* [/{orgId}/{appId}/roles/{roleId}/users](#op-UG5vx2zh0S)
-* [/{orgId}/{appId}/users/{userId}](#op-RDt20tQoio)
-* [/management/users](#op-OrsKI3OblZ)
-
-
__Referring Definitions__
* [AccessTokenResponse](#accesstokenresponse)
@@ -3827,7 +3765,6 @@ __Properties__
</tr>
</table>
-
__Referring Definitions__
* [Metadata](#metadata)
@@ -3888,7 +3825,6 @@ __Properties__
</tr>
</table>
-
__Referring Definitions__
* [CreateActivity](#createactivity)
@@ -3941,7 +3877,6 @@ __Properties__
</tr>
</table>
-
__Referring Definitions__
* [Receipt](#receipt)
@@ -4000,7 +3935,6 @@ __Properties__
</tr>
</table>
-
__Referring Definitions__
* [ActivityFeed](#activityfeed)
@@ -4037,7 +3971,6 @@ __Properties__
</tr>
</table>
-
__Referring Definitions__
* [Metadata](#metadata)
http://git-wip-us.apache.org/repos/asf/usergrid/blob/2303eeac/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
----------------------------------------------------------------------
diff --git a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
index 523cdd4..895918e 100644
--- a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
+++ b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
@@ -150,7 +150,7 @@ public class ApiDocGenerator {
urlOp.url = url;
urlOp.method = method;
urlOp.operation = operation;
- urlOp.opId = RandomStringUtils.randomAlphanumeric(10);
+ urlOp.opId = RandomStringUtils.randomAlphanumeric(10).toLowerCase();
urlOps.add(urlOp);
operation.getResponses().each { responseEntry ->
@@ -227,7 +227,7 @@ public class ApiDocGenerator {
// if parameter has a schema, assume that it is a reference
if ( responseEntry.value.schema != null) {
response.schema = responseEntry.value.schema.ref;
- response.schemaAnchor = responseEntry.value.schema.ref;
+ response.schemaAnchor = responseEntry.value.schema.ref.toLowerCase();
// keep track of paths that use each schema definition
if ( response.status.equals("200") ) {
@@ -327,7 +327,7 @@ public class ApiDocGenerator {
allTags.each{ tag ->
def atag = [:];
atag.name = tag;
- atag.link = tag;
+ atag.link = tag.toLowerCase();
tags.add(atag);
};
scope.tags = tags;
http://git-wip-us.apache.org/repos/asf/usergrid/blob/2303eeac/docs/src/main/resources/markdown/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/markdown/model.mustache b/docs/src/main/resources/markdown/model.mustache
index 2a41a00..395648f 100644
--- a/docs/src/main/resources/markdown/model.mustache
+++ b/docs/src/main/resources/markdown/model.mustache
@@ -24,15 +24,6 @@ __Properties__
{{/properties}}
</table>
-{{#hasReferrers}}
-__Referring API Paths__
-
-{{#referrers}}
-* [{{url}}](#op-{{opId}})
-{{/referrers}}
-
-{{/hasReferrers}}
-
{{#hasModelRefs}}
__Referring Definitions__
http://git-wip-us.apache.org/repos/asf/usergrid/blob/2303eeac/docs/src/main/resources/markdown/operation.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/markdown/operation.mustache b/docs/src/main/resources/markdown/operation.mustache
index cce0524..eb6a50f 100644
--- a/docs/src/main/resources/markdown/operation.mustache
+++ b/docs/src/main/resources/markdown/operation.mustache
@@ -1,6 +1,8 @@
<h2 class="usergrid-{{method}}-heading">{{method}} {{url}}</h2>
+<a name="op-{{opId}}"></a>
+
{{description}}
<h3>Parameters</h3>