You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@usergrid.apache.org by sn...@apache.org on 2015/07/31 17:09:33 UTC
[1/2] incubator-usergrid git commit: Update README.md,
some renaming and more removals and replacements of Apigee specific
things.
Repository: incubator-usergrid
Updated Branches:
refs/heads/ug2-doc-update 3abb90364 -> d3f778be8
Update README.md, some renaming and more removals and replacements of Apigee specific things.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/085a5d3a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/085a5d3a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/085a5d3a
Branch: refs/heads/ug2-doc-update
Commit: 085a5d3a57d398f3f49d14e2fd214b28d84ec992
Parents: 3abb903
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Jul 31 09:50:30 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Jul 31 09:50:30 2015 -0400
----------------------------------------------------------------------
docs/data-storage/collections.md | 6 ++--
docs/data-storage/entities.md | 4 +--
docs/getting-started/creating-account.md | 2 +-
docs/index.rst | 40 ++++++++--------------
docs/introduction/data-model.md | 2 +-
docs/introduction/usergrid-features.md | 4 +--
docs/reference/contribute-code.md | 8 +----
docs/reference/presentations.md | 21 ------------
docs/reference/presos-and-videos.md | 37 ++++++++++++++++++++
docs/reference/videos.md | 11 ------
docs/rest-endpoints/sources/access-token.txt | 2 +-
docs/rest-endpoints/sources/activities.txt | 2 +-
docs/rest-endpoints/sources/admin-users.txt | 2 +-
docs/rest-endpoints/sources/collections.txt | 2 +-
docs/rest-endpoints/sources/groups.txt | 2 +-
docs/rest-endpoints/sources/organizations.txt | 2 +-
docs/rest-endpoints/sources/roles.txt | 2 +-
docs/rest-endpoints/sources/users.txt | 2 +-
18 files changed, 70 insertions(+), 81 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/data-storage/collections.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/collections.md b/docs/data-storage/collections.md
index eda3662..c072104 100644
--- a/docs/data-storage/collections.md
+++ b/docs/data-storage/collections.md
@@ -2,7 +2,7 @@
## Creating Collections
-This article describes how to create collections in Advanced API Services. All entities are automatically associated with a corresponding collection based on the type property of the entity. You may create empty collections if you wish, but creating an entity of a new type will automatically create a corresponding collection for you. For example, creating a new custom "item" entity, creates an "items" collection.
+This article describes how to create collections in Advanced Usergrid. All entities are automatically associated with a corresponding collection based on the type property of the entity. You may create empty collections if you wish, but creating an entity of a new type will automatically create a corresponding collection for you. For example, creating a new custom "item" entity, creates an "items" collection.
__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
@@ -22,7 +22,7 @@ org Organization UUID or organization name
app Application UUID or application name
collection name Name of the collection to create.
-If the provided value is not a plural word, API Services will pluralize it. For example, providing 'item' will create a collection named 'items' but providing 'items' will not create 'itemses'.
+If the provided value is not a plural word, Usergrid will pluralize it. For example, providing 'item' will create a collection named 'items' but providing 'items' will not create 'itemses'.
### Example Request/Response
@@ -49,7 +49,7 @@ Response:
This article describes how to retrieve all of the entities in a collection.
-<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
By default, the API Services BaaS API returns 10 entities per request. For collections with more than 10 entities, use the returned 'cursor' property to retrieve the next 10 entities in the result set. You may also use the LIMIT parameter in a query string to increase the number of results returned. For more information on using cursors, see [Query Parameters](../data-queries/query-parameters.html).</p></div>
+<div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">
By default, the Usergrid API returns 10 entities per request. For collections with more than 10 entities, use the returned 'cursor' property to retrieve the next 10 entities in the result set. You may also use the LIMIT parameter in a query string to increase the number of results returned. For more information on using cursors, see [Query Parameters](../data-queries/query-parameters.html).</p></div>
__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/data-storage/entities.md
----------------------------------------------------------------------
diff --git a/docs/data-storage/entities.md b/docs/data-storage/entities.md
index 8a53923..5a70b18 100644
--- a/docs/data-storage/entities.md
+++ b/docs/data-storage/entities.md
@@ -3,12 +3,12 @@
## Creating Custom Data Entities
This article describes how to create custom data entities and entity properties. Entity types correspond to the name of collection to which they are posted. For example, if you create a new custom "dog" entity, a "dogs" collection will be created if one did not already exist. If a "dogs" collection already exists, the new "dog" entity will be saved in it. All user-defined properties are indexed, and strings that contain multiple words are keyword-indexed.
-The methods cited in this article should be used to create custom data entities. If you are using one of the API Services BaaS SDKs, use one of the entity type-specific SDK methods to create default data entities.
+The methods cited in this article should be used to create custom data entities. If you are using one of the Usergrid SDKs, use one of the entity type-specific SDK methods to create default data entities.
__Note__: Although not shown in the API examples below, you need to provide a valid access token with each API call. See Authenticating users and application clients for details.
### Creating a custom entity
-When a new entity is created, API Services 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. For example, creating a custom entity of type 'item' will automatically create a collection named 'items' in which all future 'item' entities will be saved.
+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. For example, creating a custom entity of type 'item' will automatically create a collection named 'items' in which all future 'item' entities will be saved.
### Request Syntax
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/getting-started/creating-account.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/creating-account.md b/docs/getting-started/creating-account.md
index 15a8329..1440926 100644
--- a/docs/getting-started/creating-account.md
+++ b/docs/getting-started/creating-account.md
@@ -1,5 +1,5 @@
# Creating an Usergrid Account
-To get started using the API Services BaaS, you'll need an Usergrid account. (Before reading this, you should already be familiar with what Usergrid can do to support your apps. If you're still curious about that, you might want to read Usergrid features first.)
+To get started using the Usergrid, you'll need an Usergrid account. (Before reading this, you should already be familiar with what Usergrid can do to support your apps. If you're still curious about that, you might want to read Usergrid features first.)
With an account, you get the following useful things:
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index 90ebe1a..75fecfe 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -113,17 +113,7 @@ Apache Usergrid Documentation
orgs-and-apps/applications
orgs-and-apps/organizations-admins
-
-.. _sdks:
-
-.. toctree::
- :maxdepth: 2
- :caption: Software Development Kits (SDKs)
- sdks/ios
- sdks/java
- sdks/javascript
- sdks/usage
.. _rest-endpoints:
@@ -159,34 +149,34 @@ Apache Usergrid Documentation
default-entities/folder
default-entities/notification
default-entities/receipt
-
-.. _references:
+
+.. _sdks:
.. toctree::
:maxdepth: 2
- :caption: Reference and other docs
+ :caption: Client SDKs
- reference/presentations
- reference/videos
-
+ sdks/ios
+ sdks/java
+ sdks/javascript
+ sdks/usage
+
.. _installation:
.. toctree::
:maxdepth: 2
- :caption: Installing the Usergrid stack
+ :caption: Installing the Stack
installation/ug1-deploy-to-tomcat
installation/ug1-launcher-quick-start
installation/ug2-deploy-to-tomcat
-
-.. _other:
+
+.. _about:
.. toctree::
:maxdepth: 2
- :caption: Other (obsolete?)
+ :caption: More about Usergrid
- entity-connections/relationships
- data-queries/query-language
- reference/contribute-code
- sdks/usage
-
+ reference/presos-and-videos
+ reference/contribute-code
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/introduction/data-model.md
----------------------------------------------------------------------
diff --git a/docs/introduction/data-model.md b/docs/introduction/data-model.md
index 67f7355..0278b97 100644
--- a/docs/introduction/data-model.md
+++ b/docs/introduction/data-model.md
@@ -13,7 +13,7 @@ In Usergrid, you can create one or more applications within an organization. App
Each application provides the infrastructure for storing, retrieving, updating and deleting the entities and collections associated with a specific app instance.
## Collections
-The BaaS stores all data entities in uniquely-named collections. Collections are created automatically for every entity type, including custom entities, and are named using the plural form of the entity type they store. For example, all user entities are stored in the /users collection, and all device entities in the /devices collection. An entity can belong to only one collection.
+Usergrid stores all data entities in uniquely-named collections. Collections are created automatically for every entity type, including custom entities, and are named using the plural form of the entity type they store. For example, all user entities are stored in the /users collection, and all device entities in the /devices collection. An entity can belong to only one collection.
Currently, collections cannot be renamed or deleted; however, all of the data entities in a collection can be updated or deleted.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/introduction/usergrid-features.md
----------------------------------------------------------------------
diff --git a/docs/introduction/usergrid-features.md b/docs/introduction/usergrid-features.md
index 2ff4a67..5e57071 100644
--- a/docs/introduction/usergrid-features.md
+++ b/docs/introduction/usergrid-features.md
@@ -1,8 +1,8 @@
# Usergrid Features
-Edge Developer Services includes a backend-as-a-service (BaaS) solution that provides developers with access to a flexible data store and enables you to quickly integrate valuable features into your app, including social graphs, user management, data storage, push notifications, performance monitoring, and more.
+Usergrid provides developers with access to a flexible data store and enables you to quickly integrate valuable features into your app, including social graphs, user management, data storage, push notifications, performance monitoring, and more.
-Using Usergrid, you can set up your own cloud-based data platform in minutes instead of months – no server-side coding or back-end development needed. This allows your team to focus on developing the rich features and user experience that truly differentiate your app, rather than on the time-consuming details of implementing core back-end services and infrastructure.
+With Usergrid, developers can set up their own cloud-based data platform in minutes instead of months – no server-side coding or back-end development needed. This allows your developers to focus on developing the rich features and user experience that truly differentiate your app, rather than on the time-consuming details of implementing core back-end services and infrastructure.
## Data storage & management
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/reference/contribute-code.md
----------------------------------------------------------------------
diff --git a/docs/reference/contribute-code.md b/docs/reference/contribute-code.md
index f63c6e8..5bfd0ce 100644
--- a/docs/reference/contribute-code.md
+++ b/docs/reference/contribute-code.md
@@ -15,10 +15,4 @@ are are step-by-step guide for both both external contributors and committers:
Website and Documentation Contributions
---
-If you want to contribute to the documentation you'll find that we use a different
-system. Our website and documentation is managed in Subversion. Here's a README file
-that explains how to get the website and documentation source code and make changes:
-
-* [README.md for website](http://svn.apache.org/viewvc/incubator/usergrid/site/README.md?view=markup)
-
-* [README.md for documentation](https://github.com/apache/incubator-usergrid/tree/master/docs)
\ No newline at end of file
+Documentation is in the /docs directory of our Git repo, written in Markdown format and managed by the Sphinx documentation system. See the README.md there for more information.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/reference/presentations.md
----------------------------------------------------------------------
diff --git a/docs/reference/presentations.md b/docs/reference/presentations.md
deleted file mode 100644
index 76c2a46..0000000
--- a/docs/reference/presentations.md
+++ /dev/null
@@ -1,21 +0,0 @@
-# Presentations
-
-## How to Contribute to Apache Usergrid
-- David Johnson, [ApacheCon NA 2014](http://apacheconnorthamerica2014.sched.org/event/29971aabd3c86398be2ae93403c7d1d2)
-
-<iframe src="http://www.slideshare.net/slideshow/embed_code/33275731" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
-
-## Apache Usergrid Internals
-- Sungju Jin
-
-<iframe src="http://speakerdeck.com/player/f0cd95108c150131a1e7669157168c6d" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
-
-## Open Source Mobile Backend on Cassandra
-- Ed Anuff
-
-<iframe src="http://www.slideshare.net/slideshow/embed_code/13919079" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
-
-## Usergrid Overview
-- Ed Anuff
-
-<iframe src="http://www.slideshare.net/slideshow/embed_code/9476483" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/reference/presos-and-videos.md
----------------------------------------------------------------------
diff --git a/docs/reference/presos-and-videos.md b/docs/reference/presos-and-videos.md
new file mode 100644
index 0000000..19caa13
--- /dev/null
+++ b/docs/reference/presos-and-videos.md
@@ -0,0 +1,37 @@
+# Presentations
+
+## How to Contribute to Apache Usergrid
+- David Johnson, [ApacheCon NA 2014](http://apacheconnorthamerica2014.sched.org/event/29971aabd3c86398be2ae93403c7d1d2)
+
+<iframe src="http://www.slideshare.net/slideshow/embed_code/33275731" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
+
+## Apache Usergrid Internals
+- Sungju Jin
+
+<iframe src="http://speakerdeck.com/player/f0cd95108c150131a1e7669157168c6d" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
+
+## Open Source Mobile Backend on Cassandra
+- Ed Anuff
+
+<iframe src="http://www.slideshare.net/slideshow/embed_code/13919079" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
+
+## Usergrid Overview
+- Ed Anuff
+
+<iframe src="http://www.slideshare.net/slideshow/embed_code/9476483" width="600" height="400" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width
+
+# Videos
+
+Talks and presentations about Usergrid.
+
+## Building Mobile Apps with Apache Usergrid
+
+Screen-cast of a talk given by Dave Johnson at the All Things Open 2014, Raleigh, NC.
+
+<iframe width="560" height="315" src="https://www.youtube.com/embed/DjFG-QbxxLw" frameborder="0" allowfullscreen></iframe>
+
+## Cassandra at Apigee, Usergrid Powering Mobile
+
+Video of talk given by Ed Anuff at the Cassandra Summit 2012, Santa Clara, CA.
+
+<iframe width="640" height="360" src="http://www.youtube.com/embed/RuJwIBu3jvs?rel=0" frameborder="0" allowfullscreen></iframe>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/reference/videos.md
----------------------------------------------------------------------
diff --git a/docs/reference/videos.md b/docs/reference/videos.md
deleted file mode 100644
index bc814f5..0000000
--- a/docs/reference/videos.md
+++ /dev/null
@@ -1,11 +0,0 @@
-# Videos
-
-## How to Contribute to Apache Usergrid
-- David Johnson, [ApacheCon NA 2014](http://apacheconnorthamerica2014.sched.org/event/29971aabd3c86398be2ae93403c7d1d2)
-
-<iframe width="640" height="360" src="http://www.youtube.com/embed/cfwGmvUhFzY?rel=0" frameborder="0" allowfullscreen></iframe>
-
-## C* 2012: Cassandra at Apigee: Usergrid Powering Mobile
-- Ed Anuff
-
-<iframe width="640" height="360" src="http://www.youtube.com/embed/RuJwIBu3jvs?rel=0" frameborder="0" allowfullscreen></iframe>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/access-token.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/access-token.txt b/docs/rest-endpoints/sources/access-token.txt
index 027bbae..da469a4 100644
--- a/docs/rest-endpoints/sources/access-token.txt
+++ b/docs/rest-endpoints/sources/access-token.txt
@@ -1 +1 @@
-End-Point Method Content-type Description Detail
"/management/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'" POST application/json Obtain an access token (access type = organization) Detail
"/management/token '{"grant_type":"password","username":"{username}",:"password":"{password}"}'" POST application/json Obtain an access token (access type = admin user) Detail
"/{org_id}/{app_id}/token '{"grant_type":"client_credentials","client_id":"{client_id}","client_secret":"{client_secret}"}'" POST application/json Obtain an access token (access type = application) Detail
"/{org_id}/{app_id}/token '{"grant_type":"password","username":"{username}","password":"{password}"}'" POST application/json Obtain an access token (access type = application user) Detail
\ No newline at end of file
+End-Point Method Content-type Description Detail
/management/token POST application/json Obtain an access token (access type = organization) Detail
/{org_id}/{app_id}/token POST application/json Obtain an access token (access type = application) Detail
/{org_id}/{app_id}/token POST application/json Obtain an access token (access type = application user) Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/activities.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/activities.txt b/docs/rest-endpoints/sources/activities.txt
index e4c0d2e..1e8ee67 100644
--- a/docs/rest-endpoints/sources/activities.txt
+++ b/docs/rest-endpoints/sources/activities.txt
@@ -1 +1 @@
-End-Point Method Content-type Description Detail
/{org_id}/{app_id}/users/ {uuid|username}/activities POST application/json Create an activity Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/activities POST application/json Post an activity to a group Detail
\ No newline at end of file
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/users/{uuid}/activities POST application/json Create an activity Detail
/{org_id}/{app_id}/users/{username}/activities POST application/json Create an activity Detail
/{org_id}/{app_id}/groups/{uuid}/activities POST application/json Post an activity to a group Detail
/{org_id}/{app_id}/groups/{groupname}/activities POST application/json Post an activity to a group Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/admin-users.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/admin-users.txt b/docs/rest-endpoints/sources/admin-users.txt
index 711644c..52746c7 100644
--- a/docs/rest-endpoints/sources/admin-users.txt
+++ b/docs/rest-endpoints/sources/admin-users.txt
@@ -1 +1 @@
-End-Point Method Content-type Description Detail
/management/users POST application/json Create an admin user Detail
/management/users/{user|username|email|uuid} PUT application/json Update an admin user Detail
/management/users/{user|username|email|uuid} GET application/json Get an admin user Detail
/management/users/{user|username|email|uuid}/ password PUT application/json Set an admin user's password Detail
/managementusers/resetpw GET application/json Initiate the reset of an admin user's password Detail
/management/users/resetpw POST application/json Complete the reset of an admin user's password Detail
/management/users/{user|username|email|uuid}/activate? token={token}&confirm={confirm_email} GET application/json Activate an admin user Detail
/management/users/{user|username|email|uuid}/reactivate GET application/json Reactivate an admin user Detail
/management/users/{user|username|email|uuid}/feed GET application/json Get an admin user's feed Detail
\ No newline at end of file
+End-Point Method Content-type Description Detail
/management/users POST application/json Create an admin user Detail
/management/users/{identifier} PUT application/json Update an admin user Detail
/management/users/{identifier} GET application/json Get an admin user Detail
/management/users/{identifier}/ password PUT application/json Set an admin user's password Detail
/management/users/resetpw GET application/json Initiate the reset of an admin user's password Detail
/management/users/resetpw POST application/json Complete the reset of an admin user's password Detail
/management/users/{identifier}/activate?token={token}&confirm={confirm_email} GET application/json Activate an admin user Detail
/management/users/{identifier}/reactivate GET application/json Reactivate an admin user Detail
/management/users/{identifier}/feed GET application/json Get an admin user's feed Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/collections.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/collections.txt b/docs/rest-endpoints/sources/collections.txt
index 6b1ffd8..cb0370b 100644
--- a/docs/rest-endpoints/sources/collections.txt
+++ b/docs/rest-endpoints/sources/collections.txt
@@ -1 +1 @@
-End-Point Method Content-type Description Detail
/{org_id}/{app_id}/ GET application/json Retrieve all collections Detail
/{org_id}/{app_id}/{collection} POST application/json Create a new entity or collection Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} GET application/json Retrieve an entity Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} PUT application/json Update an entity Detail
/{org_id}/{app_id}/{collection}/ {uuid|name} DELETE application/json Delete an entity Detail
/{org_id}/{app_id}/{collection}?{query} GET application/json Query a collection Detail
/{org_id}/{app_id}/{collection}?{query} PUT application/json Update a collection by query Detail
/{org_id}/{app_id}/{collection}/{entity_id}/ {relationship}?{query} GET application/json Query an entity's collections or connections Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{se
cond_entity_id} POST application/json Add an entity to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} DELETE application/json Remove an entity from a collection or delete a connection Detail
\ No newline at end of file
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/ GET application/json Retrieve all collections Detail
/{org_id}/{app_id}/{collection} POST application/json Create a new entity or collection Detail
/{org_id}/{app_id}/{collection}/{identifier} GET application/json Retrieve an entity Detail
/{org_id}/{app_id}/{collection}/{identifier} PUT application/json Update an entity Detail
/{org_id}/{app_id}/{collection}/{identifier} DELETE application/json Delete an entity Detail
/{org_id}/{app_id}/{collection}?{query} GET application/json Query a collection Detail
/{org_id}/{app_id}/{collection}?{query} PUT application/json Update a collection by query Detail
/{org_id}/{app_id}/{collection}/{entity_id}/{relationship}?{query} GET application/json Query an entity's collections or connections Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id} POST application/json Add an entity to a collection or create a connection Detail
/{org_id}/{app_
id}/{collection}/{first_entity_id}/{relationship}/{second_entity_type}/{second_entity_id} POST application/json Add an entity to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id}/{second_entity_type}/{second_entity_id} DELETE application/json Remove an entity from a collection or delete a connection Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_type}/{second_entity_id} DELETE application/json Remove an entity from a collection or delete a connection Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/groups.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/groups.txt b/docs/rest-endpoints/sources/groups.txt
index 649a965..e94dcf9 100644
--- a/docs/rest-endpoints/sources/groups.txt
+++ b/docs/rest-endpoints/sources/groups.txt
@@ -1 +1 @@
-End-Point Method Content-type Description Detail
/{org_id}/{app_id}/groups POST application/json Create a new group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname} GET application/json Get a group Detail
/{org_id}{app_id}/groups/ {uuid|groupname} PUT application/json Update a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} DELETE application/json Delete user from a group Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/feed GET application/json Get a group's feed Detail
\ No newline at end of file
+End-Point Method Content-type Description Detail
/{org_id}/{app_id}/groups POST application/json Create a new group Detail
/{org_id}/{app_id}/groups/{identifier}/users/{uuid|username} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/groups/{identifier} GET application/json Get a group Detail
/{org_id}/{app_id}/groups/{identifier} PUT application/json Update a group Detail
/{org_id}/{app_id}/groups/{identifier}/users/{uuid|username} DELETE application/json Delete user from a group Detail
/{org_id}/{app_id}/groups/{identifier}/feed GET application/json Get a group's feed Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/organizations.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/organizations.txt b/docs/rest-endpoints/sources/organizations.txt
index 3afa5b3..d3cd079 100644
--- a/docs/rest-endpoints/sources/organizations.txt
+++ b/docs/rest-endpoints/sources/organizations.txt
@@ -1 +1 @@
-End-Point Method Description Detail
/management/organizations|orgs POST application/json Create an organization Detail
/management/organizations|orgs/{org_name}|{uuid} GET application/json Retrieve an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ activate?token={token}&confirm={confirm_email} GET application/json Activate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ reactivate GET application/json Reactivate an organization Detail
/management/organizations|orgs/{org_name}|{uuid}/ credentials POST application/json Generate organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/ credentials GET application/json Retrieve organization client credentials Detail
/management/organizations|orgs/{org_name}|{uuid}/ feed GET application/json Retrieve an organization's activity feed Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ apps POST application/json Create an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/{app_name}|{uuid}/ credentials POST application/json Generate credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps/ {app_name}|{uuid}/credentials GET application/json Get credentials for an organization application Detail
/management/organizations|orgs/{org_name}|{uuid}/ applications|apps GET application/json Get the applications in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid} PUT application/json Adding an admin user to an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users GET application/json Getting the admin users in an organization Detail
/management/organizations|orgs/{org_name}|{org_uuid}/ users/{username|email|uuid} DELETE application/json Removing an admin user from an organization Detail
\ No newline at end of file
+End-Point Method Description Detail
/management/organizations POST application/json Create an organization Detail
/management/organizations/{identifier} GET application/json Retrieve an organization Detail
/management/organizations/{identifier}/activate?token={token}&confirm={confirm_email} GET application/json Activate an organization Detail
/management/organizations/{identifier}/reactivate GET application/json Reactivate an organization Detail
/management/organizations/{identifier}/credentials POST application/json Generate organization client credentials Detail
/management/organizations/{identifier}/credentials GET application/json Retrieve organization client credentials Detail
/management/organizations/{identifier}/feed GET application/json Retrieve an organization's activity feed Detail
/management/organizations/{identifier}/apps POST application/json Create an organization application Detail
/management/organizations/{identifier}/applications|apps/{app_name}|{uuid}/ credenti
als POST application/json Generate credentials for an organization application Detail
/management/organizations/{identifier}/applications|apps/ {app_name}|{uuid}/credentials GET application/json Get credentials for an organization application Detail
/management/organizations/{identifier}/applications|apps GET application/json Get the applications in an organization Detail
/management/organizations/{identifier}/users/{username|email|uuid} PUT application/json Adding an admin user to an organization Detail
/management/organizations/{identifier}/users GET application/json Getting the admin users in an organization Detail
/management/organizations/{org-identifier}/users/{user-identifier} DELETE application/json Removing an admin user from an organization Detail
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/roles.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/roles.txt b/docs/rest-endpoints/sources/roles.txt
index 065511d..bfd2d33 100644
--- a/docs/rest-endpoints/sources/roles.txt
+++ b/docs/rest-endpoints/sources/roles.txt
@@ -1 +1 @@
-End-Point Method Description Detail
/{org_id}/{app_id}/roles POST application/json Create a new role Detail
/{org_id}/{app_id}/roles GET application/json Get the roles in an application Detail
/{org_id}/{app_id}/roles/{rolename} DELETE application/json Delete a role Detail
/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions GET application/json Get permissions for a role Detail
/{org_id}/{app_id}/roles/ {rolename|role_id}/permissions POST application/json Add permissions to a role Detail
{org_id}/{app_id}/roles/ {rolename|role_id}/permissions? permission={grant_url_pattern} DELETE application/json Delete permissions from a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username} or /{org_id}/{app_id}/users/ {uuid|username}/roles/{role_id} POST application/json Add a user to a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users GET application/json Get the users in a role Detail
/{org_id}/{app_id}/roles/{role_id}/ users/{uuid|username} DELETE application/json Del
ete a user from a role Detail
\ No newline at end of file
+End-Point Method Description Detail
/{org_id}/{app_id}/roles POST application/json Create a new role Detail
/{org_id}/{app_id}/roles GET application/json Get the roles in an application Detail
/{org_id}/{app_id}/roles/{rolename} DELETE application/json Delete a role Detail
/{org_id}/{app_id}/roles/{rolename|role_id}/permissions GET application/json Get permissions for a role Detail
/{org_id}/{app_id}/roles/{rolename|role_id}/permissions POST application/json Add permissions to a role Detail
/{org_id}/{app_id}/roles/{rolename|role_id}/permissions?permission={grant_url_pattern} DELETE application/json Delete permissions from a role Detail
/{org_id}/{app_id}/roles/{role_id}/users/{uuid|username}/roles/{role_id} POST application/json Add a user to a role Detail
/{org_id}/{app_id}/users/{identifier}/roles/{role_id} POST application/json Add a user to a role Detail
/{org_id}/{app_id}/roles/{role_id}/users GET application/json Get the users in a role Detail
/{org_id}/{app_id}/roles/{role_
id}/users/{uuid|username} DELETE application/json Delete a user from a role Detail
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/085a5d3a/docs/rest-endpoints/sources/users.txt
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/sources/users.txt b/docs/rest-endpoints/sources/users.txt
index 7debd51..f0f91c5 100644
--- a/docs/rest-endpoints/sources/users.txt
+++ b/docs/rest-endpoints/sources/users.txt
@@ -1 +1 @@
-End-Point Method Description Detail
/{org_id}/{app_id}/users POST application/json Create a user in the users collection Detail
/{org_id}/{app_id}/users/{user}/ password POST application/json Set a user's password or reset the user's existing password Detail
/{org_id}/{app_id}/users/ {uuid|username|email_address} GET application/json Retrieve a user Detail
/{org_id}/{app_id}/users/ {uuid|username} PUT application/json Update a user Detail
/{org_id}/{app_id}/users/{uuid|username} DELETE application/json Delete a user Detail
/{org_id}/{app_id}/users?{query} GET application/json Query to get users Detail
/{org_id}/{app_id}/groups/ {uuid|groupname}/users/{uuid|username} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} POST application/json Add a user to a collection or create a connection De
tail
/{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_id} or /{org_id}/{app_id}/{collection}/ {first_entity_id}/{relationship}/ {second_entity_type}/{second_entity_id} DELETE application/json Remove a user from a collection or delete a connection Detail
/{org_id}/{app_id}/users/{uuid|username}/ {relationship}?{query} GET application/json Query a user's collections or connections Detail
/{org_id}/{app_id}/users/ {uuid|username}/feed GET application/json Get a user's feed Detail
\ No newline at end of file
+End-Point Method Description Detail
/{org_id}/{app_id}/users POST application/json Create a user in the users collection Detail
/{org_id}/{app_id}/users/{user}/ password POST application/json Set a user's password or reset the user's existing password Detail
/{org_id}/{app_id}/users/{identifier} GET application/json Retrieve a user Detail
/{org_id}/{app_id}/users/{identifier} PUT application/json Update a user Detail
/{org_id}/{app_id}/users/{identifier} DELETE application/json Delete a user Detail
/{org_id}/{app_id}/users?{query} GET application/json Query to get users Detail
/{org_id}/{app_id}/groups/{group-identifier}/users/{user-identifier} POST application/json Add a user to a group Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id} POST application/json Add a user to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_type}/{second_entity_id} POST application/json Ad
d a user to a collection or create a connection Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/{second_entity_id} DELETE application/json Remove a user from a collection or delete a connection Detail
/{org_id}/{app_id}/{collection}/{first_entity_id}/{relationship}/second_entity_type}/{second_entity_id} DELETE application/json Remove a user from a collection or delete a connection Detail
/{org_id}/{app_id}/users/{identifier}/{relationship}?{query} GET application/json Query a user's collections or connections Detail
/{org_id}/{app_id}/users/{identifier}/feed GET application/json Get a user's feed Detail
\ No newline at end of file
[2/2] incubator-usergrid git commit: Update README with details of
Sphinx, Markdown, RST, etc. Also,
adding Swagger for Usergrid API and some Maven infrastructure for HTML
generation.
Posted by sn...@apache.org.
Update README with details of Sphinx, Markdown, RST, etc. Also, adding Swagger for Usergrid API and some Maven infrastructure for HTML generation.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/d3f778be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/d3f778be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/d3f778be
Branch: refs/heads/ug2-doc-update
Commit: d3f778be8772b3b676f716e0e22a8d438c4eaa9e
Parents: 085a5d3
Author: Dave Johnson <sn...@apache.org>
Authored: Fri Jul 31 11:09:18 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Fri Jul 31 11:09:18 2015 -0400
----------------------------------------------------------------------
docs/README.md | 37 +-
docs/pom.xml | 87 ++
docs/usergrid-swagger.yaml | 2348 +++++++++++++++++++++++++++++++++++++++
3 files changed, 2466 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d3f778be/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index b1d9991..6da14cf 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,23 +1,48 @@
# Apache Usergrid Documentation
-Uses the Sphinx documentation system with Markdown content.
+Usergrid documentation is written in [Markdown](https://help.github.com/articles/markdown-basics/)
+(*.md) and RST (.rst) formats and we use the Python based [Sphinx-Docs](http://sphinx-doc.org/)
+documentation system to transform our Markdown and RST files to HTML format.
## Prerequisites
-You will need Python, Sphinx and PIP.
+Sphinx requires Python and pip. Once you have Python, you can install sphinx and pip like so:
$ sudo easy_install sphinx
$ sudo easy_install pip
-## How to gererate docs
+## How to the Usergrid documentation using Sphinx
+
+Sphinx runs via a Makefile in this, the docs directory. So, cd to this directory and make html:
cd $usergrid/docs
make clean html
## How to update documentations in Usergrid site
-For most changes you simply edit the Markdown (.md) and reST (.rst) files where and commit your changes to Git.
+For most changes you simply edit the Markdown (.md) and reST (.rst) files where and
+commit your changes to Git.
+
+### Note the difference between RST and Markdown files
+
+Note that Sphinx's native format is [reStructuredText](http://docutils.sourceforge.net/rst.html)
+(RST) and not Markdown. This causes some issues. For example, using Sphinx directives in
+Markdown files sometimes works and sometimes does not. RST is a different format than Markdown
+and it has a different set of directives, some very useful for organizing a large set of
+documentation files.
+
+### The Table of Contents
+
+The Table of Contents for the documentation is in index.rst, which ties everything together
+with a series of RST __toctree__ directives. All other files should be written in Markdown,
+unless they need some special RST directives that will not work in Markdown.
+
+### Other Tables
+
+A note about tables: simple tables are easy and you can find examples (e.g. connecting-entities.md)
+but for tables with multiple lines in each cell, you'll probably want to use a raw HTML table,
+and there are plenty of examples of that around too.
-Note that Sphinx's native format is reST and not Markdown. This causes some issues. For example, using Sphinx directives in Markdown files sometimes works and sometimes does not.
+### The REST documentation
-To update the default-entities and rest-endpoint tables, you should edit the tab-delimited text files (.text) in the source directory, and the run the Groovy scripts there to generate the markdown file representations of those tables.
\ No newline at end of file
+TBD
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/d3f778be/docs/pom.xml
----------------------------------------------------------------------
diff --git a/docs/pom.xml b/docs/pom.xml
new file mode 100644
index 0000000..17073dc
--- /dev/null
+++ b/docs/pom.xml
@@ -0,0 +1,87 @@
+<?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>
+
+ <!--
+ This POM is here just to make the IDE play nice with
+ Groovy code that uses Grape for dependency management.
+ -->
+
+ <groupId>org.apache.usergrid</groupId>
+ <artifactId>doc-utils</artifactId>
+ <version>1.0.3-SNAPSHOT</version>
+
+ <build>
+ <plugins>
+ <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>
+ </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>com.wordnik</groupId>-->
+ <!--<artifactId>swagger-codegen-distribution</artifactId>-->
+ <!--<version>2.1.2-M1</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/d3f778be/docs/usergrid-swagger.yaml
----------------------------------------------------------------------
diff --git a/docs/usergrid-swagger.yaml b/docs/usergrid-swagger.yaml
new file mode 100644
index 0000000..729c049
--- /dev/null
+++ b/docs/usergrid-swagger.yaml
@@ -0,0 +1,2348 @@
+swagger: 2
+info:
+ title: Usergrid API
+ description: "Usergrid API"
+ version: 1.0.0
+host: api.usergrId.com
+schemes:
+ - https
+basePath: /
+produces:
+ - application/json
+paths:
+ management/users:
+ post:
+ summary: "Creating an admin user."
+ description: "Create a whole new admin user."
+ parameters:
+ - name: adminuserproperty
+ in: body
+ description: "One or more sets of user properties of which username is mandatory and must be unique."
+ required: true
+ schema:
+ $ref: CreateAdminUser
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of new created Admin user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/{userId}:
+ put:
+ summary: "Updating an admin user."
+ description: "Update the info of an admin user."
+ parameters:
+ - $ref: "#/parameters/userId"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of user's details."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Getting an admin user."
+ description: "Retrieve details about an admin user."
+ parameters:
+ - $ref: "#/parameters/userId"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of user's details"
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/resetpw:
+ post:
+ summary: "Completing a password reset."
+ description: "Complete the password reset through getting the newpassword and the old one for identification."
+ parameters:
+ - name: ResetPWMsg
+ in: body
+ description: "Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address."
+ required: true
+ schema:
+ ref: ResetPWMsg
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Initiating a password reset."
+ description: "Initiate the reset of an admin user's password."
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/{userId}/password:
+ put:
+ summary: "Setting an admin user's password."
+ description: "Update an admin user's password through getting the newpassword and the old one for identification."
+ parameters:
+ - $ref: "#/parameters/userId"
+ - name: ResetPW
+ in: body
+ description: "The user's old and new password."
+ required: true
+ schema:
+ $ref: ResetPW
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/{userId}/activate:
+ get:
+ summary: "Activating an admin user."
+ description: "Activate an admin user from a link provIded in an email notification. The complete request URL should be GET /management/organizations/{org}/users/{user|username|email|UUID}/activate?token={token}&confirm={confirm_email}."
+ parameters:
+ - $ref: "#/parameters/userId"
+ - name: token
+ in: query
+ description: "Activation token's query statement."
+ required: true
+ type: string
+ - name: confirm_email
+ in: query
+ description: "Query statement of whether send confimation email or not."
+ required: true
+ type: boolean
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/{userId}/reactivate:
+ get:
+ summary: "Reactivating an admin user."
+ description: "Reactivate an expired admin user."
+ parameters:
+ - $ref: "#/parameters/userId"
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/users/{userId}/feed:
+ get:
+ summary: "Getting an admin user's activity feed."
+ description: "Retrieve an admin user's activity feed."
+ parameters:
+ - $ref: "#/parameters/userId"
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of user's activity"
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{userId}/activities":
+ post:
+ summary: "Posting a user activity."
+ description: "Create an activity in the activities collection."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userId-3"
+ - name: CreateActivity
+ in: body
+ description: "One or more sets of activity properties."
+ required: true
+ schema:
+ $ref: CreateActivity
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of user's activity."
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/groups/{groupId}/activities":
+ post:
+ summary: "Posting an activity to a group."
+ description: "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."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ - name: CreateActivity
+ in: body
+ description: "One or more sets of activity properties."
+ required: true
+ schema:
+ $ref: CreateActivity
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of user's activity."
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs:
+ post:
+ summary: "Creating an orgnization."
+ description: "Create an orgnization through a form post."
+ parameters:
+ - name: CreateOrg
+ in: body
+ description: "A set of orgnization properties supplied through a form."
+ required: true
+ schema:
+ $ref: CreateOrg
+ tags:
+ - Orgnization
+ responses:
+ "200":
+ description: "An array of created Orgnization."
+ schema:
+ $ref: Orgnization
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}:
+ get:
+ summary: "Getting an orgnization."
+ description: "Retrieve an orgnization given a specified UUId or username."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - Orgnization
+ responses:
+ "200":
+ description: "An array of created Orgnization."
+ schema:
+ $ref: Orgnization
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/activate:
+ get:
+ summary: "Activating an orgnization."
+ description: "Activate an orgnization from a link provIded in an email notification. The complete request URL is 'GET /orgs/{org_name}|{UUID}/activate?token={token}&confirm={confirm_email}'"
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - name: token
+ in: query
+ description: "Activation token."
+ required: true
+ type: string
+ - name: confirm_email
+ in: query
+ description: "Send confirmation email or not."
+ required: true
+ type: boolean
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/reactivate:
+ get:
+ summary: "Reactivating an orgnization"
+ description: "Reactivate an expired orgnization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/credentials:
+ post:
+ summary: "Generating orgnization client credentials."
+ description: "Generate whole new credentials for an orgnization client."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - Credential
+ responses:
+ "200":
+ description: "An array of Credential"
+ schema:
+ $ref: Credential
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Retrieving orgnization client credentials."
+ description: "Retrieve the credentials for an orgnization client."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - Credential
+ responses:
+ "200":
+ description: "An array of Credential"
+ schema:
+ $ref: Credential
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/feed:
+ get:
+ summary: "Getting an orgnization's activity feed."
+ description: "Retrieve an orgnization's activity feed."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of the orgnization's ActivityFeed."
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/apps:
+ post:
+ summary: "Creating an orgnization application."
+ description: "Create an application for an orgnization through a form post."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - name: CreateApp
+ in: body
+ description: "A set of orgnization properties supplied through a form."
+ required: true
+ schema:
+ $ref: CreateApp
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/apps/{appId}:
+ delete:
+ summary: "Removing an application from the orgnization."
+ description: "Remove an application from an orgnization through providing both Id of application and organization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - AppData
+ responses:
+ "200":
+ description: "An array of deleted application info."
+ schema:
+ $ref: AppData
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/apps/{appId}/credentials:
+ post:
+ summary: "Generating application credentials."
+ description: "Generate the client Id and client secret credentials for an application in an orgnization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Credential
+ responses:
+ "200":
+ description: "An array of generated credentials info."
+ schema:
+ $ref: Credential
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Getting application credentials."
+ description: "Retrieve the client Id and client secret credentials for an application in an orgnization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Credential
+ responses:
+ "200":
+ description: "An array of retrieved credentials info."
+ schema:
+ $ref: Credential
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/apps:
+ get:
+ summary: "Getting the applications in an orgnization."
+ description: "Retrieve the applications in an orgnization through providing both Id of application and organization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - AppData
+ responses:
+ "200":
+ description: "An array of retrieved application data."
+ schema:
+ $ref: AppData
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/users/{userId}:
+ put:
+ summary: "Adding an admin user to an orgnization."
+ description: "Add an existing admin user to an orgnization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/userId-2"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of new added Admin user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/users:
+ get:
+ summary: "Getting the admin users in an orgnization."
+ description: "Retrieve details about the admin users in an orgnization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of retrieved Admin user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ management/orgs/{orgId}/users/{userId}:
+ delete:
+ summary: "Removing an admin user from an orgnization."
+ description: "Remove an admin user from an orgnization through providing both Id of application and organization."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/userId-2"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of deleted Admin user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+
+ "/{orgId}/{appId}/{collectionId}":
+ get:
+ summary: "Retrieving sets of entities from a collection."
+ description: "Use the GET method to retrieve a set of entities from a collection."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of retrieved collection's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{entitytype}":
+ post:
+ summary: "Creating a custom entity."
+ description: "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. "
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: entitytype
+ in: path
+ description: "The entity type to create."
+ required: true
+ type: string
+ - name: entityproperty
+ in: body
+ description: "The properties of the entity."
+ required: true
+ schema:
+ $ref: CreateEntities
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of created custom entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{collectionId}/{entityId}":
+ get:
+ summary: "Retrieving an entity."
+ description: "Retrieve an entity through providing Id of application, organization, collection and entity."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - $ref: "#/parameters/entityId"
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of retrieved entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ put:
+ summary: "Updating an entity."
+ description: "One or more properties can be updated with a single request."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - $ref: "#/parameters/entityId"
+ - name: entityproperty
+ in: body
+ description: "The properties of the entity."
+ required: true
+ schema:
+ $ref: CreateEntities
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of updated entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ delete:
+ summary: "Deleting an entity."
+ description: "Delete an entity from the collection."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - $ref: "#/parameters/entityId"
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of deleted entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{collectionId}":
+ get:
+ summary: "Query a collection。"
+ description: "Retrieve collection through query statement."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - name: queryStatement
+ in: query
+ description: "Any values specified in the query statement should be enclosed in single-quotes."
+ required: true
+ type: string
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of retrieved collection's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ put:
+ summary: "Update a collection by query"
+ description: "Update collection through query statement."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - name: queryStatement
+ in: query
+ description: "Any values specified in the query statement should be enclosed in single-quotes."
+ required: true
+ type: string
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of updated collection's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}":
+ post:
+ summary: "Add an entity to a collection."
+ description: "Add an entity to a collection through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - name: entityId1
+ in: path
+ description: "The Id of the 1st entity."
+ required: true
+ type: string
+ - name: relation
+ in: path
+ description: "The relation between 1st entity and 2nd entity."
+ required: true
+ type: string
+ - name: entityId2
+ in: path
+ description: "The Id of the 2nd entity."
+ required: true
+ type: string
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of added entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ delete:
+ summary: "Remove an entity from a collection."
+ description: "Remove an entity from a collection through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/collectionId"
+ - name: entityId1
+ in: path
+ description: "The Id of the 1st entity."
+ required: true
+ type: string
+ - name: relation
+ in: path
+ description: "The relation between 1st entity and 2nd entity."
+ required: true
+ type: string
+ - name: entityId2
+ in: path
+ description: "The Id of the 2nd entity."
+ required: true
+ type: string
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of deleted entity's info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/events":
+ post:
+ summary: "Create an event."
+ description: "Create an event through providing both Id of orgnization and application."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: CreateEvent
+ in: body
+ description: "The required property of the event."
+ required: true
+ schema:
+ $ref: CreateEvent
+ tags:
+ - Event
+ responses:
+ "200":
+ description: "An array of created event's info."
+ schema:
+ $ref: Event
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/groups":
+ post:
+ summary: "Create a new group."
+ description: "Create a new group through providing both Id of orgnization and application."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: groupproperty
+ in: body
+ description: "The property of the created group."
+ required: true
+ schema:
+ $ref: CreateGroup
+ tags:
+ - Group
+ responses:
+ "200":
+ description: "An array of created group's info."
+ schema:
+ $ref: Group
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/groups/{groupId}/users/{userId}":
+ post:
+ summary: "Add a user to a group."
+ description: "Add a user to a group through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ - $ref: "#/parameters/userId-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of added user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ delete:
+ summary: "Delete user from a group."
+ description: "Delete user from a group through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ - $ref: "#/parameters/userId-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of deleted user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{org_Id}/{app_Id}/groups/{groupId}":
+ get:
+ summary: "Get a group."
+ description: "Get a group through through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ tags:
+ - Group
+ responses:
+ "200":
+ description: "An array of retrieved group's info."
+ schema:
+ $ref: Group
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ put:
+ summary: "Update a group."
+ description: "Update a group through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ tags:
+ - Group
+ responses:
+ "200":
+ description: "An array of updated group's info."
+ schema:
+ $ref: Group
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/groups/{groupId}/feed":
+ get:
+ summary: "Get a group's feed."
+ description: "Get a group's feed through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/groupId"
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of group's activity."
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles":
+ post:
+ summary: "Create a new role."
+ description: "Create a new role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: roleproperty
+ in: body
+ description: "The required properties of the role."
+ required: true
+ schema:
+ $ref: AddRole
+ tags:
+ - Role
+ responses:
+ "200":
+ description: "An array of created role's info."
+ schema:
+ $ref: Role
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Get the roles in an application"
+ description: "Retrieve the roles in an application through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Role
+ responses:
+ "200":
+ description: "An array of retrieved role's info."
+ schema:
+ $ref: Role
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles/{rolename}":
+ delete:
+ summary: "Delete a role."
+ description: "Remove a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: rolename
+ in: path
+ description: "The name of the role."
+ required: true
+ type: string
+ tags:
+ - Role
+ responses:
+ "200":
+ description: "An array of deleted role's info."
+ schema:
+ $ref: Role
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles/{roleId}/permissions":
+ post:
+ summary: "Add permissions to a role."
+ description: "Add permissions to a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ - name: permissionproperty
+ in: body
+ description: "the properties of permissions"
+ required: true
+ schema:
+ $ref: AddPermission
+ tags:
+ - Permission
+ responses:
+ "200":
+ description: "An array of created permission's info."
+ schema:
+ $ref: Permission
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Get permissions for a role."
+ description: "Retrieve permissions for a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ tags:
+ - Permission
+ responses:
+ "200":
+ description: "An array of retrieved permission's info."
+ schema:
+ $ref: Permission
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles/{roleId}/permissions":
+ delete:
+ summary: "Delete permissions from a role."
+ description: "Remove permissions from a role. The complete request URL is 'DELETE {org_Id}/{app_Id}/roles/{rolename|role_Id}/permissions?permission={grant_url_pattern}' "
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ - name: grant_url_pattern
+ in: query
+ description: "The query statement of the url pattern."
+ required: true
+ type: string
+ tags:
+ - Permission
+ responses:
+ "200":
+ description: "An array of deleted permission's info."
+ schema:
+ $ref: Permission
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles/{roleId}/users/{userId}":
+ post:
+ summary: "Add a user to a role."
+ description: "Add a user to a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ - $ref: "#/parameters/userId-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of added user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ delete:
+ summary: "Delete a user from a role."
+ description: "Remove a user from a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ - $ref: "#/parameters/userId-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of deleted user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/roles/{roleId}/users":
+ get:
+ summary: "Get the users in a role."
+ description: "Retrieve the users in a role through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/roleId"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of retrieved user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users":
+ post:
+ summary: "Create a user in the users collection."
+ description: "Create a user in the users collection through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: CreateUser
+ in: body
+ description: "The properties of the user."
+ required: true
+ schema:
+ $ref: CreateUser
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of created user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ get:
+ summary: "Query to get users."
+ description: "Retrieve users though query statement."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: queryStatement
+ in: query
+ description: "The query statement of the User."
+ required: true
+ type: string
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of retrieved user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{user}/password":
+ post:
+ summary: "Set a user's password or reset the user's existing password."
+ description: "Set a user's password or reset the user's existing password."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: username
+ in: path
+ description: "The username of the user."
+ required: true
+ type: string
+ - name: ResetPW
+ in: body
+ description: "The user's old and new password."
+ required: true
+ schema:
+ $ref: ResetPW
+ tags:
+ - Action
+ responses:
+ "200":
+ description: "An array of complete messages."
+ schema:
+ $ref: Action
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{userId}":
+ get:
+ summary: "Retrieve a user."
+ description: "Retrieve a user through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userID-2"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of retrieved user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ put:
+ summary: "Update a user"
+ description: "Update a user through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userID-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of updated user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ delete:
+ summary: "Delete a user."
+ description: "Remove a user through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userID-3"
+ tags:
+ - User
+ responses:
+ "200":
+ description: "An array of deleted user's info."
+ schema:
+ $ref: User
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{userId}/{relation}":
+ get:
+ summary: "Query a user's collections or connections."
+ description: "Retrieve a user's collections or connections through query statement."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userID-3"
+ - name: relation
+ in: path
+ description: "The relation between user and collections."
+ required: true
+ type: string
+ - name: queryStatement
+ in: query
+ description: "The query statement of the user."
+ required: true
+ type: string
+ tags:
+ - Entity
+ responses:
+ "200":
+ description: "An array of user's collections info."
+ schema:
+ $ref: Entity
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{userId}/feed":
+ get:
+ summary: "Get a user's feed."
+ description: "Retrieve a user's feed through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userID-3"
+ tags:
+ - ActivityFeed
+ responses:
+ "200":
+ description: "An array of user's activity feed."
+ schema:
+ $ref: ActivityFeed
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+
+ "/{orgId}/{appId}/devices/{deviceId}/notifications":
+ post:
+ summary: "Creating notifications for a single device."
+ description: "Create notifications for a single device. This request will target a specific device entity."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/deviceId"
+ - $ref: "#/parameters/notification"
+ - $ref: "#/parameters/scheduleNotificaiton"
+ - $ref: "#/parameters/setExpiration"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of created notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/devices/*/notifications":
+ post:
+ summary: "Creating notifications for all devices."
+ description: "Create notifications for all devices. This request will target all device entities."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/notification"
+ - $ref: "#/parameters/scheduleNotificaiton"
+ - $ref: "#/parameters/setExpiration"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of created notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/users/{userId}/notifications":
+ post:
+ summary: "Creating notifications for a user."
+ description: "Create notifications for a user. This request will target a specific user entity."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/userId-3"
+ - $ref: "#/parameters/notification"
+ - $ref: "#/parameters/scheduleNotificaiton"
+ - $ref: "#/parameters/setExpiration"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of created notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/groups/{path}/notifications":
+ post:
+ summary: "Creating notifications for a group."
+ description: "Create notifications for a group. This request will target all users associated with a specific group entity."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - name: path
+ in: path
+ description: "The path of the group."
+ required: true
+ type: string
+ - $ref: "#/parameters/notification"
+ - $ref: "#/parameters/scheduleNotificaiton"
+ - $ref: "#/parameters/setExpiration"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of created notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/devices":
+ post:
+ summary: "Creating notifications for user through location."
+ description: "Create notifications for user through targeting by location and providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/notification"
+ - $ref: "#/parameters/scheduleNotificaiton"
+ - $ref: "#/parameters/setExpiration"
+ - name: queryStatement
+ in: query
+ description: "The query statement of the location of the user."
+ required: true
+ type: string
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of created notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/notifications":
+ get:
+ summary: "Getting one or more notifications."
+ description: "Retrieve one or more notifications through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of retrieved notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{receiptId}/*/notifications":
+ get:
+ summary: "Getting notifications associated with one or more receipts."
+ description: "Retrieve notifications associated with one or more receipts through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/receiptId"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of retrieved notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{notificationId}/*/queue":
+ get:
+ summary: "Getting the list of devices associated with one or more notifications before the notifications are sent"
+ description: "Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Devices
+ responses:
+ "200":
+ description: "An array of retrieved device's info."
+ schema:
+ $ref: Device
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/my-org/sandbox/notifications/{notificationId}":
+ put:
+ summary: "Canceling sent notifications."
+ description: "Cancel sent notifications through providing the Id of the notification."
+ parameters:
+ - $ref: "#/parameters/notificationId"
+ - name: cancelMsg
+ in: body
+ description: "Indicete whether is canceled or not."
+ required: true
+ schema:
+ $ref: CancelMSG
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of canceled notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/notifications/{notificationId}":
+ delete:
+ summary: "Deleting unsent notifications."
+ description: "Remove unsent notifications through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Notification
+ responses:
+ "200":
+ description: "An array of deleted notification's info."
+ schema:
+ $ref: Notification
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/receipts":
+ get:
+ summary: "Getting one or more receipts."
+ description: "Retrieve one or more receipts through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Receipt
+ responses:
+ "200":
+ description: "An array of retrieved receipt's info."
+ schema:
+ $ref: Receipt
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{deviceId}/*/receipts":
+ get:
+ summary: "Getting receipts associated with one or more devices."
+ description: "Retrieve receipts associated with one or more devices through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/deviceId"
+ tags:
+ - Receipt
+ responses:
+ "200":
+ description: "An array of retrieved receipt's info."
+ schema:
+ $ref: "#/definitions/Receipt"
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+ "/{orgId}/{appId}/{notificationId}/*/receipts":
+ get:
+ summary: "Get receipts for one or more notifications."
+ description: "Retrieve receipts for one or more notifications through providing all the identifications."
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Receipt
+ responses:
+ "200":
+ description: "An array of retrieved receipt's info."
+ schema:
+ $ref: "Receipt"
+ default:
+ description: "Unexpected error."
+ schema:
+ $ref: Error
+
+parameters:
+ userId-1:
+ name: userId-1
+ in: path
+ description: "One of the user's identification which includes username, real name, email address or UUID."
+ required: true
+ type: string
+ userId-2:
+ name: userId-2
+ in: path
+ description: "One of the user's identification which includes username, email address or UUID."
+ required: true
+ type: string
+ userId-3:
+ name: userId-3
+ in: path
+ description: "One of the user's identification which includes username or UUID."
+ required: true
+ type: string
+ appId:
+ name: appId
+ in: path
+ description: "One of the application's identification which includes name or uuid."
+ required: true
+ type: string
+ orgId:
+ name: orgId
+ in: path
+ description: "One of the orgnization's identification which includes name or uuid."
+ required: true
+ type: string
+ groupId:
+ name: groupId
+ in: path
+ description: "One of the group's identification which includes name or uuid."
+ required: true
+ type: string
+ deviceId:
+ name: deviceId
+ in: path
+ description: "One of the device's identification which includes name or uuid."
+ required: true
+ type: string
+ notificationId:
+ name: notificationId
+ in: path
+ description: "One of the notification's identification which includes name or uuid."
+ required: true
+ type: string
+ receiptId:
+ name: receiptId
+ in: path
+ description: "One of the receipt's identification which includes name or uuid."
+ required: true
+ type: string
+ collectionId:
+ name: collectionId
+ in: path
+ description: "One of the collection's identification which includes name or uuid."
+ required: true
+ type: string
+ roleId:
+ name: roleId
+ in: path
+ description: "One of the role's identification which includes name or uuid."
+ required: true
+ type: string
+ entityId:
+ name: entityId
+ in: path
+ description: "One of the entity's identification which includes name or uuid."
+ required: true
+ type: string
+ notification:
+ name: notification
+ in: body
+ description: "These parameters are used when forming the notification portion of the request."
+ required: true
+ schema:
+ $ref: CreateNotifications
+ scheduleNotification:
+ name: scheduleNotification
+ in: body
+ description: "To schedule a notification for a later time add the deliver parameter with a UNIX timestamp to the body of your request."
+ required: false
+ schema:
+ $ref: ScheduleNotification
+ setExpiration:
+ name: setExpiration
+ in: body
+ description: "If a push service can't deliver a message to a device and needs to resend it you can set a notification to expire after a certain date/time."
+ required: false
+ schema:
+ $ref: SetExpiration
+
+definitions:
+ CancelMSG:
+ required:
+ - canceled
+ properties:
+ canceled:
+ type: boolean
+ Receipt:
+ properties:
+ uuid:
+ type: string
+ description: "Unique entity Id."
+ type:
+ type: string
+ description: "Type of entity."
+ created:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was created."
+ format: int32
+ modified:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was last modified."
+ format: int32
+ payloads:
+ type: string
+ description: "The push notifications to be delivered."
+ errorMessage:
+ type: string
+ description: "Error message returned by the notification service (APNs or GCM) if the notification fails entirely."
+ errorCode:
+ type: string
+ description: "Error code returned by the notification service."
+ sent:
+ type: number
+ description: "UTC timestamp in milliseconds for when the notification was sent."
+ metadata:
+ schema:
+ $ref: Metadata
+ completeMsg:
+ schema:
+ $ref: Action
+ Device:
+ properties:
+ uuid:
+ type: string
+ description: "Unique entity Id."
+ type:
+ type: string
+ description: "Type of entity."
+ name:
+ type: string
+ description: "Notifier display name."
+ created:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was created."
+ format: int32
+ modified:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was last modified."
+ format: int32
+ metadata:
+ schema:
+ $ref: Metadata
+ completeMsg:
+ schema:
+ $ref: Action
+ ScheduleNotification:
+ required:
+ - timestamp
+ properties:
+ timestamp:
+ type: number
+ description: "UTC timestamp in milliseconds of when schedule notifications."
+ format: int32
+ SetExpiration:
+ required:
+ - timestamp
+ properties:
+ timestamp:
+ type: number
+ description: "UTC timestamp in milliseconds of when set expirations."
+ format: int32
+ Notification:
+ required:
+ - payloads
+ properties:
+ uuid:
+ type: string
+ description: "Unique entity Id."
+ type:
+ type: string
+ description: "Type of entity."
+ created:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was created."
+ format: int32
+ modified:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was last modified."
+ format: int32
+ payloads:
+ type: string
+ description: "The push notifications to be delivered."
+ errorMessage:
+ type: string
+ description: "Error message returned by the notification service (APNs or GCM) if the notification fails entirely."
+ scheduled:
+ type: boolean
+ description: "whether the notification is currently scheduled for delivery."
+ state:
+ type: string
+ description: "The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'."
+ metadata:
+ schema:
+ $ref: Metadata
+ completeMsg:
+ schema:
+ $ref: Action
+ Notifier:
+ required:
+ - provider
+ - environment
+ properties:
+ uuid:
+ type: string
+ description: "Unique entity Id."
+ type:
+ type: string
+ description: "Type of entity."
+ name:
+ type: string
+ description: "Notifier display name."
+ created:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was created."
+ format: int32
+ modified:
+ type: number
+ description: "UTC timestamp in milliseconds of when the entity was last modified."
+ format: int32
+ provider:
+ type: string
+ description: "Push notification provider 'apple' or 'google'."
+ environment:
+ type: string
+ description: "The environment that corresponds to your app 'development' or 'production'."
+ metadata:
+ schema:
+ $ref: Metadata
+ CreateNotifications:
+ type: array
+ items:
+ $ref: CreateNotification
+ CreateNotification:
+ required:
+ - notifier
+ - message
+ properties:
+ notifier:
+ schema:
+ $ref: Notifier
+ message:
+ type: string
+ description: "The push notitfication message that will be delivered to the user."
+ Permission:
+ properties:
+ applicationName:
+ type: string
+ description: "The name of the application of the permission."
+ entity:
+ schema:
+ $ref: Entity
+ url:
+ type: string
+ description: "The url of the permission."
+ applicationId:
+ type: string
+ description: "The UUID of the application."
+ parameters:
+ type: string
+ description: "The parameters of the permission."
+ orgnization:
+ type: string
+ description: "The orgnization of the permission."
+ permissiondata:
+ schema:
+ $ref: AddPermission
+ AddPermission:
+ required:
+ - operation
+ - resource_path
+ properties:
+ operation:
+ type: string
+ description: "A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are allowed for the specified resource path."
+ resource_path:
+ type: string
+ description: "The path to the resources to be accessed."
+ Role:
+ properties:
+ applicationName:
+ type: string
+ description: "The application name of the event."
+ count:
+ type: number
+ description: "The numebr of the roles."
+ format: int32
+ entity:
+ schema:
+ $ref: Entity
+ url:
+ type: string
+ description: "The url of the event."
+ applicationId:
+ type: string
+ description: "The application UUID of the event."
+ parameters:
+ type: string
+ description: "The parameters of the event."
+ orgnization:
+ type: string
+ description: "The title of the orgnization."
+ completeMsg:
+ schema:
+ $ref: Action
+ path:
+ type: string
+ description: "The path of the role."
+ AddRole:
+ required:
+ - title
+ - role name
+ properties:
+ title:
+ type: string
+ description: "The title of the role."
+ role name:
+ type: string
+ description: "The name of the role."
+ Event:
+ properties:
+ applicationName:
+ type: string
+ description: "The application name of the event."
+ entity:
+ schema:
+ $ref: Entity
+ url:
+ type: string
+ description: "The url of the event."
+ applicationId:
+ type: string
+ description: "The application UUID of the event."
+ parameters:
+ type: string
+ description: "The parameters of the event."
+ orgnization:
+ type: string
+ description: "The title of the orgnization."
+ completeMsg:
+ schema:
+ $ref: Action
+ CreateEvent:
+ required:
+ - timestamp
+ properties:
+ timestamp:
+ type: number
+ format : int32
+ Group:
+ properties:
+ uuid:
+ type: string
+ description: "The UUID of the group."
+ type:
+ type: string
+ description: "The type of the group."
+ created:
+ type: string
+ description: "The created Id for the group."
+ modified:
+ type: string
+ description: "The modified Id for the group."
+ path:
+ type: string
+ description: "The path of the group."
+ metadata:
+ schema:
+ $ref: Metadata
+ title:
+ type: string
+ description: "The title of the group."
+ completeMsg:
+ schema:
+ $ref: Action
+ CreateGroup:
+ required:
+ - title
+ - path
+ properties:
+ title:
+ type: string
+ description: "The title of the group."
+ path:
+ type: string
+ description: "The path of the group."
+ CreateEntities:
+ type: array
+ items:
+ $ref: CreateEntity
+ CreateEntity:
+ properties:
+ property:
+ type: string
+ description: "The property of the entity."
+ value:
+ type: string
+ description: "The relevant value of the property."
+ Entity:
+ properties:
+ applicationId:
+ type: string
+ description: "The application Id of the entity."
+ parameters:
+ type: string
+ description: "The parameters of the entity."
+ path:
+ type: string
+ description: "The path of the entity."
+ url:
+ type: string
+ description: "The url of the entity."
+ entityproperty:
+ schema:
+ $ref: Entity
+ orgnization:
+ type: string
+ description: "The name of the orgnization."
+ applicationName:
+ type: string
+ description: "The name of the application."
+ count:
+ type: number
+ description: "The number of the entities retrieved."
+ format: int32
+ completeMsg:
+ schema:
+ $ref: Action
+ CreateApp:
+ required:
+ - token
+ - name
+ properties:
+ token:
+ type: string
+ description: "The OAuth2 access token."
+ name:
+ type: string
+ description: "The name of the application."
+ Credential:
+ properties:
+ client_Id:
+ type: string
+ description: "The Id of the client."
+ client_secret:
+ type: string
+ description: "The secret of the client."
+ completeMsg:
+ schema:
+ $ref: Action
+ Orgnization:
+ properties:
+ applicationId:
+ type: string
+ description: "The application Id of the owner."
+ username:
+ type: string
+ description: "The username of the owner."
+ name:
+ type: string
+ description: "The name of the owner."
+ email:
+ type: string
+ description: "The email of the owner."
+ activated:
+ type: boolean
+ description: "Indicate whether the account is activated or not."
+ disabled:
+ type: boolean
+ description: "Indicate whether the account is disabled or not."
+ uuid:
+ type: string
+ description: "The UUID of the owner."
+ adminUser:
+ type: boolean
+ description: "Indicate whether the use is a adminUser or not."
+ displayEmail:
+ type: string
+ description: "The display of the email of the owner."
+ htmldisplayEmail:
+ type: string
+ description: "The HTML display of the email of the owner."
+ orgname:
+ type: string
+ description: "The name of the orgnization."
+ orguuId:
+ type: string
+ description: "The UUID of the orgnization."
+ applicationdata:
+ schema:
+ $ref: AppData
+ completeMsg:
+ schema:
+ $ref: Action
+ AppData:
+ properties:
+ tester/sandbox:
+ type: string
+ description: "The UUID of tester/sandbox."
+ tester/app1:
+ type: string
+ description: "The UUID of tester/app1."
+ tester/app2:
+ type: string
+ description: "The UUID of tester/app2."
+ completeMsg:
+ schema:
+ $ref: Action
+ CreateOrg:
+ required:
+ - orgnization
+ - username
+ - name
+ - email
+ - password
+ properties:
+ orgnization:
+ type: string
+ username:
+ type: string
+ name:
+ type: string
+ email:
+ type: string
+ password:
+ type: string
+ CreateActivity:
+ required:
+ - displayName
+ - uuid
+ - username
+ - verb
+ - content
+ properties:
+ displayName:
+ type: string
+ uuid:
+ type: string
+ username:
+ type: string
+ image:
+ schema:
+ $ref: ImageModel
+ verb:
+ type: string
+ content:
+ type: string
+ ImageModel:
+ properties:
+ duration:
+ type: number
+ format: int32
+ height:
+ type: number
+ format: int32
+ url:
+ type: string
+ wIdth:
+ type: integer
+ format: int32
+ email:
+ type: string
+ ResetPWMsg:
+ required:
+ - recaptcha_response
+ - recaptcha_challenge
+ - email
+ properties:
+ recaptcha_response:
+ type: string
+ description: "Parameters and value for the Captcha challenge."
+ recaptcha_challenge:
+ type: string
+ description: "The admin user's response to the Captcha challenge."
+ email:
+ type: string
+ ResetPW:
+ required:
+ - password
+ - newpassword
+ properties:
+ password:
+ type: string
+ newpassword:
+ type: string
+ AdminUserUpdate:
+ properties:
+ city:
+ type: string
+ state:
+ type: string
+ CreateAdminUser:
+ required:
+ - username
+ properties:
+ username:
+ type: string
+ email:
+ type: string
+ name:
+ type: string
+ password:
+ type: string
+ CreateUser:
+ required:
+ - username
+ properties:
+ username:
+ type: string
+ User:
+ properties:
+ applicationId:
+ type: string
+ description: "The application Id of a user."
+ username:
+ type: string
+ description: "The username of a user."
+ name:
+ type: string
+ description: "The name of a user."
+ email:
+ type: string
+ description: "The email of a user."
+ activated:
+ type: boolean
+ description: "Indicate whether the account is activated or not."
+ disabled:
+ type: boolean
+ description: "Indicate whether the account is disabled or not."
+ uuid:
+ type: string
+ description: "The UUID of a user."
+ adminUser:
+ type: boolean
+ description: "Indicate whether the use is a adminUser or not."
+ displayEmail:
+ type: string
+ description: "The display of the email of a user."
+ htmldisplayEmail:
+ type: string
+ description: "The HTML display of the email of a user."
+ orgnization:
+ type: string
+ description: "The orgnization of the user."
+ picture:
+ type: string
+ description: "The uri of the user's picture."
+ uri:
+ type: string
+ description: "The uri of the user."
+ path:
+ type: string
+ description: "The path of the user."
+ completeMsg:
+ schema:
+ $ref: Action
+ Action:
+ properties:
+ action:
+ type: string
+ description: "The requested action."
+ status:
+ type: string
+ description: "The status of the requested action."
+ timestamp:
+ type: numebr
+ description: "The timestamp of the requested action."
+ format: int32
+ duration:
+ type: number
+ description: "The duration of the requested action."
+ format: int32
+ token:
+ type: string
+ description: "The token required for getting an AdminUser."
+ ActivityFeed:
+ properties:
+ entityproperty:
+ schema:
+ $ref: Entity
+ category:
+ type: string
+ description: "The category of the activity."
+ metadataproperty:
+ schema:
+ $ref: Metadata
+ objectproperty:
+ schema:
+ $ref: Object
+ title:
+ type: string
+ description: "The title of the activity."
+ verb:
+ type: string
+ description: "The verb of the activity."
+ published:
+ type: number
+ description: "The published Id of the activity."
+ format: int32
+ verb:
+ type: string
+ description: "The verb of the activity."
+ completeMsg:
+ schema:
+ $ref: Action
+ Object:
+ properties:
+ displayname:
+ type: string
+ description: "The display of the name of the object."
+ objecttype:
+ type: string
+ description: "The type of the object."
+ objectuuId:
+ type: string
+ description: "The UUID of the object."
+ entitytype:
+ type: string
+ description: "The entitytype of the object."
+ Metadata:
+ properties:
+ cursor:
+ type: string
+ description: "The cursor of the metadata."
+ path:
+ type: string
+ description: "The path of the metadata."
+ sets:
+ schema:
+ $ref: Sets
+ collections:
+ schema:
+ $ref: Collections
+ Collections:
+ properties:
+ activities:
+ type: string
+ feed:
+ type: string
+ roles:
+ type: string
+ users:
+ type: string
+ Sets:
+ properties:
+ rolenames:
+ type: string
+ permissions:
+ type: string
+ Actor:
+ properties:
+ displayname:
+ type: string
+ description: "The display of the name of the actor."
+ objecttype:
+ type: string
+ description: "The type of the actor."
+ objectuuId:
+ type: string
+ description: "The UUID of the actor."
+ entitytype:
+ type: string
+ description: "The entitytype of the actor."
+ Entity:
+ properties:
+ uuid:
+ type: string
+ description: "The UUID of the entity."
+ type:
+ type: string
+ description: "The type of the entity."
+ created:
+ type: number
+ description: "The Id of the created one."
+ format: int32
+ modified:
+ type: number
+ description: "The Id of the modified one."
+ format: int32
+ actorproperty:
+ schema:
+ $ref: Actor
+ metadata:
+ schema:
+ $ref: Metadata
+ name:
+ type: string
+ description: "The name of the entity."
+ price:
+ type: number
+ description: "The price of the entity."
+ format: int32
+ timestamp:
+ type: number
+ format: int32
+ message:
+ type: string
+ Error:
+ properties:
+ code:
+ type: integer
+ format: int32
+ message:
+ type: string
+ fields:
+ type: object
+
\ No newline at end of file