Switch over to generating api-docs via Groovy, Swagger and Mustache.java.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/445ac3ec Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/445ac3ec Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/445ac3ec Branch: refs/heads/ug2-doc-update Commit: 445ac3ecfc6f1759f9e35165127e31633110ca83 Parents: cefc789 Author: Dave Johnson <snoopd...@apache.org> Authored: Mon Aug 3 11:40:01 2015 -0400 Committer: Dave Johnson <snoopd...@apache.org> Committed: Mon Aug 3 11:40:01 2015 -0400 ---------------------------------------------------------------------- docs/_static/css/theme.css | 174 ++ docs/default-entities/activity.md | 76 - docs/default-entities/application.md | 91 - docs/default-entities/asset.md | 51 - docs/default-entities/device.md | 36 - docs/default-entities/event.md | 61 - docs/default-entities/folder.md | 46 - docs/default-entities/group.md | 41 - docs/default-entities/notification.md | 51 - docs/default-entities/notifier.md | 46 - docs/default-entities/receipt.md | 46 - docs/default-entities/role.md | 51 - docs/default-entities/sources/activity.txt | 1 - docs/default-entities/sources/application.txt | 1 - docs/default-entities/sources/asset.txt | 1 - docs/default-entities/sources/csv2md.groovy | 42 - docs/default-entities/sources/device.txt | 1 - docs/default-entities/sources/event.txt | 1 - docs/default-entities/sources/folder.txt | 1 - docs/default-entities/sources/group.txt | 1 - docs/default-entities/sources/notification.txt | 1 - docs/default-entities/sources/notifier.txt | 1 - docs/default-entities/sources/receipt.txt | 1 - docs/default-entities/sources/role.txt | 1 - docs/default-entities/sources/user.txt | 1 - docs/default-entities/user.md | 41 - docs/index.rst | 33 +- docs/pom.xml | 91 - docs/rest-endpoints/access-token.md | 42 - docs/rest-endpoints/activities.md | 28 - docs/rest-endpoints/admin-users.md | 77 - docs/rest-endpoints/api-docs.md | 2945 +++++++++++++++++++ docs/rest-endpoints/collections.md | 84 - docs/rest-endpoints/events.md | 21 - docs/rest-endpoints/groups.md | 56 - docs/rest-endpoints/organizations.md | 111 - docs/rest-endpoints/roles.md | 76 - docs/rest-endpoints/sources/access-token.txt | 1 - docs/rest-endpoints/sources/activities.txt | 1 - docs/rest-endpoints/sources/admin-users.txt | 1 - docs/rest-endpoints/sources/collections.txt | 1 - docs/rest-endpoints/sources/csv2md.groovy | 43 - docs/rest-endpoints/sources/events.txt | 1 - docs/rest-endpoints/sources/groups.txt | 1 - docs/rest-endpoints/sources/organizations.txt | 1 - docs/rest-endpoints/sources/roles.txt | 1 - docs/rest-endpoints/sources/users.txt | 1 - docs/rest-endpoints/users.md | 90 - docs/src/main/groovy/ApiDocGenerator.groovy | 176 ++ docs/src/main/resources/model.mustache | 21 + docs/src/main/resources/operation.mustache | 21 + docs/src/main/resources/usergrid-swagger.yaml | 2319 +++++++++++++++ docs/update-api-docs.sh | 2 + docs/usergrid-swagger.yaml | 2316 --------------- 54 files changed, 5661 insertions(+), 3765 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/_static/css/theme.css ---------------------------------------------------------------------- diff --git a/docs/_static/css/theme.css b/docs/_static/css/theme.css index 3de5ab1..17d12b3 100755 --- a/docs/_static/css/theme.css +++ b/docs/_static/css/theme.css @@ -5334,3 +5334,177 @@ span[id*='MathJax-Span'] { tr.ug-even td { background-color: #EAF2F5; } + +h2.usergrid-GET-heading { + color: white; + background-color: dodgerblue; +} +h2.usergrid-POST-heading { + color: white; + background-color: green; +} +h2.usergrid-PUT-heading { + color: white; + background-color: orange; +} +h2.usergrid-DELETE-heading { + color: white; + background-color: red; +} + +/* css from petstore example */ + +body { + font-family: Trebuchet MS, sans-serif; + font-size: 15px; + color: #444; + margin-right: 24px; +} + +h1 { + font-size: 25px; +} +h2 { + font-size: 20px; +} +h3 { + font-size: 16px; + font-weight: bold; +} +hr { + height: 1px; + border: 0; + color: #ddd; + background-color: #ddd; + display: none; +} + +.app-desc { + clear: both; + margin-left: 20px; +} +.param-name { + width: 100%; +} +.license-info { + margin-left: 20px; +} + +.license-url { + margin-left: 20px; +} + +.model { + margin: 0 0 0px 20px; +} + +.method { + margin-left: 20px; +} + +.method-notes { + margin: 10px 0 20px 0; + font-size: 90%; + color: #555; +} + +pre { + padding: 10px; + margin-bottom: 2px; +} + +pre.get { + background-color: #0f6ab4; +} + +pre.post { + background-color: #10a54a; +} + +pre.put { + background-color: #c5862b; +} + +pre.delete { + background-color: #a41e22; +} + +.huge { + color: #fff; +} + +pre.example { + background-color: #f3f3f3; + padding: 10px; + border: 1px solid #ddd; +} + +code { + white-space: pre; +} + +.nickname { + font-weight: bold; +} + +.method-path { + font-size: 1.5em; + background-color: #0f6ab4; +} + +.parameter { + width: 500px; +} + +.param { + width: 500px; + padding: 10px 0 0 20px; + font-weight: bold; +} + +.param-desc { + width: 700px; + padding: 0 0 0 20px; + color: #777; +} + +.param-type { + font-style: italic; +} + +.field-label { + padding: 0; + margin: 0; + clear: both; +} + +.field-items { + padding: 0 0 15px 0; + margin-bottom: 15px; +} + +.return-type { + clear: both; + padding-bottom: 10px; +} + +.param-header { + font-weight: bold; +} + +.method-tags { + text-align: right; +} + +.method-tag { + background: none repeat scroll 0% 0% #24A600; + border-radius: 3px; + padding: 2px 10px; + margin: 2px; + color: #FFF; + display: inline-block; + text-decoration: none; +} + + + http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/activity.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/activity.md b/docs/default-entities/activity.md deleted file mode 100644 index 462a3de..0000000 --- a/docs/default-entities/activity.md +++ /dev/null @@ -1,76 +0,0 @@ -# Activity - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'activity'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>actor</td> - <td>ActivityObject</td> - <td>Required. Entity that performed the 'action' of the activity (see JSON Activity Streams 1.0 specification). By default, the UUID of the user who performed the action is recorded as the value of the 'uuid' property of this object.</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>verb</td> - <td>string</td> - <td>Required. The action performed by the user (for example, post)</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>published</td> - <td>long</td> - <td>Required. UTC timestamp in milliseconds of when the activity was published</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>content</td> - <td>string</td> - <td>Optional. Description of the activity</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>icon</td> - <td>MediaLink</td> - <td>Optional. Visual representation of a media link resource (see JSON Activity Streams 1.0 specification)</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>category</td> - <td>string</td> - <td>Optional. Category used to organize activities</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>published</td> - <td>long</td> - <td>Optional. UTC timestamp in milliseconds when the activity was published</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>object</td> - <td>ActivityObject</td> - <td>Optional. Object on which the action is performed (see JSON Activity Streams 1.0 specification)</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>title</td> - <td>string</td> - <td>Optional. Title or headline for the activity</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the activity entity, as well as additional data entities associated with the activity. The following properties are included in metadata: path: Path to retrieve the activity entity, including the UUID of the user entity associated with the activity and the UUID of the activity entity</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/application.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/application.md b/docs/default-entities/application.md deleted file mode 100644 index c5195d6..0000000 --- a/docs/default-entities/application.md +++ /dev/null @@ -1,91 +0,0 @@ -# Application - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>String</td> - <td>Type of entity, in this case 'application'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Application name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>accesstokenttl</td> - <td>long</td> - <td>Optional. Time to live value for an access token obtained within the application</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>organizationName</td> - <td>string</td> - <td>Name of the organization the application belongs to</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>applicationName</td> - <td>string</td> - <td>Name of the application</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>title</td> - <td>string</td> - <td>Optional. Application title</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>description</td> - <td>string</td> - <td>Optional. Application description</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>activated</td> - <td>boolean</td> - <td>Optional. Whether application is activated</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>disabled</td> - <td>boolean</td> - <td>Optional. Whether application is administratively disabled</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>allowOpenRegistration</td> - <td>boolean</td> - <td>Optional. Whether application allows any user to register</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>registrationRequiresEmailConfirmation</td> - <td>boolean</td> - <td>Optional. Whether registration requires email confirmation</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>registrationRequiresAdminApproval</td> - <td>boolean</td> - <td>Optional. Whether registration requires admin approval</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>notify_admin_of_new_users</td> - <td>boolean</td> - <td>Optional. Whether application admins should be notified of new users</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides a 'collections' object with the relative paths to all entity collections associated with the application. The following collections are included in metadata by default: users: Path to retrieve the /users collection groups: Path to retrieve the /groups collection folders: Path to retrieve the /folders collection events: Path to retrieve the /events collection assets: Path to retrieve the /assets collection activities: Path to retrieve the /activities collection devices: Path to retrieve the /devices collection notifiers: Path to retrieve the /notifiers collection notifications: Path to retrieve the /notifications collection receipts: Path to retrieve the /receipts collection</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/asset.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/asset.md b/docs/default-entities/asset.md deleted file mode 100644 index 103f451..0000000 --- a/docs/default-entities/asset.md +++ /dev/null @@ -1,51 +0,0 @@ -# Asset - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'asset'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Asset name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>owner</td> - <td>UUID</td> - <td>Required. UUID of the user entity that owns the asset</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>path</td> - <td>string</td> - <td>Required. Relative path to the asset</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>content-type</td> - <td>string</td> - <td>MIME media type that describes the asset (see media types)</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the asset entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the asset entity</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/device.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/device.md b/docs/default-entities/device.md deleted file mode 100644 index b02480e..0000000 --- a/docs/default-entities/device.md +++ /dev/null @@ -1,36 +0,0 @@ -# Device - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'device'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Device name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the device entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the device entity, including the device UUID collections: Nested object that contains paths to data entity collections associated with the device. receipts: Receipt entities associated with the device users: User entities associated with the device</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/event.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/event.md b/docs/default-entities/event.md deleted file mode 100644 index 692c394..0000000 --- a/docs/default-entities/event.md +++ /dev/null @@ -1,61 +0,0 @@ -# Event - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>String</td> - <td>Type of entity, in this case 'event'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>timestamp</td> - <td>long</td> - <td>Required. UTC timestamp in milliseconds of when the application event occurred</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>user</td> - <td>UUID</td> - <td>Optional. UUID of application user that posted the event</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>group</td> - <td>UUID</td> - <td>Optional. UUID of application group that posted the event</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>category</td> - <td>string</td> - <td>Optional. Category used for organizing similar events</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>counters</td> - <td>map</td> - <td>Optional. Counter used for tracking number of similar events</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>message</td> - <td>string</td> - <td>Optional. Message describing event. Will be null if no message is specified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the event entity, as well as additional data entities associated with the event. The following properties are included in metadata: path: Path to retrieve the event entity</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/folder.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/folder.md b/docs/default-entities/folder.md deleted file mode 100644 index 5180937..0000000 --- a/docs/default-entities/folder.md +++ /dev/null @@ -1,46 +0,0 @@ -# Folder - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'folder'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Folder name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>owner</td> - <td>UUID</td> - <td>Required. UUID of the folder's owner</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>path</td> - <td>string</td> - <td>Required. Relative path to the folder</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the folder entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the folder entity</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/group.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/group.md b/docs/default-entities/group.md deleted file mode 100644 index 47eace8..0000000 --- a/docs/default-entities/group.md +++ /dev/null @@ -1,41 +0,0 @@ -# Group - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity UUID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'group'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>path</td> - <td>string</td> - <td>Required. Relative path where the group can be retrieved</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>title</td> - <td>string</td> - <td>Optional. Display name for the group entity</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the group entity, as well as additional data entities associated with the group. The following properties are included in metadata: path: Path to retrieve the group entity, including the group UUID sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Path to retrieve a list of roles associated with the group. permissions: Path to retrieve a list of all permissions directly associated with the group. If the group is associated with a role, the list will not include permissions associated with the role entity. collections: Nested object that contains paths to data entity collections associated with the group. activities: Activity entities associated with the group feed: A feed of all activities published by users associated with the group roles: Role entities associated with the group users: User entities associated with the group</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/notification.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/notification.md b/docs/default-entities/notification.md deleted file mode 100644 index 22ee397..0000000 --- a/docs/default-entities/notification.md +++ /dev/null @@ -1,51 +0,0 @@ -# Notification - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'notification'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>payloads</td> - <td>string</td> - <td>Required. The push notifications to be delivered, formatted as key-value pairs of notifier entities and messages (<notifier_name1>:<message1>, <notifier_name2>:<message2>, ...)</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>errorMessage</td> - <td>string</td> - <td>Error message returned by the notification service (APNs or GCM) if the notification fails entirely</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>scheduled</td> - <td>bool</td> - <td>Whether the notification is currently scheduled for delivery</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>state</td> - <td>string</td> - <td>The current delivery status of the notification: FINISHED, SCHEDULED or CANCELED.</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the notification entity, as well as additional data entities associated with the notification. The following properties are included in metadata: path: Path to retrieve the notification object collections: Nested object that contains paths to data entity collections associated with the notification. queue: Device entities scheduled to receive the push notification receipts: Receipt entities for delivery attempts</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/notifier.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/notifier.md b/docs/default-entities/notifier.md deleted file mode 100644 index 41f801c..0000000 --- a/docs/default-entities/notifier.md +++ /dev/null @@ -1,46 +0,0 @@ -# Notifier - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'notifier'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Notifier display name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>provider</td> - <td>string</td> - <td>Required. Push notification provider: apple or google</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>environment</td> - <td>string</td> - <td>Required. The environment that corresponds to your app: development or production</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/receipt.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/receipt.md b/docs/default-entities/receipt.md deleted file mode 100644 index e5f6279..0000000 --- a/docs/default-entities/receipt.md +++ /dev/null @@ -1,46 +0,0 @@ -# Receipt - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'notifier'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Notifier display name</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>provider</td> - <td>string</td> - <td>Required. Push notification provider: apple or google</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>environment</td> - <td>string</td> - <td>Required. The environment that corresponds to your app: development or production</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/role.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/role.md b/docs/default-entities/role.md deleted file mode 100644 index 3e03e90..0000000 --- a/docs/default-entities/role.md +++ /dev/null @@ -1,51 +0,0 @@ -# Role - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'role'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>name</td> - <td>string</td> - <td>Optional. Unique name that identifies the role</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>roleName</td> - <td>string</td> - <td>Identical to the value of the 'name' property by default</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>title</td> - <td>string</td> - <td>Identical to the value of the 'name' property by default</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>inactivity</td> - <td>string</td> - <td>The amount of time, in milliseconds, that a user or group associated with the role can be inactive before they lose the permissions associated with that role. By default, 'inactivity' is set to 0 so that the user/group never loses the role.</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the role entity, as well as additional data entities associated with the role. The following properties are included in metadata: path: Path to retrieve the role entity sets: Nested object that contains the 'permissions' property. permissions: Path to retrieve a list of all permissions associated with the role. collections: Nested object that contains paths to data entity collections associated with the role. groups: Group entities associated with the role users: User entities associated with the role</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/activity.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/activity.txt b/docs/default-entities/sources/activity.txt deleted file mode 100644 index a8237f2..0000000 --- a/docs/default-entities/sources/activity.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'activity' created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified actor ActivityObject Required. Entity that performed the 'action' of the activity (see JSON Activity Streams 1.0 specification). By default, the UUID of the user who performed the action is recorded as the value of the 'uuid' property of this object. verb string Required. The action performed by the user (for example, post) published long Required. UTC timestamp in milliseconds of when the activity was published content string Optional. Description of the activity icon MediaLink Optional. Visual representation of a media link resource (see JSON Activity Streams 1.0 specification) category string Optional. Category used to organize activities published long Optional. UTC timestamp in milliseconds when the activity was published object ActivityObject Opti onal. Object on which the action is performed (see JSON Activity Streams 1.0 specification) title string Optional. Title or headline for the activity metadata object A nested, JSON-formatted object that provides the relative path to the activity entity, as well as additional data entities associated with the activity. The following properties are included in metadata: path: Path to retrieve the activity entity, including the UUID of the user entity associated with the activity and the UUID of the activity entity \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/application.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/application.txt b/docs/default-entities/sources/application.txt deleted file mode 100644 index fde95f1..0000000 --- a/docs/default-entities/sources/application.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type String Type of entity, in this case 'application' name string Optional. Application name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified accesstokenttl long Optional. Time to live value for an access token obtained within the application organizationName string Name of the organization the application belongs to applicationName string Name of the application title string Optional. Application title description string Optional. Application description activated boolean Optional. Whether application is activated disabled boolean Optional. Whether application is administratively disabled allowOpenRegistration boolean Optional. Whether application allows any user to register registrationRequiresEmailConfirmation boolean Optional. Whether registration requires email confirmation registrationRequiresAdminApproval boolean Optional. Whether registration requires admin approval notify_admin_of_new_users boolean Optional. Whether application admins should be notified of new users metadata object A nested, JSON-formatted object that provides a 'collections' object with the relative paths to all entity collections associated with the application. The following collections are included in metadata by default: users: Path to retrieve the /users collection groups: Path to retrieve the /groups collection folders: Path to retrieve the /folders collection events: Path to retrieve the /events collection assets: Path to retrieve the /assets collection activities: Path to retrieve the /activities collection devices: Path to retrieve the /devices collection notifiers: Path to retrieve the /notifiers collection notifications: Path to retrieve the /notifications collection receipts: Path to retrieve the /receipts collection \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/asset.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/asset.txt b/docs/default-entities/sources/asset.txt deleted file mode 100644 index 463fe44..0000000 --- a/docs/default-entities/sources/asset.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'asset' name string Optional. Asset name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified owner UUID Required. UUID of the user entity that owns the asset path string Required. Relative path to the asset content-type string MIME media type that describes the asset (see media types) metadata object A nested, JSON-formatted object that provides the relative path to the asset entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the asset entity \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/csv2md.groovy ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/csv2md.groovy b/docs/default-entities/sources/csv2md.groovy deleted file mode 100644 index 8c12f39..0000000 --- a/docs/default-entities/sources/csv2md.groovy +++ /dev/null @@ -1,42 +0,0 @@ -def dir = new File("."); -def files = dir.list(); -files.each() { fileName -> - if ( fileName.endsWith(".txt") ) { - - def baseName = fileName.substring(0, fileName.length() - 4); - - def outputFile = new File("../" + baseName + ".md"); - outputFile.withWriter('utf-8') { writer -> - - def inputFile = new File(fileName); - def count = 0; - writer.writeLine "# ${baseName.capitalize()}" - writer.writeLine "" - writer.writeLine "<!-- DO NOT EDIT THIS GENERATED FILE -->"; - writer.writeLine "" - writer.writeLine "<table class='usergrid-table entities-table'>"; - - inputFile.eachLine { line -> - def parts = line.split("\\t") - def evenodd = count % 2 ? "even" : "odd"; - if ( count == 0 ) { - writer.writeLine " <tr>" - parts.each() { part -> - writer.writeLine " <th>" + part + "</th>"; - } - writer.writeLine " </tr>"; - } else { - writer.writeLine " <tr class='ug-${evenodd} usergrid-table'>"; - parts.each() { part -> - writer.writeLine " <td>" + part + "</td>"; - } - writer.writeLine " </tr>"; - } - count++; - } - writer.writeLine "</table>"; - - } - } -} - http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/device.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/device.txt b/docs/default-entities/sources/device.txt deleted file mode 100644 index a65adec..0000000 --- a/docs/default-entities/sources/device.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'device' name string Optional. Device name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified metadata object A nested, JSON-formatted object that provides the relative path to the device entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the device entity, including the device UUID collections: Nested object that contains paths to data entity collections associated with the device. receipts: Receipt entities associated with the device users: User entities associated with the device \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/event.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/event.txt b/docs/default-entities/sources/event.txt deleted file mode 100644 index c4dbcb3..0000000 --- a/docs/default-entities/sources/event.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type String Type of entity, in this case 'event' created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified timestamp long Required. UTC timestamp in milliseconds of when the application event occurred user UUID Optional. UUID of application user that posted the event group UUID Optional. UUID of application group that posted the event category string Optional. Category used for organizing similar events counters map Optional. Counter used for tracking number of similar events message string Optional. Message describing event. Will be null if no message is specified metadata object A nested, JSON-formatted object that provides the relative path to the event entity, as well as additional data entities associated with the event. The following properties are included in metadata: path: Path to retrieve the event entity \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/folder.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/folder.txt b/docs/default-entities/sources/folder.txt deleted file mode 100644 index bf65c85..0000000 --- a/docs/default-entities/sources/folder.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'folder' name string Optional. Folder name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified owner UUID Required. UUID of the folder's owner path string Required. Relative path to the folder metadata object A nested, JSON-formatted object that provides the relative path to the folder entity, as well as additional data entities associated with the asset. The following properties are included in metadata: path: Path to retrieve the folder entity \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/group.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/group.txt b/docs/default-entities/sources/group.txt deleted file mode 100644 index d31a8e8..0000000 --- a/docs/default-entities/sources/group.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity UUID type string Type of entity, in this case 'group' created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified path string Required. Relative path where the group can be retrieved title string Optional. Display name for the group entity metadata object A nested, JSON-formatted object that provides the relative path to the group entity, as well as additional data entities associated with the group. The following properties are included in metadata: path: Path to retrieve the group entity, including the group UUID sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Path to retrieve a list of roles associated with the group. permissions: Path to retrieve a list of all permissions directly associated with the group. If the group is associated with a role, the list will not include permissions associated with the role entity. col lections: Nested object that contains paths to data entity collections associated with the group. activities: Activity entities associated with the group feed: A feed of all activities published by users associated with the group roles: Role entities associated with the group users: User entities associated with the group \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/notification.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/notification.txt b/docs/default-entities/sources/notification.txt deleted file mode 100644 index df1e4bf..0000000 --- a/docs/default-entities/sources/notification.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'notification' created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified payloads string Required. The push notifications to be delivered, formatted as key-value pairs of notifier entities and messages (<notifier_name1>:<message1>, <notifier_name2>:<message2>, ...) errorMessage string Error message returned by the notification service (APNs or GCM) if the notification fails entirely scheduled bool Whether the notification is currently scheduled for delivery state string The current delivery status of the notification: FINISHED, SCHEDULED or CANCELED. metadata object A nested, JSON-formatted object that provides the relative path to the notification entity, as well as additional data entities associated with the notification. The following properties are included in metadata: path: Path to retrieve the notification object collections: Nested object that contains paths to data entity collections associated with the notification. queue: Device entities scheduled to receive the push notification receipts: Receipt entities for delivery attempts \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/notifier.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/notifier.txt b/docs/default-entities/sources/notifier.txt deleted file mode 100644 index 238ff62..0000000 --- a/docs/default-entities/sources/notifier.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'notifier' name string Optional. Notifier display name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified provider string Required. Push notification provider: apple or google environment string Required. The environment that corresponds to your app: development or production metadata object A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/receipt.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/receipt.txt b/docs/default-entities/sources/receipt.txt deleted file mode 100644 index 238ff62..0000000 --- a/docs/default-entities/sources/receipt.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'notifier' name string Optional. Notifier display name created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified provider string Required. Push notification provider: apple or google environment string Required. The environment that corresponds to your app: development or production metadata object A nested, JSON-formatted object that provides the relative path to the notifier entity path: Path to retrieve the notification object \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/role.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/role.txt b/docs/default-entities/sources/role.txt deleted file mode 100644 index 20d303f..0000000 --- a/docs/default-entities/sources/role.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'role' name string Optional. Unique name that identifies the role created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified roleName string Identical to the value of the 'name' property by default title string Identical to the value of the 'name' property by default inactivity string The amount of time, in milliseconds, that a user or group associated with the role can be inactive before they lose the permissions associated with that role. By default, 'inactivity' is set to 0 so that the user/group never loses the role. metadata object A nested, JSON-formatted object that provides the relative path to the role entity, as well as additional data entities associated with the role. The following properties are included in metadata: path: Path to retrieve the role entity sets: Nested object that contains the 'permissions' pr operty. permissions: Path to retrieve a list of all permissions associated with the role. collections: Nested object that contains paths to data entity collections associated with the role. groups: Group entities associated with the role users: User entities associated with the role \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/sources/user.txt ---------------------------------------------------------------------- diff --git a/docs/default-entities/sources/user.txt b/docs/default-entities/sources/user.txt deleted file mode 100644 index 31c3e0d..0000000 --- a/docs/default-entities/sources/user.txt +++ /dev/null @@ -1 +0,0 @@ -uuid UUID Unique entity ID type string Type of entity, in this case 'user' created long UTC timestamp in milliseconds of when the entity was created modified long UTC timestamp in milliseconds of when the entity was last modified username string Required. Valid and unique username activated boolean Whether the user account is activated. Set to 'true' by default when the user is created. metadata object A nested, JSON-formatted object that provides the relative path to the user entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the user entity sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Deprecated. Use /users/\/roles|username\> instead. Path to retrieve a list of roles associated with the user. permissions: Path to retrieve a list of all permissions directly associated with the user. If the user is associated with a role or group, the list will n ot include permissions associated with those entities. collections: Nested object that contains paths to data entity collections associated with the user. activities: Activity entities associated with the user devices: Device entities associated with the user feed: A feed of all activities published by the user groups: Group entities associated with the user roles: Role entities associated with the user following: Users that the user is following followers: Users that are following the user \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/default-entities/user.md ---------------------------------------------------------------------- diff --git a/docs/default-entities/user.md b/docs/default-entities/user.md deleted file mode 100644 index ffee50e..0000000 --- a/docs/default-entities/user.md +++ /dev/null @@ -1,41 +0,0 @@ -# User - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table entities-table'> - <tr> - <th>uuid</th> - <th>UUID</th> - <th>Unique entity ID</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>type</td> - <td>string</td> - <td>Type of entity, in this case 'user'</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>created</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was created</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>modified</td> - <td>long</td> - <td>UTC timestamp in milliseconds of when the entity was last modified</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>username</td> - <td>string</td> - <td>Required. Valid and unique username</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>activated</td> - <td>boolean</td> - <td>Whether the user account is activated. Set to 'true' by default when the user is created.</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>metadata</td> - <td>object</td> - <td>A nested, JSON-formatted object that provides the relative path to the user entity, as well as additional data entities associated with the user. The following properties are included in metadata: path: Path to retrieve the user entity sets: Nested object that contains the 'rolenames' and 'permissions' properties. rolenames: Deprecated. Use /users/\/roles|username\> instead. Path to retrieve a list of roles associated with the user. permissions: Path to retrieve a list of all permissions directly associated with the user. If the user is associated with a role or group, the list will not include permissions associated with those entities. collections: Nested object that contains paths to data entity collections associated with the user. activities: Activity entities associated with the user devices: Device entities associated with the user feed: A feed of all activities published by the user groups: Group entities associated with the user roles: Role entities associated with the user following: Users that the user is following followers: Users that are following the user</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/index.rst ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 75fecfe..bcbca10 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -118,37 +118,10 @@ Apache Usergrid Documentation .. _rest-endpoints: .. toctree:: - :maxdepth: 2 - :caption: REST End-Points - - rest-endpoints/access-token - rest-endpoints/activities - rest-endpoints/admin-users - rest-endpoints/collections - rest-endpoints/events - rest-endpoints/groups - rest-endpoints/organization - rest-endpoints/roles - rest-endpoints/users - -.. _default-entities: + :maxdepth: 0 + :caption: API Reference -.. toctree:: - :maxdepth: 2 - :caption: Default Entities - - default-entities/activity - default-entities/asset - default-entities/event - default-entities/group - default-entities/notifier - default-entities/role - default-entities/user - default-entities/application - default-entities/device - default-entities/folder - default-entities/notification - default-entities/receipt + rest-endpoints/api-docs .. _sdks: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/pom.xml ---------------------------------------------------------------------- diff --git a/docs/pom.xml b/docs/pom.xml deleted file mode 100644 index 3757b38..0000000 --- a/docs/pom.xml +++ /dev/null @@ -1,91 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0"; - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> - <modelVersion>4.0.0</modelVersion> - - <!-- - Includes dependencies used by Groovy scripts in the docs directories. - --> - - <groupId>org.apache.usergrid</groupId> - <artifactId>doc-utils</artifactId> - <version>1.0.3-SNAPSHOT</version> - - <build> - <plugins> - - <!-- Ran into these problems when trying to use Swagger-Codegen to generate HTML: --> - <!-- --> - <!-- 1. Usergrid Swagger file uses references and there's a bug in codegen: --> - <!-- https://github.com/swagger-api/swagger-codegen/issues/552 --> - <!-- --> - <!-- 2. The swagger-codegen-maven-plugin points at a discontinued version --> - <!-- of the Swagger-Codegen project (the old Wordnik version --> - - <!-- <plugin> - <groupId>com.garethevans.plugin</groupId> - <artifactId>swagger-codegen-maven-plugin</artifactId> - <version>0.0.1-SNAPSHOT</version> - <executions> - <execution> - <goals> - <goal>generate</goal> - </goals> - <configuration> - <inputSpec>usergrid-swagger.yaml</inputSpec> - <language>html</language> - <output>${project.build.directory}/generated-sources/swagger</output> - </configuration> - </execution> - </executions> - </plugin> --> - - </plugins> - </build> - - <dependencies> - - <dependency> - <groupId>io.swagger</groupId> - <artifactId>swagger-parser</artifactId> - <version>1.0.8</version> - </dependency> - - <dependency> - <groupId>io.swagger</groupId> - <artifactId>swagger-compat-spec-parser</artifactId> - <version>1.0.8</version> - </dependency> - - <dependency> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-api</artifactId> - <version>1.7.5</version> - <scope>test</scope> - </dependency> - - <dependency> - <groupId>org.slf4j</groupId> - <artifactId>slf4j-simple</artifactId> - <version>1.7.5</version> - <scope>test</scope> - </dependency> - - <dependency> - <groupId>junit</groupId> - <artifactId>junit</artifactId> - <version>4.12</version> - <scope>test</scope> - </dependency> - - <dependency> - <groupId>com.fasterxml.jackson.core</groupId> - <artifactId>jackson-core</artifactId> - <version>2.4.4</version> - <scope>test</scope> - </dependency> - - </dependencies> - -</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/rest-endpoints/access-token.md ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/access-token.md b/docs/rest-endpoints/access-token.md deleted file mode 100644 index a7838b7..0000000 --- a/docs/rest-endpoints/access-token.md +++ /dev/null @@ -1,42 +0,0 @@ -# Access-token - - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table rest-endpoints-table'> - <tr> - <th>End-Point</th> - <th>Method</th> - <th>Content-type</th> - <th>Description</th> - <th>Detail</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>"/management/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'"</td> - <td>POST</td> - <td>application/json</td> - <td>Obtain an access token (access type = organization)</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>"/management/token '{"grant_type":"password","username":"{username}",:"password":"{password}"}'"</td> - <td>POST</td> - <td>application/json</td> - <td>Obtain an access token (access type = admin user)</td> - <td>Detail</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>"/{org_id}/{app_id}/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'"</td> - <td>POST</td> - <td>application/json</td> - <td>Obtain an access token (access type = application)</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>"/{org_id}/{app_id}/token '{"grant_type":"password","username":"{username}","password":"{password}"}'"</td> - <td>POST</td> - <td>application/json</td> - <td>Obtain an access token (access type = application user)</td> - <td>Detail</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/rest-endpoints/activities.md ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/activities.md b/docs/rest-endpoints/activities.md deleted file mode 100644 index 76f6808..0000000 --- a/docs/rest-endpoints/activities.md +++ /dev/null @@ -1,28 +0,0 @@ -# Activities - - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table rest-endpoints-table'> - <tr> - <th>End-Point</th> - <th>Method</th> - <th>Content-type</th> - <th>Description</th> - <th>Detail</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>/{org_id}/{app_id}/users/ {uuid|username}/activities</td> - <td>POST</td> - <td>application/json</td> - <td>Create an activity</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>/{org_id}/{app_id}/groups/ {uuid|groupname}/activities</td> - <td>POST</td> - <td>application/json</td> - <td>Post an activity to a group</td> - <td>Detail</td> - </tr> -</table> http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/445ac3ec/docs/rest-endpoints/admin-users.md ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/admin-users.md b/docs/rest-endpoints/admin-users.md deleted file mode 100644 index e487337..0000000 --- a/docs/rest-endpoints/admin-users.md +++ /dev/null @@ -1,77 +0,0 @@ -# Admin-users - - -<!-- DO NOT EDIT THIS GENERATED FILE --> - -<table class='usergrid-table rest-endpoints-table'> - <tr> - <th>End-Point</th> - <th>Method</th> - <th>Content-type</th> - <th>Description</th> - <th>Detail</th> - </tr> - <tr class='ug-even usergrid-table'> - <td>/management/users</td> - <td>POST</td> - <td>application/json</td> - <td>Create an admin user</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>/management/users/{user|username|email|uuid}</td> - <td>PUT</td> - <td>application/json</td> - <td>Update an admin user</td> - <td>Detail</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>/management/users/{user|username|email|uuid}</td> - <td>GET</td> - <td>application/json</td> - <td>Get an admin user</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>/management/users/{user|username|email|uuid}/ password</td> - <td>PUT</td> - <td>application/json</td> - <td>Set an admin user's password</td> - <td>Detail</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>/managementusers/resetpw</td> - <td>GET</td> - <td>application/json</td> - <td>Initiate the reset of an admin user's password</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>/management/users/resetpw</td> - <td>POST</td> - <td>application/json</td> - <td>Complete the reset of an admin user's password</td> - <td>Detail</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>/management/users/{user|username|email|uuid}/activate? token={token}&confirm={confirm_email}</td> - <td>GET</td> - <td>application/json</td> - <td>Activate an admin user</td> - <td>Detail</td> - </tr> - <tr class='ug-odd usergrid-table'> - <td>/management/users/{user|username|email|uuid}/reactivate</td> - <td>GET</td> - <td>application/json</td> - <td>Reactivate an admin user</td> - <td>Detail</td> - </tr> - <tr class='ug-even usergrid-table'> - <td>/management/users/{user|username|email|uuid}/feed</td> - <td>GET</td> - <td>application/json</td> - <td>Get an admin user's feed</td> - <td>Detail</td> - </tr> -</table>
