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/08/17 20:14:39 UTC
[1/5] incubator-usergrid git commit: Fixes and improvements to
Usergrid Swagger file and HTML generation. Specifically: - Add
cross-references for 1) which API paths reference each definition and 2)
which models reference each model. - Add descriptions f
Repository: incubator-usergrid
Updated Branches:
refs/heads/two-dot-o-dev daac07d2b -> 72016ea89
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/resources/usergrid-swagger.yaml
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/usergrid-swagger.yaml b/docs/src/main/resources/usergrid-swagger.yaml
index 2755035..da38ab2 100644
--- a/docs/src/main/resources/usergrid-swagger.yaml
+++ b/docs/src/main/resources/usergrid-swagger.yaml
@@ -1,8 +1,8 @@
swagger: "2.0"
info:
title: Usergrid API
- description: "Usergrid API"
- version: 1.0.0
+ description: Usergrid API
+ version: 2.1.0
host: api.usergrid.com
schemes:
- https
@@ -13,328 +13,281 @@ paths:
/management/token:
post:
- summary: "Admin-User Login."
- description: "Login with Admin-User or Organization credentials."
+ summary: Admin-User Login.
+ description: Login with Admin-User or Organization credentials.
parameters:
- name: login-credentials
in: body
- description: "Login credentials either username/password or id/secret."
+ description: Login credentials either username/password or id/secret.
required: true
schema:
$ref: LoginCredentials
tags:
- Access-Tokens
responses:
- "200":
- description: "Object containing access_token."
+ 200:
+ description: Object containing access_token.
schema:
- $ref: AccessTokenReponse
+ $ref: AccessTokenResponse
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/token:
post:
- summary: "App-User Login."
- description: "Login with App-User or Application credentials."
+ summary: App-User Login.
+ description: Login with App-User or Application credentials.
parameters:
- name: login-credentials
in: body
- description: "Login credentials either username/password or id/secret."
+ description: Login credentials either username/password or id/secret.
required: true
schema:
$ref: LoginCredentials
tags:
- Access-Tokens
responses:
- "200":
- description: "An array of new created Admin user's info."
+ 200:
+ description: Object containing access_token.
schema:
- $ref: AccessTokenReponse
+ $ref: AccessTokenResponse
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
-# /management/users:
-# post:
-# summary: ""
-# description: ""
-# 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:
-# - Access-Tokens
-# responses:
-# "200":
-# description: "An array of new created Admin user's info."
-# schema:
-# $ref: User
-# default:
-# description: "Unexpected error."
-# schema:
-# $ref: Error
-# /management/users:
-# post:
-# summary: ""
-# description: ""
-# 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:
-# - Access-Tokens
-# responses:
-# "200":
-# description: "An array of new created Admin user's info."
-# schema:
-# $ref: User
-# default:
-# description: "Unexpected error."
-# schema:
-# $ref: Error
/management/users:
post:
- summary: "Creating an admin user."
- description: "Create a whole new admin user."
+ summary: Creating an admin user.
+ description: Create a whole new admin user.
parameters:
- - name: adminuserproperty
+ - name: CreateAdminUser
in: body
- description: "One or more sets of user properties of which username is mandatory and must be unique."
+ description: User entity with fields required for User creation.
required: true
schema:
$ref: CreateAdminUser
tags:
- Admin-Users
responses:
- "200":
- description: "An array of new created Admin user's info."
+ 200:
+ description: An API Response with a entities array containing the newly created Admin User.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
-
-
-
/management/users/{userId}:
put:
- summary: "Updating an admin user."
- description: "Update the info of an admin user."
+ summary: Updating an admin user.
+ description: Update the info of an admin user.
parameters:
- $ref: "#/parameters/userId"
tags:
- Admin-Users
responses:
"200":
- description: "An array of user's details."
+ description: An API Response with a entities array containing the updated Admin User
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
get:
- summary: "Getting an admin user."
- description: "Retrieve details about an admin user."
+ summary: Getting an admin user.
+ description: Retrieve details about an admin user.
parameters:
- $ref: "#/parameters/userId"
tags:
- Admin-Users
responses:
"200":
- description: "An array of user's details"
+ description: An API Response with a entities array containing the Admin User.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ 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:
- Admin-Users
responses:
- "200":
- description: "An array of complete messages."
- schema:
+ 200:
+ description: An array of complete messages.
+ chema:
$ref: Action
default:
- description: "Unexpected error."
+ escription: Unexpected error.
schema:
$ref: Error
get:
summary: "Initiating a password reset."
- description: "Initiate the reset of an admin user's password."
+ description: Initiate the reset of an admin user's password.
tags:
- Admin-Users
responses:
- "200":
- description: "An array of complete messages."
+ 200:
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The user's old and new password.
required: true
schema:
$ref: ResetPW
tags:
- Admin-Users
responses:
- "200":
- description: "An array of complete messages."
+ 200:
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ 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."
+ summary: Activating an admin user.
+ description: Activate an admin user from a link provIded in an email notification.
parameters:
- $ref: "#/parameters/userId"
- name: token
in: query
- description: "Activation token's query statement."
+ 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."
+ description: Query statement of whether send confimation email or not.
required: true
type: boolean
tags:
- Admin-Users
responses:
- "200":
- description: "An array of complete messages."
+ 200:
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/users/{userId}/reactivate:
get:
- summary: "Reactivating an admin user."
- description: "Reactivate an expired admin user."
+ summary: Reactivating an admin user.
+ description: Reactivate an expired admin user.
parameters:
- $ref: "#/parameters/userId"
tags:
- Admin-Users
responses:
"200":
- description: "An array of complete messages."
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ 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."
+ summary: Getting an admin user's activity feed.
+ description: Retrieve an admin user's activity feed.
parameters:
- $ref: "#/parameters/userId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of user's activity"
+ description: An array of user's activity
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: One or more sets of activity properties.
required: true
schema:
$ref: CreateActivity
tags:
- Activities
responses:
- "200":
- description: "An array of user's activity."
+ 200:
+ description: An array of user's activity.
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: One or more sets of activity properties.
required: true
schema:
$ref: CreateActivity
tags:
- Groups
responses:
- "200":
- description: "An array of user's activity."
+ 200:
+ escription: An array of user's activity.
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs:
post:
summary: "Creating an organization."
- description: "Create an organization through a form post."
+ description: Create an organization through a form post.
parameters:
- name: CreateOrg
in: body
- description: "A set of organization properties supplied through a form."
+ description: A set of organization properties supplied through a form.
required: true
schema:
$ref: CreateOrg
@@ -342,133 +295,133 @@ paths:
- Organizations-Applications
responses:
"200":
- description: "An array of created Organization."
+ description: An array of created Organization.
schema:
$ref: Organization
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}:
get:
summary: "Getting an organization."
- description: "Retrieve an organization given a specified UUID or username."
+ description: Retrieve an organization given a specified UUID or username.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of created Organization."
+ description: An array of created Organization.
schema:
$ref: Organization
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/activate:
get:
summary: "Activating an organization."
- description: "Activate an organization from a link provIded in an email notification."
+ description: Activate an organization from a link provIded in an email notification.
parameters:
- $ref: "#/parameters/orgId"
- name: token
in: query
- description: "Activation token."
+ description: Activation token.
required: true
type: string
- name: confirm_email
in: query
- description: "Send confirmation email or not."
+ description: Send confirmation email or not.
required: true
type: boolean
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of complete messages."
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/reactivate:
get:
summary: "Reactivating an organization"
- description: "Reactivate an expired organization."
+ description: Reactivate an expired organization.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of complete messages."
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/credentials:
post:
summary: "Generating organization client credentials."
- description: "Generate whole new credentials for an organization client."
+ description: Generate whole new credentials for an organization client.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of Credential"
+ description: An array of Credential
schema:
$ref: Credential
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
get:
summary: "Retrieving organization client credentials."
- description: "Retrieve the credentials for an organization client."
+ description: Retrieve the credentials for an organization client.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of Credential"
+ description: An array of Credential
schema:
$ref: Credential
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/feed:
get:
summary: "Getting an organization's activity feed."
- description: "Retrieve an organization's activity feed."
+ description: Retrieve an organization's activity feed.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of the organization's ActivityFeed."
+ description: An array of the organization's ActivityFeed.
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/apps:
post:
summary: "Creating an organization application."
- description: "Create an application for an organization through a form post."
+ description: Create an application for an organization through a form post.
parameters:
- $ref: "#/parameters/orgId"
- name: CreateApp
in: body
- description: "A set of organization properties supplied through a form."
+ description: A set of organization properties supplied through a form.
required: true
schema:
$ref: CreateApp
@@ -476,35 +429,35 @@ paths:
- Admin
responses:
"200":
- description: "An array of complete messages."
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
-# /management/orgs/{orgId}/apps/{appId}:
-# delete:
-# summary: "Removing an application from the organization."
-# description: "Remove an application from an organization through providing both Id of application and organization."
-# parameters:
-# - $ref: "#/parameters/orgId"
-# - $ref: "#/parameters/appId"
-# tags:
-# - Organizations-Applications
-# responses:
-# "200":
-# description: "An array of deleted application info."
-# schema:
-# $ref: AppData
-# default:
-# description: "Unexpected error."
-# schema:
-# $ref: Error
+ /management/orgs/{orgId}/apps/{appId}:
+ delete:
+ summary: "Removing an application from the organization."
+ description: Remove an application from an organization through providing both Id of application and organization.
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/appId"
+ tags:
+ - Organizations-Applications
+ 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 organization."
+ description: Generate the client Id and client secret credentials for an application in an organization.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -512,16 +465,16 @@ paths:
- Organizations-Applications
responses:
"200":
- description: "An array of generated credentials info."
+ description: An array of generated credentials info.
schema:
$ref: Credential
default:
- description: "Unexpected error."
+ 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 organization."
+ description: Retrieve the client Id and client secret credentials for an application in an organization.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -529,34 +482,34 @@ paths:
- Organizations-Applications
responses:
"200":
- description: "An array of retrieved credentials info."
+ description: An array of retrieved credentials info.
schema:
$ref: Credential
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/apps:
get:
summary: "Getting the applications in an organization."
- description: "Retrieve the applications in an organization through providing both Id of application and organization."
+ description: Retrieve the applications in an organization through providing both Id of application and organization.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Organizations-Applications
responses:
"200":
- description: "An array of retrieved application data."
+ description: An array of retrieved application data.
schema:
$ref: AppData
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/users/{userId}:
put:
summary: "Adding an admin user to an organization."
- description: "Add an existing admin user to an organization."
+ description: Add an existing admin user to an organization.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/userId-2"
@@ -564,34 +517,34 @@ paths:
- Organizations-Applications
responses:
"200":
- description: "An array of new added Admin user's info."
+ description: An array of new added Admin user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/users:
get:
summary: "Getting the admin users in an organization."
- description: "Retrieve details about the admin users in an organization."
+ description: Retrieve details about the admin users in an organization.
parameters:
- $ref: "#/parameters/orgId"
tags:
- Admin-Users
responses:
"200":
- description: "An array of retrieved Admin user's info."
+ description: An array of retrieved Admin user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/management/orgs/{orgId}/users/{userId}:
delete:
summary: "Removing an admin user from an organization."
- description: "Remove an admin user from an organization through providing both Id of application and organization."
+ description: Remove an admin user from an organization through providing both Id of application and organization.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/userId-2"
@@ -599,18 +552,18 @@ paths:
- Admin-Users
responses:
"200":
- description: "An array of deleted Admin user's info."
+ description: An array of deleted Admin user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ description: Use the GET method to retrieve a set of entities from a collection.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -619,28 +572,28 @@ paths:
- Entities-Collections
responses:
"200":
- description: "An array of retrieved collection's info."
+ description: An array of retrieved collection's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ 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. "
+ 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."
+ description: The entity type to create.
required: true
type: string
- name: entityproperty
in: body
- description: "The properties of the entity."
+ description: The properties of the entity.
required: true
schema:
$ref: CreateEntities
@@ -648,17 +601,17 @@ paths:
- Entities-Collections
responses:
"200":
- description: "An array of created custom entity's info."
+ description: An array of created custom entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ 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."
+ description: Retrieve an entity through providing Id of application, organization, collection and entity.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -668,16 +621,16 @@ paths:
- Entities-Collections
responses:
"200":
- description: "An array of retrieved entity's info."
+ description: An array of retrieved entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
put:
summary: "Updating an entity."
- description: "One or more properties can be updated with a single request."
+ description: One or more properties can be updated with a single request.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -685,7 +638,7 @@ paths:
- $ref: "#/parameters/entityId"
- name: entityproperty
in: body
- description: "The properties of the entity."
+ description: The properties of the entity.
required: true
schema:
$ref: CreateEntities
@@ -693,16 +646,16 @@ paths:
- Entities-Collections
responses:
"200":
- description: "An array of updated entity's info."
+ description: An array of updated entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
delete:
summary: "Deleting an entity."
- description: "Delete an entity from the collection."
+ description: Delete an entity from the collection.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -712,137 +665,137 @@ paths:
- Entities-Collections
responses:
"200":
- description: "An array of deleted entity's info."
+ description: An array of deleted entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/{collectionId}:
get:
summary: "Query a collection。"
- description: "Retrieve collection through query statement."
+ 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."
+ description: Any values specified in the query statement should be enclosed in single-quotes.
required: true
type: string
tags:
- Entities-Collections
responses:
"200":
- description: "An array of retrieved collection's info."
+ description: An array of retrieved collection's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
put:
summary: "Update a collection by query"
- description: "Update collection through query statement."
+ 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."
+ description: Any values specified in the query statement should be enclosed in single-quotes.
required: true
type: string
tags:
- Entities-Collections
responses:
"200":
- description: "An array of updated collection's info."
+ description: An array of updated collection's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The Id of the 1st entity.
required: true
type: string
- name: relation
in: path
- description: "The relation between 1st entity and 2nd entity."
+ description: The relation between 1st entity and 2nd entity.
required: true
type: string
- name: entityId2
in: path
- description: "The Id of the 2nd entity."
+ description: The Id of the 2nd entity.
required: true
type: string
tags:
- Entities-Collections
responses:
"200":
- description: "An array of added entity's info."
+ description: An array of added entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The Id of the 1st entity.
required: true
type: string
- name: relation
in: path
- description: "The relation between 1st entity and 2nd entity."
+ description: The relation between 1st entity and 2nd entity.
required: true
type: string
- name: entityId2
in: path
- description: "The Id of the 2nd entity."
+ description: The Id of the 2nd entity.
required: true
type: string
tags:
- Entities-Collections
responses:
"200":
- description: "An array of deleted entity's info."
+ description: An array of deleted entity's info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/events:
post:
summary: "Create an event."
- description: "Create an event through providing both Id of organization and application."
+ description: Create an event through providing both Id of organization and application.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
- name: CreateEvent
in: body
- description: "The required property of the event."
+ description: The required property of the event.
required: true
schema:
$ref: CreateEvent
@@ -850,23 +803,23 @@ paths:
- Events
responses:
"200":
- description: "An array of created event's info."
+ description: An array of created event's info.
schema:
$ref: Event
default:
- description: "Unexpected error."
+ 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 organization and application."
+ description: Create a new group through providing both Id of organization and application.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
- name: groupproperty
in: body
- description: "The property of the created group."
+ description: The property of the created group.
required: true
schema:
$ref: CreateGroup
@@ -874,18 +827,18 @@ paths:
- Groups
responses:
"200":
- description: "An array of created group's info."
+ description: An array of created group's info.
schema:
$ref: Group
default:
- description: "Unexpected error."
+ 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."
+ description: Add a user to a group through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -895,16 +848,16 @@ paths:
- Groups
responses:
"200":
- description: "An array of added user's info."
+ description: An array of added user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
delete:
summary: "Delete user from a group."
- description: "Delete user from a group through providing all the identifications."
+ description: Delete user from a group through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -914,17 +867,17 @@ paths:
- Groups
responses:
"200":
- description: "An array of deleted user's info."
+ description: An array of deleted user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ description: Get a group through through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -933,16 +886,16 @@ paths:
- Groups
responses:
"200":
- description: "An array of retrieved group's info."
+ description: An array of retrieved group's info.
schema:
$ref: Group
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
put:
summary: "Update a group."
- description: "Update a group through providing all the identifications."
+ description: Update a group through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -951,17 +904,17 @@ paths:
- Groups
responses:
"200":
- description: "An array of updated group's info."
+ description: An array of updated group's info.
schema:
$ref: Group
default:
- description: "Unexpected error."
+ 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."
+ description: Get a group's feed through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -970,23 +923,23 @@ paths:
- Activities
responses:
"200":
- description: "An array of group's activity."
+ description: An array of group's activity.
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The required properties of the role.
required: true
schema:
$ref: AddRole
@@ -994,16 +947,16 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of created role's info."
+ description: An array of created role's info.
schema:
$ref: Role
default:
- description: "Unexpected error."
+ 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."
+ description: Retrieve the roles in an application through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1011,64 +964,64 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of retrieved role's info."
+ description: An array of retrieved role's info.
schema:
$ref: Role
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/roles/{rolename}:
delete:
summary: "Delete a role."
- description: "Remove a role through providing all the identifications."
+ 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."
+ description: The name of the role.
required: true
type: string
tags:
- Permissions-Roles
responses:
"200":
- description: "An array of deleted role's info."
+ description: An array of deleted role's info.
schema:
$ref: Role
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
- /{orgId}/{appId}/roles/{roleId}/permissions:
+ /{orgId}/{applicationId}/roles/{roleId}/permissions:
post:
summary: "Add permissions to a role."
- description: "Add permissions to a role through providing all the identifications."
+ description: Add permissions to a role through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
- $ref: "#/parameters/roleId"
- - name: permissionproperty
+ - name: Permissions
in: body
- description: "the properties of permissions"
+ description: Permissions object with array of Usergrid Permission strings to be added.
required: true
schema:
- $ref: AddPermission
+ $ref: Permissions
tags:
- Permissions-Roles
responses:
"200":
- description: "An array of created permission's info."
+ description: Permissions object with array of Usergrid Permission strings.
schema:
$ref: Permission
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
get:
summary: "Get permissions for a role."
- description: "Retrieve permissions for a role through providing all the identifications."
+ description: Retrieve permissions for a Role.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1077,41 +1030,42 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of retrieved permission's info."
+ description: Permissions object with array of Usergrid Permission strings.
schema:
- $ref: Permission
+ $ref: Permissions
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/roles/{roleId}/permissions:
delete:
summary: "Delete permissions from a role."
- description: "Remove permissions from a role. "
+ description: Remove permissions from a role.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
- $ref: "#/parameters/roleId"
- - name: grant_url_pattern
- in: query
- description: "The query statement of the url pattern."
+ - name: Permissions
+ in: body
+ description: The query statement of the url pattern.
required: true
- type: string
+ schema:
+ $ref: Permissions
tags:
- Permissions-Roles
responses:
"200":
- description: "An array of deleted permission's info."
+ description: Permissions object with array of the deleated Usergrid Permission strings.
schema:
- $ref: Permission
+ $ref: Permissions
default:
- description: "Unexpected error."
+ 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."
+ description: Add a user to a role through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1121,16 +1075,16 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of added user's info."
+ description: An array of added user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ description: Remove a user from a role through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1140,17 +1094,17 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of deleted user's info."
+ description: An array of deleted user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ description: Retrieve the users in a role through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1159,23 +1113,23 @@ paths:
- Permissions-Roles
responses:
"200":
- description: "An array of retrieved user's info."
+ description: An API Response with a entities array of Users.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The properties of the user.
required: true
schema:
$ref: CreateUser
@@ -1183,50 +1137,50 @@ paths:
- App-Users
responses:
"200":
- description: "An array of created user's info."
+ description: An array of created user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
get:
summary: "Query to get users."
- description: "Retrieve users though query statement."
+ description: Retrieve users though query statement.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
- name: queryStatement
in: query
- description: "The query statement of the User."
+ description: The query statement of the User.
required: true
type: string
tags:
- App-Users
responses:
"200":
- description: "An array of retrieved user's info."
+ description: An array of retrieved user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The username of the user.
required: true
type: string
- name: ResetPW
in: body
- description: "The user's old and new password."
+ description: The user's old and new password.
required: true
schema:
$ref: ResetPW
@@ -1234,17 +1188,17 @@ paths:
- App-Users
responses:
"200":
- description: "An array of complete messages."
+ description: An array of complete messages.
schema:
$ref: Action
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
/{orgId}/{appId}/users/{userId}:
get:
summary: "Retrieve a user."
- description: "Retrieve a user through providing all the identifications."
+ description: Retrieve a user through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1253,16 +1207,16 @@ paths:
- App-Users
responses:
"200":
- description: "An array of retrieved user's info."
+ description: An array of retrieved user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
put:
summary: "Update a user"
- description: "Update a user through providing all the identifications."
+ description: Update a user through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1271,16 +1225,16 @@ paths:
- App-Users
responses:
"200":
- description: "An array of updated user's info."
+ description: An array of updated user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ description: Unexpected error.
schema:
$ref: Error
delete:
summary: "Delete a user."
- description: "Remove a user through providing all the identifications."
+ description: Remove a user through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1289,46 +1243,46 @@ paths:
- App-Users
responses:
"200":
- description: "An array of deleted user's info."
+ description: An array of deleted user's info.
schema:
$ref: User
default:
- description: "Unexpected error."
+ 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."
+ 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."
+ description: The relation between user and collections.
required: true
type: string
- name: queryStatement
in: query
- description: "The query statement of the user."
+ description: The query statement of the user.
required: true
type: string
tags:
- Entities-Collections
responses:
"200":
- description: "An array of user's collections info."
+ description: An array of user's collections info.
schema:
$ref: Entity
default:
- description: "Unexpected error."
+ 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."
+ description: Retrieve a user's feed through providing all the identifications.
parameters:
- $ref: "#/parameters/orgId"
- $ref: "#/parameters/appId"
@@ -1337,536 +1291,503 @@ paths:
- Activities
responses:
"200":
- description: "An array of user's activity feed."
+ description: An array of user's activity feed.
schema:
$ref: ActivityFeed
default:
- description: "Unexpected error."
+ 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/scheduleNotification"
-# - $ref: "#/parameters/setExpiration"
-# tags:
-# - Notifications
-# 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/scheduleNotification"
-# - $ref: "#/parameters/setExpiration"
-# tags:
-# - Notifications
-# 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/scheduleNotification"
-# - $ref: "#/parameters/setExpiration"
-# tags:
-# - Notifications
-# 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/scheduleNotification"
-# - $ref: "#/parameters/setExpiration"
-# tags:
-# - Notifications
-# 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/scheduleNotification"
-# - $ref: "#/parameters/setExpiration"
-# - name: queryStatement
-# in: query
-# description: "The query statement of the location of the user."
-# required: true
-# type: string
-# tags:
-# - Notifications
-# 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:
-# - Notifications
-# 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:
-# - Notifications
-# 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:
-# - Notifications
-# responses:
-# "200":
-# description: "An array of retrieved device's info."
-# schema:
-# $ref: Device
-# default:
-# description: "Unexpected error."
-# schema:
-# $ref: Error
-# "/{orgId}/{appId}/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:
-# - Notifications
-# 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:
-# - Notifications
-# 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:
-# - Notifications
-# 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:
-# - Notifications
-# 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:
-# - Notifications
-# responses:
-# "200":
-# description: "An array of retrieved receipt's info."
-# schema:
-# $ref: "Receipt"
-# default:
-# description: "Unexpected error."
-# schema:
-# $ref: Error
-
+ /{orgId}/{applicationId}/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/applicationId"
+ - $ref: "#/parameters/deviceId"
+ - $ref: "#/parameters/notification"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of created notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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/applicationId"
+ - $ref: "#/parameters/notification"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of created notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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/applicationId"
+ - $ref: "#/parameters/userId-3"
+ - $ref: "#/parameters/notification"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of created notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of created notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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/applicationId"
+ - $ref: "#/parameters/notification"
+ - name: queryStatement
+ in: query
+ description: The query statement of the location of the user.
+ required: true
+ type: string
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of created notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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/applicationId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/{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/applicationId"
+ - $ref: "#/parameters/receiptId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved notification's info.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/{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/applicationId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved device's info.
+ schema:
+ $ref: Device
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ "/{orgId}/{applicationId}/notifications/{notificationId}":
+ put:
+ summary: "Update a Notification"
+ description: Update a Notification in order to cancel the notifcation or set a new expiration time.
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/applicationId"
+ - $ref: "#/parameters/notificationId"
+ - name: notificationUpdate
+ in: body
+ description: Object with Notification fields to be updated.
+ required: true
+ schema:
+ $ref: NotificationUpdate
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An API Response object containing an entity of type Notification.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ delete:
+ summary: "Deleting unsent notifications"
+ description: Delete an unsent Notification from the system.
+ parameters:
+ - $ref: "#/parameters/orgId"
+ - $ref: "#/parameters/applicationId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: API Response containing Notification entity that was deleted.
+ schema:
+ $ref: Notification
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/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/applicationId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved receipt's info.
+ schema:
+ $ref: Receipt
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/{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/applicationId"
+ - $ref: "#/parameters/deviceId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved receipt's info.
+ schema:
+ $ref: "#/definitions/Receipt"
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
+ /{orgId}/{applicationId}/{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/applicationId"
+ - $ref: "#/parameters/notificationId"
+ tags:
+ - Notifications
+ responses:
+ "200":
+ description: An array of retrieved receipt's info.
+ schema:
+ $ref: "Receipt"
+ default:
+ description: Unexpected error.
+ schema:
+ $ref: Error
parameters:
userId:
name: userId
in: path
- description: "One of the user's identification which includes username, real name, email address or UUID."
+ description: One of the user's identification which includes username, real name, email address or UUID.
required: true
type: string
userId-1:
name: userId-1
in: path
- description: "One of the user's identification which includes username, real name, email address or UUID."
+ 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."
+ 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."
+ 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."
+ description: One of the application's identification which includes name or uuid.
+ required: true
+ type: string
+ applicationId:
+ name: applicationId
+ in: path
+ description: One of the application's identification which includes name or uuid (same as appId).
required: true
type: string
orgId:
name: orgId
in: path
- description: "One of the organization's identification which includes name or uuid."
+ description: One of the organization'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."
+ 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."
+ 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."
+ 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."
+ 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."
+ 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."
+ 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."
+ 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."
+ 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
+ NotificationUpdate:
+ description: Represents fields that may be updated on a Notification to cause changes in Push Notification processing.
properties:
canceled:
+ description: Setting this field to true will cancel a Notification, if it has not yet been sent.
type: boolean
- Receipt:
+ deliver:
+ description: Specifies the UNIX timestamp time at which the Notification should be sent.
+ type: number
+ expired:
+ description: Specifies the UNIX timestamp time at which this Notification has expired.
+ type: number
+ Receipt:
+ description: Represents response received from Notification service indicating success or failure.
properties:
uuid:
type: string
- description: "Unique entity Id."
+ description: Unique entity Id.
type:
type: string
- description: "Type of entity."
+ description: Type of entity.
created:
type: number
- description: "UTC timestamp in milliseconds of when the entity was created."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was created.
modified:
type: number
- description: "UTC timestamp in milliseconds of when the entity was last modified."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was last modified.
payloads:
type: string
- description: "The push notifications to be delivered."
+ 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."
+ 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."
+ description: Error code returned by the notification service.
sent:
type: number
- description: "UTC timestamp in milliseconds for when the notification was sent."
+ description: UTC timestamp in milliseconds for when the notification was sent.
metadata:
$ref: Metadata
completeMsg:
$ref: Action
Device:
+ description: Represents a single Device that is registered for recieving of Push Notifications.
properties:
uuid:
type: string
- description: "Unique entity Id."
+ description: Unique entity Id.
type:
type: string
- description: "Type of entity."
+ description: Type of entity.
name:
type: string
- description: "Notifier display name."
+ description: Notifier display name.
created:
type: number
- description: "UTC timestamp in milliseconds of when the entity was created."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was created.
modified:
type: number
- description: "UTC timestamp in milliseconds of when the entity was last modified."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was last modified.
metadata:
$ref: Metadata
completeMsg:
$ref: Action
- ScheduleNotification:
- # TODO should be a long and not a string
- required:
- - timestamp
- properties:
- timestamp:
- type: string
- description: "UTC timestamp in milliseconds of when schedule notifications."
- #format: int64
- SetExpiration:
- # TODO should be a long and not a string
- required:
- - timestamp
- properties:
- timestamp:
- type: string
- description: "UTC timestamp in milliseconds of when set expirations."
- #format: int64
Notification:
+ description: Represents a Push Notification that is either scheduled, finished or cancelled.
required:
- payloads
properties:
uuid:
type: string
- description: "Unique entity Id."
+ description: Unique entity Id.
type:
type: string
- description: "Type of entity."
+ description: Type of entity.
created:
type: number
- description: "UTC timestamp in milliseconds of when the entity was created."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was created.
modified:
type: number
- description: "UTC timestamp in milliseconds of when the entity was last modified."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was last modified.
payloads:
type: string
- description: "The push notifications to be delivered."
+ 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."
+ 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."
+ description: Whether the notification is currently scheduled for delivery.
state:
type: string
- description: "The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'."
+ description: The current delivery status of the notification 'FINISHED', 'SCHEDULED' or 'CANCELED'.
metadata:
$ref: Metadata
completeMsg:
$ref: Action
Notifier:
+ description: Represents an account that is registered with a Push provider (e.g. Apple or Google) for sending notifications.
required:
- provider
- environment
properties:
uuid:
type: string
- description: "Unique entity Id."
+ description: Unique entity Id.
type:
type: string
- description: "Type of entity."
+ description: Type of entity.
name:
type: string
- description: "Notifier display name."
+ description: Notifier display name.
created:
type: number
- description: "UTC timestamp in milliseconds of when the entity was created."
- format: int64
+ description: UTC timestamp in milliseconds of when the entity was created.
modified:
type: number
- descriptio
<TRUNCATED>
[2/5] incubator-usergrid git commit: Fixes and improvements to
Usergrid Swagger file and HTML generation. Specifically: - Add
cross-references for 1) which API paths reference each definition and 2)
which models reference each model. - Add descriptions f
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/rest-endpoints/api-docs.md
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.md b/docs/rest-endpoints/api-docs.md
index 51f1909..a21be09 100644
--- a/docs/rest-endpoints/api-docs.md
+++ b/docs/rest-endpoints/api-docs.md
@@ -4,15 +4,16 @@ Methods are organized by tag. Follow the methods are the [Model Definitions](#mo
<h2>Table of Contents</h2>
-* [Access-Tokens](#access-tokens)
-* [Activities](#activities)
-* [Admin-Users](#admin-users)
-* [App-Users](#app-users)
-* [Entities-Collections](#entities-collections)
-* [Events](#events)
-* [Groups](#groups)
-* [Organizations-Applications](#organizations-applications)
-* [Permissions-Roles](#permissions-roles)
+* [Access-Tokens](#Access-Tokens)
+* [Activities](#Activities)
+* [Admin-Users](#Admin-Users)
+* [App-Users](#App-Users)
+* [Entities-Collections](#Entities-Collections)
+* [Events](#Events)
+* [Groups](#Groups)
+* [Notifications](#Notifications)
+* [Organizations-Applications](#Organizations-Applications)
+* [Permissions-Roles](#Permissions-Roles)
<br>
<br>
@@ -30,7 +31,7 @@ Login with Admin-User or Organization credentials.
<h3>Parameters</h3>
-* __login-credentials__ ([LoginCredentials](#logincredentials))
+* __login-credentials__ ([LoginCredentials](#LoginCredentials))
Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
@@ -38,12 +39,12 @@ Login credentials either username/password or id/secret. (Specified in body).
__200__
* Description: Object containing access_token.
-* Schema: [AccessTokenReponse](#accesstokenreponse)
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/token</h2>
@@ -52,20 +53,20 @@ Login with App-User or Application credentials.
<h3>Parameters</h3>
-* __login-credentials__ ([LoginCredentials](#logincredentials))
+* __login-credentials__ ([LoginCredentials](#LoginCredentials))
Login credentials either username/password or id/secret. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [AccessTokenReponse](#accesstokenreponse)
+* Description: Object containing access_token.
+* Schema: [AccessTokenResponse](#AccessTokenResponse)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Activities
@@ -89,12 +90,12 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of group's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{userId}/activities</h2>
@@ -109,7 +110,7 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __userId-3__ (string)
One of the user's identification which includes username or UUID. (Specified in path).
-* __CreateActivity__ ([CreateActivity](#createactivity))
+* __CreateActivity__ ([CreateActivity](#CreateActivity))
One or more sets of activity properties. (Specified in body).
<h3>Responses</h3>
@@ -117,12 +118,12 @@ One or more sets of activity properties. (Specified in body).
__200__
* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}/feed</h2>
@@ -143,12 +144,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of user's activity feed.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Admin-Users
@@ -168,12 +169,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved Admin user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}</h2>
@@ -192,12 +193,12 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of deleted Admin user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/users</h2>
@@ -206,20 +207,20 @@ Create a whole new admin user.
<h3>Parameters</h3>
-* __adminuserproperty__ ([CreateAdminUser](#createadminuser))
-One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
+* __CreateAdminUser__ ([CreateAdminUser](#CreateAdminUser))
+User entity with fields required for User creation. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of new created Admin user's info.
-* Schema: [User](#user)
+* Description: An API Response with a entities array containing the newly created Admin User.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/resetpw</h2>
@@ -234,12 +235,12 @@ Initiate the reset of an admin user's password.
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/users/resetpw</h2>
@@ -248,7 +249,7 @@ Complete the password reset through getting the newpassword and the old one for
<h3>Parameters</h3>
-* __ResetPWMsg__ ([ResetPWMsg](#resetpwmsg))
+* __ResetPWMsg__ ([ResetPWMsg](#ResetPWMsg))
Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
<h3>Responses</h3>
@@ -256,12 +257,12 @@ Parameters and value for the Captcha challenge, the admin user's response to
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [](#)
__default__
-* Description: Unexpected error.
-* Schema: [Error](#error)
+* Description:
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}</h2>
@@ -277,13 +278,13 @@ One of the user's identification which includes username, real name, email a
__200__
-* Description: An array of user's details
-* Schema: [User](#user)
+* Description: An API Response with a entities array containing the Admin User.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}</h2>
@@ -299,13 +300,13 @@ One of the user's identification which includes username, real name, email a
__200__
-* Description: An array of user's details.
-* Schema: [User](#user)
+* Description: An API Response with a entities array containing the updated Admin User
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/activate</h2>
@@ -326,12 +327,12 @@ Query statement of whether send confimation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /management/users/{userId}/password</h2>
@@ -342,7 +343,7 @@ Update an admin user's password through getting the newpassword and the old
* __userId__ (string)
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
-* __ResetPW__ ([ResetPW](#resetpw))
+* __ResetPW__ ([ResetPW](#ResetPW))
The user's old and new password. (Specified in body).
<h3>Responses</h3>
@@ -350,12 +351,12 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/reactivate</h2>
@@ -372,12 +373,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### App-Users
@@ -401,12 +402,12 @@ The query statement of the User. (Specified in query).
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users</h2>
@@ -419,7 +420,7 @@ Create a user in the users collection through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __CreateUser__ ([CreateUser](#createuser))
+* __CreateUser__ ([CreateUser](#CreateUser))
The properties of the user. (Specified in body).
<h3>Responses</h3>
@@ -427,12 +428,12 @@ The properties of the user. (Specified in body).
__200__
* Description: An array of created user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/users/{userId}</h2>
@@ -453,12 +454,12 @@ One of the user's identification which includes username, email address or U
__200__
* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/users/{userId}</h2>
@@ -479,12 +480,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of updated user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}</h2>
@@ -505,12 +506,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/users/{user}/password</h2>
@@ -525,7 +526,7 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __username__ (string)
The username of the user. (Specified in path).
-* __ResetPW__ ([ResetPW](#resetpw))
+* __ResetPW__ ([ResetPW](#ResetPW))
The user's old and new password. (Specified in body).
<h3>Responses</h3>
@@ -533,12 +534,12 @@ The user's old and new password. (Specified in body).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Entities-Collections
@@ -566,12 +567,12 @@ The query statement of the user. (Specified in query).
__200__
* Description: An array of user's collections info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}</h2>
@@ -594,12 +595,12 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of retrieved collection's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}</h2>
@@ -622,12 +623,12 @@ Any values specified in the query statement should be enclosed in single-quotes.
__200__
* Description: An array of updated collection's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
@@ -654,12 +655,12 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of added entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}</h2>
@@ -686,12 +687,12 @@ The Id of the 2nd entity. (Specified in path).
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -714,12 +715,12 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of retrieved entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -736,7 +737,7 @@ One of the application's identification which includes name or uuid. (Specif
One of the collection's identification which includes name or uuid. (Specified in path).
* __entityId__ (string)
One of the entity's identification which includes name or uuid. (Specified in path).
-* __entityproperty__ ([CreateEntities](#createentities))
+* __entityproperty__ ([CreateEntities](#CreateEntities))
The properties of the entity. (Specified in body).
<h3>Responses</h3>
@@ -744,12 +745,12 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of updated entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}</h2>
@@ -772,17 +773,17 @@ One of the entity's identification which includes name or uuid. (Specified i
__200__
* Description: An array of deleted entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/{entitytype}</h2>
-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.
+When a new entity is created, Usergrid will automatically create a corresponding collection if one does not already exist. The collection will automatically be named with the plural form of the entity type.
<h3>Parameters</h3>
@@ -792,7 +793,7 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __entitytype__ (string)
The entity type to create. (Specified in path).
-* __entityproperty__ ([CreateEntities](#createentities))
+* __entityproperty__ ([CreateEntities](#CreateEntities))
The properties of the entity. (Specified in body).
<h3>Responses</h3>
@@ -800,12 +801,12 @@ The properties of the entity. (Specified in body).
__200__
* Description: An array of created custom entity's info.
-* Schema: [Entity](#entity)
+* Schema: [Entity](#Entity)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Events
@@ -821,7 +822,7 @@ Create an event through providing both Id of organization and application.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __CreateEvent__ ([CreateEvent](#createevent))
+* __CreateEvent__ ([CreateEvent](#CreateEvent))
The required property of the event. (Specified in body).
<h3>Responses</h3>
@@ -829,12 +830,12 @@ The required property of the event. (Specified in body).
__200__
* Description: An array of created event's info.
-* Schema: [Event](#event)
+* Schema: [Event](#Event)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Groups
@@ -850,7 +851,7 @@ Create a new group through providing both Id of organization and application.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __groupproperty__ ([CreateGroup](#creategroup))
+* __groupproperty__ ([CreateGroup](#CreateGroup))
The property of the created group. (Specified in body).
<h3>Responses</h3>
@@ -858,12 +859,12 @@ The property of the created group. (Specified in body).
__200__
* Description: An array of created group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities</h2>
@@ -878,20 +879,20 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __groupId__ (string)
One of the group's identification which includes name or uuid. (Specified in path).
-* __CreateActivity__ ([CreateActivity](#createactivity))
+* __CreateActivity__ ([CreateActivity](#CreateActivity))
One or more sets of activity properties. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of user's activity.
-* Schema: [ActivityFeed](#activityfeed)
+* Description:
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
@@ -914,12 +915,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}</h2>
@@ -942,12 +943,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}</h2>
@@ -968,12 +969,12 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of retrieved group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}</h2>
@@ -994,12 +995,359 @@ One of the group's identification which includes name or uuid. (Specified in
__200__
* Description: An array of updated group's info.
-* Schema: [Group](#group)
+* Schema: [Group](#Group)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+### Notifications
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices</h2>
+
+Create notifications for user through targeting by location and providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notification__ ([CreateNotifications](#CreateNotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
+* __queryStatement__ (string)
+The query statement of the location of the user. (Specified in query).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/*/notifications</h2>
+
+Create notifications for all devices. This request will target all device entities.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notification__ ([CreateNotifications](#CreateNotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/devices/{deviceId}/notifications</h2>
+
+Create notifications for a single device. This request will target a specific device entity.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __deviceId__ (string)
+One of the device's identification which includes name or uuid. (Specified in path).
+* __notification__ ([CreateNotifications](#CreateNotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/groups/{path}/notifications</h2>
+
+Create notifications for a group. This request will target all users associated with a specific group entity.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __path__ (string)
+The path of the group. (Specified in path).
+* __notification__ ([CreateNotifications](#CreateNotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/notifications</h2>
+
+Retrieve one or more notifications through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-PUT-heading">PUT /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+
+Update a Notification in order to cancel the notifcation or set a new expiration time.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+* __notificationUpdate__ ([NotificationUpdate](#NotificationUpdate))
+Object with Notification fields to be updated. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An API Response object containing an entity of type Notification.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{applicationId}/notifications/{notificationId}</h2>
+
+Delete an unsent Notification from the system.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: API Response containing Notification entity that was deleted.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/receipts</h2>
+
+Retrieve one or more receipts through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved receipt's info.
+* Schema: [Receipt](#Receipt)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/users/{userId}/notifications</h2>
+
+Create notifications for a user. This request will target a specific user entity.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __userId-3__ (string)
+One of the user's identification which includes username or UUID. (Specified in path).
+* __notification__ ([CreateNotifications](#CreateNotifications))
+These parameters are used when forming the notification portion of the request. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of created notification's info.
+* Schema: [Notification](#Notification)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{deviceId}/*/receipts</h2>
+
+Retrieve receipts associated with one or more devices through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __deviceId__ (string)
+One of the device's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved receipt's info.
+* Schema: [Receipt](#Receipt)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/queue</h2>
+
+Retrieve the list of devices associated with one or more notifications before the notifications are sent through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved device's info.
+* Schema: [Device](#Device)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{notificationId}/*/receipts</h2>
+
+Retrieve receipts for one or more notifications through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __notificationId__ (string)
+One of the notification's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved receipt's info.
+* Schema: [Receipt](#Receipt)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/{receiptId}/*/notifications</h2>
+
+Retrieve notifications associated with one or more receipts through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __applicationId__ (string)
+One of the application's identification which includes name or uuid (same as appId). (Specified in path).
+* __receiptId__ (string)
+One of the receipt's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of retrieved notification's info.
+* Schema: [Notification](#Notification)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Organizations-Applications
@@ -1011,7 +1359,7 @@ Create an organization through a form post.
<h3>Parameters</h3>
-* __CreateOrg__ ([CreateOrg](#createorg))
+* __CreateOrg__ ([CreateOrg](#CreateOrg))
A set of organization properties supplied through a form. (Specified in body).
<h3>Responses</h3>
@@ -1019,12 +1367,12 @@ A set of organization properties supplied through a form. (Specified in body).
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}</h2>
@@ -1041,12 +1389,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of created Organization.
-* Schema: [Organization](#organization)
+* Schema: [Organization](#Organization)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/activate</h2>
@@ -1067,12 +1415,12 @@ Send confirmation email or not. (Specified in query).
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps</h2>
@@ -1089,12 +1437,36 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of retrieved application data.
-* Schema: [AppData](#appdata)
+* Schema: [AppData](#AppData)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-DELETE-heading">DELETE /management/orgs/{orgId}/apps/{appId}</h2>
+
+Remove an application from an organization through providing both Id of application and organization.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: An array of deleted application info.
+* Schema: [AppData](#AppData)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/apps/{appId}/credentials</h2>
@@ -1113,12 +1485,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved credentials info.
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/apps/{appId}/credentials</h2>
@@ -1137,12 +1509,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of generated credentials info.
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/credentials</h2>
@@ -1159,12 +1531,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /management/orgs/{orgId}/credentials</h2>
@@ -1181,12 +1553,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of Credential
-* Schema: [Credential](#credential)
+* Schema: [Credential](#Credential)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/feed</h2>
@@ -1203,12 +1575,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of the organization's ActivityFeed.
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/orgs/{orgId}/reactivate</h2>
@@ -1225,12 +1597,12 @@ One of the organization's identification which includes name or uuid. (Speci
__200__
* Description: An array of complete messages.
-* Schema: [Action](#action)
+* Schema: [Action](#Action)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /management/users/{userId}/feed</h2>
@@ -1247,12 +1619,12 @@ One of the user's identification which includes username, real name, email a
__200__
* Description: An array of user's activity
-* Schema: [ActivityFeed](#activityfeed)
+* Schema: [ActivityFeed](#ActivityFeed)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
### Permissions-Roles
@@ -1274,12 +1646,12 @@ One of the application's identification which includes name or uuid. (Specif
__200__
* Description: An array of retrieved role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles</h2>
@@ -1292,7 +1664,7 @@ Create a new role through providing all the identifications.
One of the organization's identification which includes name or uuid. (Specified in path).
* __appId__ (string)
One of the application's identification which includes name or uuid. (Specified in path).
-* __roleproperty__ ([AddRole](#addrole))
+* __roleproperty__ ([AddRole](#AddRole))
The required properties of the role. (Specified in body).
<h3>Responses</h3>
@@ -1300,17 +1672,17 @@ The required properties of the role. (Specified in body).
__200__
* Description: An array of created role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/permissions</h2>
-Remove permissions from a role.
+Remove permissions from a role.
<h3>Parameters</h3>
@@ -1320,20 +1692,20 @@ One of the organization's identification which includes name or uuid. (Speci
One of the application's identification which includes name or uuid. (Specified in path).
* __roleId__ (string)
One of the role's identification which includes name or uuid. (Specified in path).
-* __grant_url_pattern__ (string)
-The query statement of the url pattern. (Specified in query).
+* __Permissions__ ([Permissions](#Permissions))
+The query statement of the url pattern. (Specified in body).
<h3>Responses</h3>
__200__
-* Description: An array of deleted permission's info.
-* Schema: [Permission](#permission)
+* Description: Permissions object with array of the deleated Usergrid Permission strings.
+* Schema: [Permissions](#Permissions)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-GET-heading">GET /{orgId}/{appId}/roles/{roleId}/users</h2>
@@ -1353,13 +1725,13 @@ One of the role's identification which includes name or uuid. (Specified in
__200__
-* Description: An array of retrieved user's info.
-* Schema: [User](#user)
+* Description: An API Response with a entities array of Users.
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-POST-heading">POST /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
@@ -1382,12 +1754,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of added user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{roleId}/users/{userId}</h2>
@@ -1410,12 +1782,12 @@ One of the user's identification which includes username or UUID. (Specified
__200__
* Description: An array of deleted user's info.
-* Schema: [User](#user)
+* Schema: [User](#User)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
<h2 class="usergrid-DELETE-heading">DELETE /{orgId}/{appId}/roles/{rolename}</h2>
@@ -1436,22 +1808,76 @@ The name of the role. (Specified in path).
__200__
* Description: An array of deleted role's info.
-* Schema: [Role](#role)
+* Schema: [Role](#Role)
__default__
* Description: Unexpected error.
-* Schema: [Error](#error)
+* Schema: [Error](#Error)
-## Models
-Properties for Usergrid default entities.
+<h2 class="usergrid-GET-heading">GET /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
-### AccessTokenResponse
+Retrieve permissions for a Role.
-__Properties__
+<h3>Parameters</h3>
-<table width="80%" class="usergrid-table">
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: Permissions object with array of Usergrid Permission strings.
+* Schema: [Permissions](#Permissions)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+<h2 class="usergrid-POST-heading">POST /{orgId}/{applicationId}/roles/{roleId}/permissions</h2>
+
+Add permissions to a role through providing all the identifications.
+
+<h3>Parameters</h3>
+
+* __orgId__ (string)
+One of the organization's identification which includes name or uuid. (Specified in path).
+* __appId__ (string)
+One of the application's identification which includes name or uuid. (Specified in path).
+* __roleId__ (string)
+One of the role's identification which includes name or uuid. (Specified in path).
+* __Permissions__ ([Permissions](#Permissions))
+Permissions object with array of Usergrid Permission strings to be added. (Specified in body).
+
+<h3>Responses</h3>
+
+__200__
+
+* Description: Permissions object with array of Usergrid Permission strings.
+* Schema: [Permission](#Permission)
+
+__default__
+
+* Description: Unexpected error.
+* Schema: [Error](#Error)
+
+
+## Models
+This section lists the properties for the Usergrid Default Entities:
+
+### AccessTokenResponse
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
<tr>
<th>Name</th>
<th>Type</th>
@@ -1502,6 +1928,18 @@ __Properties__
<td>false</td>
</tr>
<tr>
+ <td>timestamp</td>
+ <td>number</td>
+ <td>The timestamp of the requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>duration</td>
+ <td>number</td>
+ <td>The duration of the requested action.</td>
+ <td>false</td>
+ </tr>
+ <tr>
<td>token</td>
<td>string</td>
<td>The token required for getting an AdminUser.</td>
@@ -1557,75 +1995,19 @@ __Properties__
<td>false</td>
</tr>
<tr>
- <td>completeMsg</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
-
-### Actor
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>displayname</td>
- <td>string</td>
- <td>The display of the name of the actor.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objecttype</td>
- <td>string</td>
- <td>The type of the actor.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objectuuId</td>
- <td>string</td>
- <td>The UUID of the actor.</td>
+ <td>published</td>
+ <td>number</td>
+ <td>UTC timestamp of the feed publish time.</td>
<td>false</td>
</tr>
<tr>
- <td>entitytype</td>
- <td>string</td>
- <td>The entitytype of the actor.</td>
+ <td>completeMsg</td>
+ <td>ref</td>
+ <td></td>
<td>false</td>
</tr>
</table>
-### AddPermission
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>operation</td>
- <td>string</td>
- <td>A comma-delimited set of HTTP methods (GET, PUT, POST, DELETE) that are allowed for the specified resource path.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>resource_path</td>
- <td>string</td>
- <td>The path to the resources to be accessed.</td>
- <td>true</td>
- </tr>
-</table>
-
### AddRole
__Properties__
@@ -1651,31 +2033,6 @@ __Properties__
</tr>
</table>
-### AdminUserUpdate
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>city</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>state</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
-
### AppData
__Properties__
@@ -1713,62 +2070,6 @@ __Properties__
</tr>
</table>
-### CancelMSG
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>canceled</td>
- <td>boolean</td>
- <td></td>
- <td>true</td>
- </tr>
-</table>
-
-### Collections
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>activities</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>feed</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>roles</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>users</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
-
### CreateActivity
__Properties__
@@ -1855,31 +2156,6 @@ __Properties__
</tr>
</table>
-### CreateApp
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>token</td>
- <td>string</td>
- <td>The OAuth2 access token.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>The name of the application.</td>
- <td>true</td>
- </tr>
-</table>
-
### CreateEntities
__Properties__
@@ -1893,31 +2169,6 @@ __Properties__
</tr>
</table>
-### CreateEntity
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>property</td>
- <td>string</td>
- <td>The property of the entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>value</td>
- <td>string</td>
- <td>The relevant value of the property.</td>
- <td>false</td>
- </tr>
-</table>
-
### CreateEvent
__Properties__
@@ -1962,31 +2213,6 @@ __Properties__
</tr>
</table>
-### CreateNotification
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>notifier</td>
- <td>ref</td>
- <td></td>
- <td>true</td>
- </tr>
- <tr>
- <td>message</td>
- <td>string</td>
- <td>The push notitfication message that will be delivered to the user.</td>
- <td>true</td>
- </tr>
-</table>
-
### CreateNotifications
__Properties__
@@ -2123,10 +2349,22 @@ __Properties__
<td>false</td>
</tr>
<tr>
- <td>metadata</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
+ <td>created</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was created.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>metadata</td>
+ <td>ref</td>
+ <td></td>
+ <td>false</td>
</tr>
<tr>
<td>completeMsg</td>
@@ -2160,9 +2398,15 @@ __Properties__
<td>false</td>
</tr>
<tr>
- <td>actorproperty</td>
+ <td>created</td>
+ <td>number</td>
+ <td>UTC timestamp of entity creation time.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
<td>ref</td>
- <td></td>
+ <td>UTC timestamp of entity modified time.</td>
<td>false</td>
</tr>
<tr>
@@ -2332,37 +2576,6 @@ __Properties__
</tr>
</table>
-### ImageModel
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>url</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>wIdth</td>
- <td>integer</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>email</td>
- <td>string</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
-
### LoginCredentials
__Properties__
@@ -2406,7 +2619,7 @@ __Properties__
</tr>
</table>
-### Metadata
+### Notification
__Properties__
@@ -2418,52 +2631,27 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>cursor</td>
+ <td>uuid</td>
<td>string</td>
- <td>The cursor of the metadata.</td>
+ <td>Unique entity Id.</td>
<td>false</td>
</tr>
<tr>
- <td>path</td>
+ <td>type</td>
<td>string</td>
- <td>The path of the metadata.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>sets</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>collections</td>
- <td>ref</td>
- <td></td>
+ <td>Type of entity.</td>
<td>false</td>
</tr>
-</table>
-
-### Notification
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
<tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>uuid</td>
- <td>string</td>
- <td>Unique entity Id.</td>
+ <td>created</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was created.</td>
<td>false</td>
</tr>
<tr>
- <td>type</td>
- <td>string</td>
- <td>Type of entity.</td>
+ <td>modified</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified.</td>
<td>false</td>
</tr>
<tr>
@@ -2481,7 +2669,7 @@ __Properties__
<tr>
<td>scheduled</td>
<td>boolean</td>
- <td>whether the notification is currently scheduled for delivery.</td>
+ <td>Whether the notification is currently scheduled for delivery.</td>
<td>false</td>
</tr>
<tr>
@@ -2504,7 +2692,7 @@ __Properties__
</tr>
</table>
-### Notifier
+### NotificationUpdate
__Properties__
@@ -2516,76 +2704,21 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>uuid</td>
- <td>string</td>
- <td>Unique entity Id.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>type</td>
- <td>string</td>
- <td>Type of entity.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>name</td>
- <td>string</td>
- <td>Notifier display name.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>provider</td>
- <td>string</td>
- <td>Push notification provider 'apple' or 'google'.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>environment</td>
- <td>string</td>
- <td>The environment that corresponds to your app 'development' or 'production'.</td>
- <td>true</td>
- </tr>
- <tr>
- <td>metadata</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
-</table>
-
-### Object
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
- </tr>
- <tr>
- <td>displayname</td>
- <td>string</td>
- <td>The display of the name of the object.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>objecttype</td>
- <td>string</td>
- <td>The type of the object.</td>
+ <td>canceled</td>
+ <td>boolean</td>
+ <td>Setting this field to true will cancel a Notification, if it has not yet been sent.</td>
<td>false</td>
</tr>
<tr>
- <td>objectuuId</td>
- <td>string</td>
- <td>The UUID of the object.</td>
+ <td>deliver</td>
+ <td>number</td>
+ <td>Specifies the UNIX timestamp time at which the Notification should be sent.</td>
<td>false</td>
</tr>
<tr>
- <td>entitytype</td>
- <td>string</td>
- <td>The entitytype of the object.</td>
+ <td>expired</td>
+ <td>number</td>
+ <td>Specifies the UNIX timestamp time at which this Notification has expired.</td>
<td>false</td>
</tr>
</table>
@@ -2687,7 +2820,7 @@ __Properties__
</tr>
</table>
-### Permission
+### Permissions
__Properties__
@@ -2699,46 +2832,28 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>applicationName</td>
- <td>string</td>
- <td>The name of the application of the permission.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>entity</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
- </tr>
- <tr>
- <td>url</td>
+ <td>application</td>
<td>string</td>
- <td>The url of the permission.</td>
+ <td>The UUID of the associated application.</td>
<td>false</td>
</tr>
<tr>
- <td>applicationId</td>
- <td>string</td>
- <td>The UUID of the application.</td>
- <td>false</td>
- </tr>
- <tr>
- <td>parameters</td>
+ <td>applicationName</td>
<td>string</td>
- <td>The parameters of the permission.</td>
+ <td>The name of the associated application.</td>
<td>false</td>
</tr>
<tr>
<td>organization</td>
<td>string</td>
- <td>The organization of the permission.</td>
+ <td>The name of the associated organization.</td>
<td>false</td>
</tr>
<tr>
- <td>permissiondata</td>
- <td>ref</td>
- <td></td>
- <td>false</td>
+ <td>data</td>
+ <td>array</td>
+ <td>Array of strings each being a Usergrid Permission String.</td>
+ <td>true</td>
</tr>
</table>
@@ -2766,6 +2881,18 @@ __Properties__
<td>false</td>
</tr>
<tr>
+ <td>created</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was created.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>modified</td>
+ <td>number</td>
+ <td>UTC timestamp in milliseconds of when the entity was last modified.</td>
+ <td>false</td>
+ </tr>
+ <tr>
<td>payloads</td>
<td>string</td>
<td>The push notifications to be delivered.</td>
@@ -2877,6 +3004,12 @@ __Properties__
<td>false</td>
</tr>
<tr>
+ <td>count</td>
+ <td>number</td>
+ <td>The numebr of the roles.</td>
+ <td>false</td>
+ </tr>
+ <tr>
<td>entity</td>
<td>ref</td>
<td></td>
@@ -2920,7 +3053,7 @@ __Properties__
</tr>
</table>
-### ScheduleNotification
+### User
__Properties__
@@ -2932,33 +3065,101 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>timestamp</td>
+ <td>applicationId</td>
<td>string</td>
- <td>UTC timestamp in milliseconds of when schedule notifications.</td>
- <td>true</td>
+ <td>The application Id of a user.</td>
+ <td>false</td>
</tr>
-</table>
-
-### SetExpiration
-
-__Properties__
-
-<table width="80%" class="usergrid-table">
<tr>
- <th>Name</th>
- <th>Type</th>
- <th>Description</th>
- <th>Required</th>
+ <td>username</td>
+ <td>string</td>
+ <td>The username of a user.</td>
+ <td>false</td>
</tr>
<tr>
- <td>timestamp</td>
+ <td>name</td>
<td>string</td>
- <td>UTC timestamp in milliseconds of when set expirations.</td>
- <td>true</td>
+ <td>The name of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>email</td>
+ <td>string</td>
+ <td>The email of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>activated</td>
+ <td>boolean</td>
+ <td>Indicate whether the account is activated or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>Indicate whether the account is disabled or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>uuid</td>
+ <td>string</td>
+ <td>The UUID of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>adminUser</td>
+ <td>boolean</td>
+ <td>Indicate whether the use is a adminUser or not.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>displayEmail</td>
+ <td>string</td>
+ <td>The display of the email of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>htmldisplayEmail</td>
+ <td>string</td>
+ <td>The HTML display of the email of a user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>organization</td>
+ <td>string</td>
+ <td>The organization of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>picture</td>
+ <td>string</td>
+ <td>The uri of the user's picture.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>uri</td>
+ <td>string</td>
+ <td>The uri of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>string</td>
+ <td>The path of the user.</td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>completeMsg</td>
+ <td>ref</td>
+ <td></td>
+ <td>false</td>
</tr>
</table>
-### Sets
+## Sub-Types
+This section lists the properties for sub-types used in Usergrid Default Entities.
+
+### Collections
__Properties__
@@ -2970,20 +3171,32 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>rolenames</td>
+ <td>activities</td>
<td>string</td>
<td></td>
<td>false</td>
</tr>
<tr>
- <td>permissions</td>
+ <td>feed</td>
+ <td>string</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>roles</td>
+ <td>string</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>users</td>
<td>string</td>
<td></td>
<td>false</td>
</tr>
</table>
-### User
+### ImageModel
__Properties__
@@ -2995,92 +3208,131 @@ __Properties__
<th>Required</th>
</tr>
<tr>
- <td>applicationId</td>
- <td>string</td>
- <td>The application Id of a user.</td>
+ <td>duration</td>
+ <td>number</td>
+ <td></td>
<td>false</td>
</tr>
<tr>
- <td>username</td>
- <td>string</td>
- <td>The username of a user.</td>
+ <td>height</td>
+ <td>number</td>
+ <td></td>
<td>false</td>
</tr>
<tr>
- <td>name</td>
+ <td>url</td>
<td>string</td>
- <td>The name of a user.</td>
+ <td></td>
+ <td>false</td>
+ </tr>
+ <tr>
+ <td>wIdth</td>
+ <td>integer</td>
+ <td></td>
<td>false</td>
</tr>
<tr>
<td>email</td>
<td>string</td>
- <td>The email of a user.</td>
+ <td></td>
<td>false</td>
</tr>
+</table>
+
+### Metadata
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
<tr>
- <td>activated</td>
- <td>boolean</td>
- <td>Indicate whether the account is activated or not.</td>
- <td>false</td>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td>disabled</td>
- <td>boolean</td>
- <td>Indicate whether the account is disabled or not.</td>
+ <td>cursor</td>
+ <td>string</td>
+ <td>The cursor of the metadata.</td>
<td>false</td>
</tr>
<tr>
- <td>uuid</td>
+ <td>path</td>
<td>string</td>
- <td>The UUID of a user.</td>
+ <td>The path of the metadata.</td>
<td>false</td>
</tr>
<tr>
- <td>adminUser</td>
- <td>boolean</td>
- <td>Indicate whether the use is a adminUser or not.</td>
+ <td>sets</td>
+ <td>ref</td>
+ <td></td>
<td>false</td>
</tr>
<tr>
- <td>displayEmail</td>
- <td>string</td>
- <td>The display of the email of a user.</td>
+ <td>collections</td>
+ <td>ref</td>
+ <td></td>
<td>false</td>
</tr>
+</table>
+
+### Object
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
<tr>
- <td>htmldisplayEmail</td>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>displayname</td>
<td>string</td>
- <td>The HTML display of the email of a user.</td>
+ <td>The display of the name of the object.</td>
<td>false</td>
</tr>
<tr>
- <td>organization</td>
+ <td>objecttype</td>
<td>string</td>
- <td>The organization of the user.</td>
+ <td>The type of the object.</td>
<td>false</td>
</tr>
<tr>
- <td>picture</td>
+ <td>objectuuId</td>
<td>string</td>
- <td>The uri of the user's picture.</td>
+ <td>The UUID of the object.</td>
<td>false</td>
</tr>
<tr>
- <td>uri</td>
+ <td>entitytype</td>
<td>string</td>
- <td>The uri of the user.</td>
+ <td>The entitytype of the object.</td>
<td>false</td>
</tr>
+</table>
+
+### Sets
+
+__Properties__
+
+<table width="80%" class="usergrid-table">
<tr>
- <td>path</td>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>rolenames</td>
<td>string</td>
- <td>The path of the user.</td>
+ <td></td>
<td>false</td>
</tr>
<tr>
- <td>completeMsg</td>
- <td>ref</td>
+ <td>permissions</td>
+ <td>string</td>
<td></td>
<td>false</td>
</tr>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
----------------------------------------------------------------------
diff --git a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
index efc99e9..6946f99 100644
--- a/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
+++ b/docs/src/main/groovy/usergrid/ApiDocGenerator.groovy
@@ -5,22 +5,31 @@
// Depdency management with Grape:
// http://docs.groovy-lang.org/latest/html/documentation/grape.html
-package usergrid;
+package usergrid
@Grab(group = 'io.swagger', module = 'swagger-parser', version = '1.0.8')
@Grab(group = 'io.swagger', module = 'swagger-compat-spec-parser', version = '1.0.8')
@Grab(group = 'com.github.spullara.mustache.java', module = 'compiler', version = '0.8.18-SNAPSHOT')
+@Grab(group = 'org.slf4j', module = 'slf4j-simple', version = '1.7.12')
-import io.swagger.parser.*;
-import io.swagger.models.*;
-import com.github.mustachejava.*
-import org.apache.commons.lang3.RandomStringUtils;
+import com.github.mustachejava.DefaultMustacheFactory
+import io.swagger.models.Model
+import io.swagger.models.Operation
+import io.swagger.models.parameters.BodyParameter
+import io.swagger.models.parameters.RefParameter
+import io.swagger.models.properties.RefProperty
+import io.swagger.parser.*
+import org.apache.commons.lang3.RandomStringUtils
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
/**
* Generates Usergrid API docs from Swagger in Markdown format.
*/
public class ApiDocGenerator {
+
+ static Logger logger = LoggerFactory.getLogger(ApiDocGenerator.class);
def parser = new SwaggerParser();
def swagger = parser.read("src/main/resources/usergrid-swagger.yaml");
@@ -39,8 +48,14 @@ public class ApiDocGenerator {
def allTags = [];
def allModels = [];
-
-
+ def urlOpsBySchema = [:];
+ def modelsBySchema = [:];
+
+ def tagsToUrlOps = new TreeMap();
+
+ def definitions = new TreeMap();
+ def subTypes = new TreeMap();
+
public ApiDocGenerator() {
writer = new OutputStreamWriter(new FileOutputStream("rest-endpoints/api-docs.md"));
operationTemplate = mf.compile(
@@ -61,59 +76,66 @@ public class ApiDocGenerator {
}
def generate() {
-
- // build up scope and generate via Mustache template
-
- // organize methods by tag
- def tagsToUrlOps = new TreeMap();
+
+ // build various hashmaps and lists to help organize and cross-reference content
swagger.getPaths().each { pathEntry ->
def url = pathEntry.key;
def path = pathEntry.value;
if (path.get != null) {
- addOperation(tagsToUrlOps, "GET", url, path.get);
+ addOperation("GET", url, path.get);
}
if (path.post != null) {
- addOperation(tagsToUrlOps, "POST", url, path.post);
+ addOperation("POST", url, path.post);
}
if (path.put != null) {
- addOperation(tagsToUrlOps, "PUT", url, path.put);
+ addOperation("PUT", url, path.put);
}
if (path.delete != null) {
- addOperation(tagsToUrlOps, "DELETE", url, path.delete);
+ addOperation("DELETE", url, path.delete);
}
};
-
tagsToUrlOps.each { entry -> allTags.add(entry.key) };
- def definitions = new TreeMap();
swagger.getDefinitions().each { entry ->
- definitions.put( entry.key, entry.value );
+ addModel( entry.key, entry.value );
};
definitions.each { entry -> allModels.add(entry.key); };
-
- // generate
+
+ // generate the doc
generateFileStart();
+
generateMethodsSectionTitle();
+
tagsToUrlOps.each { entry ->
def tag = entry.key;
def urlOps = entry.value;
generateMethodsTitle(tag);
urlOps.each { urlOp -> formatOperation( urlOp ); };
};
-
+
generateModelsTitle();
+
definitions.each { entry ->
def name = entry.key;
def model = entry.value;
formatModel( name, model );
};
+
+ generateSubTypesTitle();
+
+ subTypes.each { entry ->
+ def name = entry.key;
+ def model = entry.value;
+ formatModel( name, model );
+ };
+
generateFileEnd();
}
- def addOperation( Map tagsToUrlOps, String method, String url, Operation operation ) {
+ def addOperation( String method, String url, Operation operation ) {
// assume each operation has one tag
def tag = operation.tags[0];
@@ -123,12 +145,64 @@ public class ApiDocGenerator {
urlOps = [];
tagsToUrlOps[tag] = urlOps;
}
-
+
def urlOp = new HashMap();
urlOp.url = url;
urlOp.method = method;
urlOp.operation = operation;
+ urlOp.opId = RandomStringUtils.randomAlphanumeric(10);
urlOps.add(urlOp);
+
+ operation.getResponses().each { responseEntry ->
+
+ if (responseEntry.value.schema != null) {
+
+ if (responseEntry.key.equals("200")) {
+ def list = urlOpsBySchema[responseEntry.value.schema.ref];
+ if (list == null) {
+ list = new HashSet();
+ urlOpsBySchema[responseEntry.value.schema.ref] = list;
+ }
+ list.add(urlOp);
+ }
+ }
+ };
+
+ operation.getParameters().each { param ->
+
+ if ( param instanceof BodyParameter && param.schema != null ) {
+ def list = urlOpsBySchema[param.schema.ref];
+ if (list == null) {
+ list = new HashSet();
+ urlOpsBySchema[param.schema.ref] = list;
+ }
+ list.add(urlOp);
+ }
+ };
+
+ }
+
+ def addModel(name, model) {
+
+ if (urlOpsBySchema[name] != null || name.equals("Error")) {
+ definitions.put(name, model);
+ } else if (modelsBySchema[name] != null ) {
+ subTypes.put(name, model);
+ } else {
+ logger.error("${name} omitted because it is not referenced by any API path or definition.");
+ }
+
+ model.properties.each { propertyEntity ->
+
+ if (propertyEntity.value instanceof RefProperty ) {
+ def list = modelsBySchema[ propertyEntity.value.ref ];
+ if ( list == null ) {
+ list = [];
+ modelsBySchema[ propertyEntity.value.ref ] = list;
+ }
+ list.add(name);
+ }
+ };
}
def formatOperation( urlOp ) {
@@ -150,7 +224,17 @@ public class ApiDocGenerator {
// if parameter has a schema, assume that it is a reference
if ( responseEntry.value.schema != null) {
response.schema = responseEntry.value.schema.ref;
- response.schemaAnchor = responseEntry.value.schema.ref.toLowerCase();
+ response.schemaAnchor = responseEntry.value.schema.ref;
+
+ // keep track of paths that use each schema definition
+ if ( response.status.equals("200") ) {
+ def list = urlOpsBySchema[response.schema];
+ if ( list == null ) {
+ list = [];
+ urlOpsBySchema[response.schema] = list;
+ }
+ list.add(urlOp);
+ }
}
responses.add(response);
}
@@ -164,10 +248,25 @@ public class ApiDocGenerator {
param.in = parameter.in;
// assume that body parameters have a schema that is a reference
- if (parameter.in == "body" && parameter.schema != null) {
+ if (parameter.in == "body") {
+
+ if ( parameter.schema == null ) {
+ def a = 5;
+ }
param.schemaRef = parameter.schema.ref;
- param.schemaAnchor = parameter.schema.ref.toLowerCase();
- } else { // if (parameter.in == "path") {
+ param.schemaAnchor = parameter.schema.ref;
+
+ // keep track of paths that use each schema definition
+ def list = urlOpsBySchema[parameter.schema.ref];
+ if ( list == null ) {
+ list = [];
+ urlOpsBySchema[parameter.schema.ref] = list;
+ }
+ list.add(urlOp);
+
+ } else if ( parameter instanceof RefParameter ) {
+ param.type = "booger";
+ } else {
param.type = parameter.type;
}
params.add(param);
@@ -181,14 +280,21 @@ public class ApiDocGenerator {
scope.tags = op.getTags();
scope.responses = responses;
scope.parameters = params;
- scope.opid = RandomStringUtils.randomAlphanumeric(10);
-
+ scope.opId = urlOp.opId;
+
operationTemplate.execute(writer, scope);
writer.flush();
}
def formatModel(String name, Model model) {
+ def scope = [:];
+ scope.referrers = urlOpsBySchema[name];
+ scope.modelRefs = modelsBySchema[name];
+ scope.hasReferrers = scope.referrers != null && !scope.referrers.isEmpty();
+ scope.hasParamRefs = scope.paramRefs != null && !scope.paramRefs.isEmpty();
+ scope.hasModelRefs = scope.modelRefs != null && !scope.modelRefs.isEmpty();
+
// put properties in array form, mustache doesn't play nice with associative arrays
def props = [];
model.getProperties().each { property ->
@@ -201,12 +307,15 @@ public class ApiDocGenerator {
prop.readOnly = property.value.readOnly;
prop.required = property.value.required;
prop.position = property.value.position;
+ if ( property.value instanceof RefProperty ) {
+ prop.ref = property.value.ref;
+ }
props.add(prop);
};
- def scope = [:];
scope.name = name;
+ scope.description = model.description;
scope.properties = props;
- scope.modelid = RandomStringUtils.randomAlphanumeric(10);
+
modelTemplate.execute(writer, scope);
writer.flush();
}
@@ -217,7 +326,7 @@ public class ApiDocGenerator {
allTags.each{ tag ->
def atag = [:];
atag.name = tag;
- atag.link = tag.toLowerCase();
+ atag.link = tag;
tags.add(atag);
};
scope.tags = tags;
@@ -239,7 +348,12 @@ public class ApiDocGenerator {
def generateModelsTitle() {
writer.println "\n## Models";
- writer.println "Properties for Usergrid default entities.";
+ writer.println "This section lists the properties for the Usergrid Default Entities:";
+ }
+
+ def generateSubTypesTitle() {
+ writer.println "\n## Sub-Types";
+ writer.println "This section lists the properties for sub-types used in Usergrid Default Entities.";
}
def generateFileEnd() {
@@ -289,9 +403,15 @@ class HtmlApiDocGenerator extends ApiDocGenerator {
def generateModelsTitle() {
writer.println "<a name='models'></a>";
writer.println "<br><h1>Default Entity Models</h1>" +
- "<p>This section lists the properties for the following Usergrid Default Entities:</p>";
+ "<p>This section lists the properties for the following Usergrid Default Entities.</p>";
}
+ def generateSubTypesTitle() {
+ writer.println "<a name='subtypes'></a>";
+ writer.println "<br><h1>Sub-types Referenced By Models</h1>" +
+ "<p>This section lists the properties for sub-types used in Usergrid Default Entities.</p>";
+ }
+
def generateFileEnd() {
def scope = [:];
fileEndTemplate.execute(writer, scope);
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/resources/html/file-end.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/file-end.mustache b/docs/src/main/resources/html/file-end.mustache
index 28d75b5..77b0b67 100644
--- a/docs/src/main/resources/html/file-end.mustache
+++ b/docs/src/main/resources/html/file-end.mustache
@@ -8,6 +8,23 @@
<!-- Latest compiled and minified JavaScript -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
+
+<script>
+if ("onhashchange" in window) {
+ window.onhashchange = function () {
+ var hash = window.location.hash;
+ if ( hash.substring(0,1) != "/") {
+ hash = hash.substring(1, hash.length);
+
+ $("#collapse-" + hash).removeClass("collapse");
+ $("a[href=#collapse-" + hash + "]").removeClass("collapsed");
+
+ $("#" + hash).removeClass("collapse");
+ $("a[href=#" + hash + "]").removeClass("collapsed");
+ }
+ }
+}
+</script>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/resources/html/file-start.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/file-start.mustache b/docs/src/main/resources/html/file-start.mustache
index 642bf42..9951f3c 100644
--- a/docs/src/main/resources/html/file-start.mustache
+++ b/docs/src/main/resources/html/file-start.mustache
@@ -10,6 +10,39 @@
<link rel="stylesheet" href="api-docs.css">
+ <style type="text/css">
+ .panel-default > .panel-heading.GET{
+ background-color: rgba(54, 180, 255, 0.42);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.POST {
+ background-color: rgba(0, 128, 0, 0.38);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.PUT{
+ background-color: rgba(255, 165, 0, 0.41);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.DELETE {
+ background-color: rgba(255, 0, 0, 0.29);
+ background-image: none;
+ }
+
+ .panel-heading a.collapse-button:after {
+ font-family:'Glyphicons Halflings';
+ content:"\e114";
+ float: right;
+ color: grey;
+ }
+ .panel-heading a.collapse-button.collapsed:after {
+ content:"\e080";
+ }
+
+ table td {
+ font-size: small;
+ }
+ </style>
+
</head>
<body>
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/resources/html/model.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/model.mustache b/docs/src/main/resources/html/model.mustache
index 8672641..fa21399 100644
--- a/docs/src/main/resources/html/model.mustache
+++ b/docs/src/main/resources/html/model.mustache
@@ -1,4 +1,5 @@
+
<div>
<a name="{{name}}"/>
</div>
@@ -7,14 +8,16 @@
<div class="panel-heading">
<h2 class="panel-title model-heading">{{name}}
- <a data-toggle="collapse" data-target="#collapse-{{modelid}}"
- href="#collapse-{{modelid}}" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#collapse-{{name}}"
+ href="#collapse-{{name}}" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-{{modelid}}" class="panel-body collapse">
+ <div id="collapse-{{name}}" class="panel-body collapse">
+
+ <p>{{description}}</p>
- <h3>Properties</h3>
+ <p><b>Properties</b></p>
<table width="80%" class="table table-striped">
<tr>
@@ -26,13 +29,39 @@
{{#properties}}
<tr>
<td>{{name}}</td>
- <td>{{type}}</td>
+ <td>
+ {{#ref}}<a href="#{{ref}}">{{ref}}</a>{{/ref}}
+ {{^ref}}{{type}}{{/ref}}
+ </td>
<td>{{description}}</td>
<td>{{required}}</td>
</tr>
{{/properties}}
</table>
+ {{#hasReferrers}}
+ <p><b>Referring API Paths</b></p>
+ <table width="80%" class="table table-striped">
+ {{#referrers}}
+ <tr>
+ <td><p><a href="#op-{{opId}}">{{url}}</a></p></td>
+ </tr>
+ {{/referrers}}
+ </table>
+ {{/hasReferrers}}
+
+ {{#hasModelRefs}}
+ <p><b>Referring Definitions</b></p>
+ <table width="80%" class="table table-striped">
+ {{#modelRefs}}
+ <tr>
+ <td><p><a href="#{{.}}">{{.}}</a></p></td>
+ </tr>
+ {{/modelRefs}}
+ </table>
+ {{/hasModelRefs}}
+
</div>
</div>
+
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/src/main/resources/html/operation.mustache
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/html/operation.mustache b/docs/src/main/resources/html/operation.mustache
index 6e15b1f..27b7ab5 100644
--- a/docs/src/main/resources/html/operation.mustache
+++ b/docs/src/main/resources/html/operation.mustache
@@ -1,14 +1,16 @@
+<a name="op-{{opId}}"/>
+
<div class="panel panel-default">
<div class="panel-heading {{method}}">
<h2 class="panel-title {{method}}-heading">{{method}} {{url}}
- <a data-toggle="collapse" data-target="#collapse-{{opid}}"
- href="#collapse-{{opid}}" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-{{opId}}"
+ href="#op-{{opId}}" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-{{opid}}" class="panel-body collapse">
+ <div id="op-{{opId}}" class="panel-body collapse">
<p>{{description}}</p>
@@ -17,8 +19,7 @@
<ul>
{{#parameters}}
<li>
- <b>{{name}}</b> ({{#type}}{{type}}{{/type}}{{#schemaRef}}
- <a href="#{{schemaAnchor}}">{{schemaRef}}</a>{{/schemaRef}}) <br>
+ <b>{{name}}</b> ({{#type}}{{type}}{{/type}}{{#schemaRef}}<a href="#{{schemaAnchor}}">{{schemaRef}}</a>{{/schemaRef}})<br>
{{description}} (Specified in {{in}}).
</li>
{{/parameters}}
[5/5] incubator-usergrid git commit: Merge branch 'two-dot-o-dev' of
https://git-wip-us.apache.org/repos/asf/incubator-usergrid into two-dot-o-dev
Posted by sn...@apache.org.
Merge branch 'two-dot-o-dev' of https://git-wip-us.apache.org/repos/asf/incubator-usergrid into two-dot-o-dev
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/72016ea8
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/72016ea8
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/72016ea8
Branch: refs/heads/two-dot-o-dev
Commit: 72016ea89c05f920059fd15861a5b40d945ecfbc
Parents: 2707dbf daac07d
Author: Dave Johnson <sn...@apache.org>
Authored: Mon Aug 17 11:12:50 2015 -0700
Committer: Dave Johnson <sn...@apache.org>
Committed: Mon Aug 17 11:12:50 2015 -0700
----------------------------------------------------------------------
.../asyncevents/AmazonAsyncEventService.java | 7 +-
.../asyncevents/AsyncEventService.java | 7 +
.../asyncevents/InMemoryAsyncEventService.java | 12 +-
.../persistence/queue/DefaultQueueManager.java | 5 +
.../persistence/queue/QueueManager.java | 6 +
.../queue/impl/SNSQueueManagerImpl.java | 14 ++
.../queue/impl/SQSQueueManagerImpl.java | 31 ++--
.../persistence/queue/QueueManagerTest.java | 24 +++
.../org/apache/usergrid/rest/RootResource.java | 19 ++-
stack/scripts/migrate_entity_data.py | 155 ++++++++++++++-----
.../services/queues/ImportQueueManager.java | 5 +
11 files changed, 219 insertions(+), 66 deletions(-)
----------------------------------------------------------------------
[4/5] incubator-usergrid git commit: Fixes and improvements to
Usergrid Swagger file and HTML generation. Specifically: - Add
cross-references for 1) which API paths reference each definition and 2)
which models reference each model. - Add descriptions f
Posted by sn...@apache.org.
Fixes and improvements to Usergrid Swagger file and HTML generation.
Specifically:
- Add cross-references for 1) which API paths reference each definition and 2) which models reference each model.
- Add descriptions for some definitions and parameters.
- Move CSS from separate file into HTML (so it is one self-contained file -- all other JS and CSS references are to CDN hosted files).
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/2707dbf4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/2707dbf4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/2707dbf4
Branch: refs/heads/two-dot-o-dev
Commit: 2707dbf4ac9212172bf1adf149ba6dcf42a7d45a
Parents: 4f9650b
Author: Dave Johnson <sn...@apache.org>
Authored: Sat Aug 15 22:09:08 2015 -0400
Committer: Dave Johnson <sn...@apache.org>
Committed: Sat Aug 15 22:09:08 2015 -0400
----------------------------------------------------------------------
docs/rest-endpoints/api-docs.css | 29 -
docs/rest-endpoints/api-docs.html | 5093 ++++++++++++------
docs/rest-endpoints/api-docs.md | 1442 +++--
.../main/groovy/usergrid/ApiDocGenerator.groovy | 190 +-
docs/src/main/resources/html/file-end.mustache | 17 +
.../src/main/resources/html/file-start.mustache | 33 +
docs/src/main/resources/html/model.mustache | 39 +-
docs/src/main/resources/html/operation.mustache | 11 +-
docs/src/main/resources/usergrid-swagger.yaml | 1543 +++---
9 files changed, 5302 insertions(+), 3095 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/rest-endpoints/api-docs.css
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.css b/docs/rest-endpoints/api-docs.css
deleted file mode 100644
index e9a2087..0000000
--- a/docs/rest-endpoints/api-docs.css
+++ /dev/null
@@ -1,29 +0,0 @@
-
-
-.panel-default > .panel-heading.GET{
- background-color: rgba(54, 180, 255, 0.42);
- background-image: none;
-}
-.panel-default > .panel-heading.POST {
- background-color: rgba(0, 128, 0, 0.38);
- background-image: none;
-}
-.panel-default > .panel-heading.PUT{
- background-color: rgba(255, 165, 0, 0.41);
- background-image: none;
-}
-.panel-default > .panel-heading.DELETE {
- background-color: rgba(255, 0, 0, 0.29);
- background-image: none;
-}
-
-.panel-heading a.collapse-button:after {
- font-family:'Glyphicons Halflings';
- content:"\e114";
- float: right;
- color: grey;
-}
-.panel-heading a.collapse-button.collapsed:after {
- content:"\e080";
-}
-
[3/5] incubator-usergrid git commit: Fixes and improvements to
Usergrid Swagger file and HTML generation. Specifically: - Add
cross-references for 1) which API paths reference each definition and 2)
which models reference each model. - Add descriptions f
Posted by sn...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2707dbf4/docs/rest-endpoints/api-docs.html
----------------------------------------------------------------------
diff --git a/docs/rest-endpoints/api-docs.html b/docs/rest-endpoints/api-docs.html
index c8503d2..4d90c8c 100644
--- a/docs/rest-endpoints/api-docs.html
+++ b/docs/rest-endpoints/api-docs.html
@@ -10,6 +10,39 @@
<link rel="stylesheet" href="api-docs.css">
+ <style type="text/css">
+ .panel-default > .panel-heading.GET{
+ background-color: rgba(54, 180, 255, 0.42);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.POST {
+ background-color: rgba(0, 128, 0, 0.38);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.PUT{
+ background-color: rgba(255, 165, 0, 0.41);
+ background-image: none;
+ }
+ .panel-default > .panel-heading.DELETE {
+ background-color: rgba(255, 0, 0, 0.29);
+ background-image: none;
+ }
+
+ .panel-heading a.collapse-button:after {
+ font-family:'Glyphicons Halflings';
+ content:"\e114";
+ float: right;
+ color: grey;
+ }
+ .panel-heading a.collapse-button.collapsed:after {
+ content:"\e080";
+ }
+
+ table td {
+ font-size: small;
+ }
+ </style>
+
</head>
<body>
@@ -24,16 +57,18 @@
<a name='Access-Tokens-method'></a>
<h2>Access-Tokens</h2>
+<a name="op-mAlKR6jEhl"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/token
- <a data-toggle="collapse" data-target="#collapse-GBKFpoDUV6"
- href="#collapse-GBKFpoDUV6" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-mAlKR6jEhl"
+ href="#op-mAlKR6jEhl" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-GBKFpoDUV6" class="panel-body collapse">
+ <div id="op-mAlKR6jEhl" class="panel-body collapse">
<p>Login with Admin-User or Organization credentials.</p>
@@ -41,7 +76,7 @@
<ul>
<li>
- <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ <b>login-credentials</b> (<a href="#LoginCredentials">LoginCredentials</a>)<br>
Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -53,14 +88,14 @@
<b>200</b>
<ul>
<li>Description: Object containing access_token.</li>
- <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
+ <li>Schema: [<a href="#AccessTokenResponse">AccessTokenResponse</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -69,16 +104,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-uIJFfKvsl6"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/token
- <a data-toggle="collapse" data-target="#collapse-jf7rRaHshu"
- href="#collapse-jf7rRaHshu" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-uIJFfKvsl6"
+ href="#op-uIJFfKvsl6" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-jf7rRaHshu" class="panel-body collapse">
+ <div id="op-uIJFfKvsl6" class="panel-body collapse">
<p>Login with App-User or Application credentials.</p>
@@ -86,7 +123,7 @@
<ul>
<li>
- <b>login-credentials</b> ( <a href="#logincredentials">LoginCredentials</a>) <br>
+ <b>login-credentials</b> (<a href="#LoginCredentials">LoginCredentials</a>)<br>
Login credentials either username/password or id/secret. (Specified in body).
</li>
</ul>
@@ -97,15 +134,15 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of new created Admin user's info.</li>
- <li>Schema: [<a href="#accesstokenreponse">AccessTokenReponse</a>]</li>
+ <li>Description: Object containing access_token.</li>
+ <li>Schema: [<a href="#AccessTokenResponse">AccessTokenResponse</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -116,16 +153,18 @@
<a name='Activities-method'></a>
<h2>Activities</h2>
+<a name="op-pKr2VP64e5"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/groups/{groupId}/feed
- <a data-toggle="collapse" data-target="#collapse-2kebCfBv6r"
- href="#collapse-2kebCfBv6r" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-pKr2VP64e5"
+ href="#op-pKr2VP64e5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2kebCfBv6r" class="panel-body collapse">
+ <div id="op-pKr2VP64e5" class="panel-body collapse">
<p>Get a group's feed through providing all the identifications.</p>
@@ -133,15 +172,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
+ <b>groupId</b> (string)<br>
One of the group's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -153,14 +192,14 @@
<b>200</b>
<ul>
<li>Description: An array of group's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Schema: [<a href="#ActivityFeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -169,16 +208,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-qOQrBk7lNB"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{userId}/activities
- <a data-toggle="collapse" data-target="#collapse-eu3aLpfo9e"
- href="#collapse-eu3aLpfo9e" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-qOQrBk7lNB"
+ href="#op-qOQrBk7lNB" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-eu3aLpfo9e" class="panel-body collapse">
+ <div id="op-qOQrBk7lNB" class="panel-body collapse">
<p>Create an activity in the activities collection.</p>
@@ -186,19 +227,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
<li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
+ <b>CreateActivity</b> (<a href="#CreateActivity">CreateActivity</a>)<br>
One or more sets of activity properties. (Specified in body).
</li>
</ul>
@@ -210,14 +251,14 @@
<b>200</b>
<ul>
<li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Schema: [<a href="#ActivityFeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -226,16 +267,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-FXc5bn3d3I"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/feed
- <a data-toggle="collapse" data-target="#collapse-av92cfV1L6"
- href="#collapse-av92cfV1L6" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-FXc5bn3d3I"
+ href="#op-FXc5bn3d3I" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-av92cfV1L6" class="panel-body collapse">
+ <div id="op-FXc5bn3d3I" class="panel-body collapse">
<p>Retrieve a user's feed through providing all the identifications.</p>
@@ -243,15 +286,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -263,14 +306,14 @@
<b>200</b>
<ul>
<li>Description: An array of user's activity feed.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Schema: [<a href="#ActivityFeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -281,16 +324,18 @@
<a name='Admin-Users-method'></a>
<h2>Admin-Users</h2>
+<a name="op-cwbY0V5Wx9"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/orgs/{orgId}/users
- <a data-toggle="collapse" data-target="#collapse-INFXttZor5"
- href="#collapse-INFXttZor5" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-cwbY0V5Wx9"
+ href="#op-cwbY0V5Wx9" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-INFXttZor5" class="panel-body collapse">
+ <div id="op-cwbY0V5Wx9" class="panel-body collapse">
<p>Retrieve details about the admin users in an organization.</p>
@@ -298,7 +343,7 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -310,14 +355,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved Admin user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -326,16 +371,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-c6KZfPifUw"/>
+
<div class="panel panel-default">
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /management/orgs/{orgId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-Gx6IFaXlzW"
- href="#collapse-Gx6IFaXlzW" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-c6KZfPifUw"
+ href="#op-c6KZfPifUw" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Gx6IFaXlzW" class="panel-body collapse">
+ <div id="op-c6KZfPifUw" class="panel-body collapse">
<p>Remove an admin user from an organization through providing both Id of application and organization.</p>
@@ -343,11 +390,11 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-2</b> (string) <br>
+ <b>userId-2</b> (string)<br>
One of the user's identification which includes username, email address or UUID. (Specified in path).
</li>
</ul>
@@ -359,14 +406,14 @@
<b>200</b>
<ul>
<li>Description: An array of deleted Admin user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -375,16 +422,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-QoxREYsNIz"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/users
- <a data-toggle="collapse" data-target="#collapse-Nl6a4Lig7S"
- href="#collapse-Nl6a4Lig7S" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-QoxREYsNIz"
+ href="#op-QoxREYsNIz" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Nl6a4Lig7S" class="panel-body collapse">
+ <div id="op-QoxREYsNIz" class="panel-body collapse">
<p>Create a whole new admin user.</p>
@@ -392,8 +441,8 @@
<ul>
<li>
- <b>adminuserproperty</b> ( <a href="#createadminuser">CreateAdminUser</a>) <br>
- One or more sets of user properties of which username is mandatory and must be unique. (Specified in body).
+ <b>CreateAdminUser</b> (<a href="#CreateAdminUser">CreateAdminUser</a>)<br>
+ User entity with fields required for User creation. (Specified in body).
</li>
</ul>
@@ -403,15 +452,15 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of new created Admin user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Description: An API Response with a entities array containing the newly created Admin User.</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -420,16 +469,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-NnjAZL35sG"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-4VO7rcVd5A"
- href="#collapse-4VO7rcVd5A" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-NnjAZL35sG"
+ href="#op-NnjAZL35sG" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-4VO7rcVd5A" class="panel-body collapse">
+ <div id="op-NnjAZL35sG" class="panel-body collapse">
<p>Initiate the reset of an admin user's password.</p>
@@ -445,14 +496,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#Action">Action</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -461,16 +512,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-ibPS5jhpAj"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /management/users/resetpw
- <a data-toggle="collapse" data-target="#collapse-LXqB2iYC97"
- href="#collapse-LXqB2iYC97" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-ibPS5jhpAj"
+ href="#op-ibPS5jhpAj" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-LXqB2iYC97" class="panel-body collapse">
+ <div id="op-ibPS5jhpAj" class="panel-body collapse">
<p>Complete the password reset through getting the newpassword and the old one for identification.</p>
@@ -478,7 +531,7 @@
<ul>
<li>
- <b>ResetPWMsg</b> ( <a href="#resetpwmsg">ResetPWMsg</a>) <br>
+ <b>ResetPWMsg</b> (<a href="#ResetPWMsg">ResetPWMsg</a>)<br>
Parameters and value for the Captcha challenge, the admin user's response to the Captcha challenge, and the admin user's email address. (Specified in body).
</li>
</ul>
@@ -490,14 +543,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#"></a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
- <li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Description: </li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -506,16 +559,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-Bge9rwVR2F"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-Q5z4TRg0Yz"
- href="#collapse-Q5z4TRg0Yz" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-Bge9rwVR2F"
+ href="#op-Bge9rwVR2F" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Q5z4TRg0Yz" class="panel-body collapse">
+ <div id="op-Bge9rwVR2F" class="panel-body collapse">
<p>Retrieve details about an admin user.</p>
@@ -523,7 +578,7 @@
<ul>
<li>
- <b>userId</b> (string) <br>
+ <b>userId</b> (string)<br>
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -534,15 +589,15 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's details</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Description: An API Response with a entities array containing the Admin User.</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -551,16 +606,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-gQEepFPt0p"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /management/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-RsksaP1nUc"
- href="#collapse-RsksaP1nUc" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-gQEepFPt0p"
+ href="#op-gQEepFPt0p" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-RsksaP1nUc" class="panel-body collapse">
+ <div id="op-gQEepFPt0p" class="panel-body collapse">
<p>Update the info of an admin user.</p>
@@ -568,7 +625,7 @@
<ul>
<li>
- <b>userId</b> (string) <br>
+ <b>userId</b> (string)<br>
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -579,15 +636,15 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's details.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Description: An API Response with a entities array containing the updated Admin User</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -596,16 +653,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-BGDia29iCi"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}/activate
- <a data-toggle="collapse" data-target="#collapse-kEAq8Yg9t1"
- href="#collapse-kEAq8Yg9t1" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-BGDia29iCi"
+ href="#op-BGDia29iCi" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-kEAq8Yg9t1" class="panel-body collapse">
+ <div id="op-BGDia29iCi" class="panel-body collapse">
<p>Activate an admin user from a link provIded in an email notification.</p>
@@ -613,15 +672,15 @@
<ul>
<li>
- <b>userId</b> (string) <br>
+ <b>userId</b> (string)<br>
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>token</b> (string) <br>
+ <b>token</b> (string)<br>
Activation token's query statement. (Specified in query).
</li>
<li>
- <b>confirm_email</b> (boolean) <br>
+ <b>confirm_email</b> (boolean)<br>
Query statement of whether send confimation email or not. (Specified in query).
</li>
</ul>
@@ -633,14 +692,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#Action">Action</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -649,16 +708,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-tvFdo6Wdmr"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /management/users/{userId}/password
- <a data-toggle="collapse" data-target="#collapse-W5RltyqKY4"
- href="#collapse-W5RltyqKY4" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-tvFdo6Wdmr"
+ href="#op-tvFdo6Wdmr" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-W5RltyqKY4" class="panel-body collapse">
+ <div id="op-tvFdo6Wdmr" class="panel-body collapse">
<p>Update an admin user's password through getting the newpassword and the old one for identification.</p>
@@ -666,11 +727,11 @@
<ul>
<li>
- <b>userId</b> (string) <br>
+ <b>userId</b> (string)<br>
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
<li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ <b>ResetPW</b> (<a href="#ResetPW">ResetPW</a>)<br>
The user's old and new password. (Specified in body).
</li>
</ul>
@@ -682,14 +743,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#Action">Action</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -698,16 +759,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-Y1nYMat7jd"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /management/users/{userId}/reactivate
- <a data-toggle="collapse" data-target="#collapse-2Nlh69dhXA"
- href="#collapse-2Nlh69dhXA" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-Y1nYMat7jd"
+ href="#op-Y1nYMat7jd" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-2Nlh69dhXA" class="panel-body collapse">
+ <div id="op-Y1nYMat7jd" class="panel-body collapse">
<p>Reactivate an expired admin user.</p>
@@ -715,7 +778,7 @@
<ul>
<li>
- <b>userId</b> (string) <br>
+ <b>userId</b> (string)<br>
One of the user's identification which includes username, real name, email address or UUID. (Specified in path).
</li>
</ul>
@@ -727,14 +790,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#Action">Action</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -745,16 +808,18 @@
<a name='App-Users-method'></a>
<h2>App-Users</h2>
+<a name="op-KohIJoTygQ"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users
- <a data-toggle="collapse" data-target="#collapse-tTTdu5vrV0"
- href="#collapse-tTTdu5vrV0" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-KohIJoTygQ"
+ href="#op-KohIJoTygQ" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-tTTdu5vrV0" class="panel-body collapse">
+ <div id="op-KohIJoTygQ" class="panel-body collapse">
<p>Retrieve users though query statement.</p>
@@ -762,15 +827,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>queryStatement</b> (string) <br>
+ <b>queryStatement</b> (string)<br>
The query statement of the User. (Specified in query).
</li>
</ul>
@@ -782,14 +847,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -798,16 +863,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-ExiaIQsIeW"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users
- <a data-toggle="collapse" data-target="#collapse-nPALd14DPA"
- href="#collapse-nPALd14DPA" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-ExiaIQsIeW"
+ href="#op-ExiaIQsIeW" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-nPALd14DPA" class="panel-body collapse">
+ <div id="op-ExiaIQsIeW" class="panel-body collapse">
<p>Create a user in the users collection through providing all the identifications.</p>
@@ -815,15 +882,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>CreateUser</b> ( <a href="#createuser">CreateUser</a>) <br>
+ <b>CreateUser</b> (<a href="#CreateUser">CreateUser</a>)<br>
The properties of the user. (Specified in body).
</li>
</ul>
@@ -835,14 +902,14 @@
<b>200</b>
<ul>
<li>Description: An array of created user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -851,16 +918,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-KDDVENxZsp"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-XuAVNrdj2h"
- href="#collapse-XuAVNrdj2h" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-KDDVENxZsp"
+ href="#op-KDDVENxZsp" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-XuAVNrdj2h" class="panel-body collapse">
+ <div id="op-KDDVENxZsp" class="panel-body collapse">
<p>Retrieve a user through providing all the identifications.</p>
@@ -868,15 +937,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-2</b> (string) <br>
+ <b>userId-2</b> (string)<br>
One of the user's identification which includes username, email address or UUID. (Specified in path).
</li>
</ul>
@@ -888,14 +957,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -904,16 +973,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-Ai5RM27c5I"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-C4qK1lk92I"
- href="#collapse-C4qK1lk92I" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-Ai5RM27c5I"
+ href="#op-Ai5RM27c5I" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-C4qK1lk92I" class="panel-body collapse">
+ <div id="op-Ai5RM27c5I" class="panel-body collapse">
<p>Update a user through providing all the identifications.</p>
@@ -921,15 +992,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -941,14 +1012,14 @@
<b>200</b>
<ul>
<li>Description: An array of updated user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -957,16 +1028,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-1wdqoSlsQ5"/>
+
<div class="panel panel-default">
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-0WSXcDOdUz"
- href="#collapse-0WSXcDOdUz" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-1wdqoSlsQ5"
+ href="#op-1wdqoSlsQ5" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-0WSXcDOdUz" class="panel-body collapse">
+ <div id="op-1wdqoSlsQ5" class="panel-body collapse">
<p>Remove a user through providing all the identifications.</p>
@@ -974,15 +1047,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -994,14 +1067,14 @@
<b>200</b>
<ul>
<li>Description: An array of deleted user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1010,16 +1083,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-Tfo6D3w41U"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/users/{user}/password
- <a data-toggle="collapse" data-target="#collapse-r2XF5BGN70"
- href="#collapse-r2XF5BGN70" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-Tfo6D3w41U"
+ href="#op-Tfo6D3w41U" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-r2XF5BGN70" class="panel-body collapse">
+ <div id="op-Tfo6D3w41U" class="panel-body collapse">
<p>Set a user's password or reset the user's existing password.</p>
@@ -1027,19 +1102,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>username</b> (string) <br>
+ <b>username</b> (string)<br>
The username of the user. (Specified in path).
</li>
<li>
- <b>ResetPW</b> ( <a href="#resetpw">ResetPW</a>) <br>
+ <b>ResetPW</b> (<a href="#ResetPW">ResetPW</a>)<br>
The user's old and new password. (Specified in body).
</li>
</ul>
@@ -1051,14 +1126,14 @@
<b>200</b>
<ul>
<li>Description: An array of complete messages.</li>
- <li>Schema: [<a href="#action">Action</a>]</li>
+ <li>Schema: [<a href="#Action">Action</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1069,16 +1144,18 @@
<a name='Entities-Collections-method'></a>
<h2>Entities-Collections</h2>
+<a name="op-r80zXhSfho"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/users/{userId}/{relation}
- <a data-toggle="collapse" data-target="#collapse-3lNveRpUqE"
- href="#collapse-3lNveRpUqE" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-r80zXhSfho"
+ href="#op-r80zXhSfho" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-3lNveRpUqE" class="panel-body collapse">
+ <div id="op-r80zXhSfho" class="panel-body collapse">
<p>Retrieve a user's collections or connections through query statement.</p>
@@ -1086,23 +1163,23 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
<li>
- <b>relation</b> (string) <br>
+ <b>relation</b> (string)<br>
The relation between user and collections. (Specified in path).
</li>
<li>
- <b>queryStatement</b> (string) <br>
+ <b>queryStatement</b> (string)<br>
The query statement of the user. (Specified in query).
</li>
</ul>
@@ -1114,14 +1191,14 @@
<b>200</b>
<ul>
<li>Description: An array of user's collections info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1130,16 +1207,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-gb3PI7dCpr"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-ogbhoDjg4H"
- href="#collapse-ogbhoDjg4H" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-gb3PI7dCpr"
+ href="#op-gb3PI7dCpr" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-ogbhoDjg4H" class="panel-body collapse">
+ <div id="op-gb3PI7dCpr" class="panel-body collapse">
<p>Retrieve collection through query statement.</p>
@@ -1147,19 +1226,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>queryStatement</b> (string) <br>
+ <b>queryStatement</b> (string)<br>
Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1171,14 +1250,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1187,16 +1266,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-g5PcMjD3FP"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}
- <a data-toggle="collapse" data-target="#collapse-6dJ6nCe32N"
- href="#collapse-6dJ6nCe32N" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-g5PcMjD3FP"
+ href="#op-g5PcMjD3FP" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-6dJ6nCe32N" class="panel-body collapse">
+ <div id="op-g5PcMjD3FP" class="panel-body collapse">
<p>Update collection through query statement.</p>
@@ -1204,19 +1285,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>queryStatement</b> (string) <br>
+ <b>queryStatement</b> (string)<br>
Any values specified in the query statement should be enclosed in single-quotes. (Specified in query).
</li>
</ul>
@@ -1228,14 +1309,14 @@
<b>200</b>
<ul>
<li>Description: An array of updated collection's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1244,16 +1325,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-noESVjTYyy"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-CjwReqwJ3H"
- href="#collapse-CjwReqwJ3H" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-noESVjTYyy"
+ href="#op-noESVjTYyy" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-CjwReqwJ3H" class="panel-body collapse">
+ <div id="op-noESVjTYyy" class="panel-body collapse">
<p>Add an entity to a collection through providing all the identifications.</p>
@@ -1261,27 +1344,27 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityId1</b> (string) <br>
+ <b>entityId1</b> (string)<br>
The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>relation</b> (string) <br>
+ <b>relation</b> (string)<br>
The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>entityId2</b> (string) <br>
+ <b>entityId2</b> (string)<br>
The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -1293,14 +1376,14 @@
<b>200</b>
<ul>
<li>Description: An array of added entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1309,16 +1392,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-rqV37JpDGT"/>
+
<div class="panel panel-default">
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId1}/{relation}/{entityId2}
- <a data-toggle="collapse" data-target="#collapse-mafYwtUKyr"
- href="#collapse-mafYwtUKyr" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-rqV37JpDGT"
+ href="#op-rqV37JpDGT" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-mafYwtUKyr" class="panel-body collapse">
+ <div id="op-rqV37JpDGT" class="panel-body collapse">
<p>Remove an entity from a collection through providing all the identifications.</p>
@@ -1326,27 +1411,27 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityId1</b> (string) <br>
+ <b>entityId1</b> (string)<br>
The Id of the 1st entity. (Specified in path).
</li>
<li>
- <b>relation</b> (string) <br>
+ <b>relation</b> (string)<br>
The relation between 1st entity and 2nd entity. (Specified in path).
</li>
<li>
- <b>entityId2</b> (string) <br>
+ <b>entityId2</b> (string)<br>
The Id of the 2nd entity. (Specified in path).
</li>
</ul>
@@ -1358,14 +1443,14 @@
<b>200</b>
<ul>
<li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1374,16 +1459,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-GcguK1wiNI"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-Flwr684SUK"
- href="#collapse-Flwr684SUK" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-GcguK1wiNI"
+ href="#op-GcguK1wiNI" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Flwr684SUK" class="panel-body collapse">
+ <div id="op-GcguK1wiNI" class="panel-body collapse">
<p>Retrieve an entity through providing Id of application, organization, collection and entity.</p>
@@ -1391,19 +1478,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityId</b> (string) <br>
+ <b>entityId</b> (string)<br>
One of the entity's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -1415,14 +1502,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1431,16 +1518,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-717cOaQzyy"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-JxsN5odke0"
- href="#collapse-JxsN5odke0" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-717cOaQzyy"
+ href="#op-717cOaQzyy" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-JxsN5odke0" class="panel-body collapse">
+ <div id="op-717cOaQzyy" class="panel-body collapse">
<p>One or more properties can be updated with a single request.</p>
@@ -1448,23 +1537,23 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityId</b> (string) <br>
+ <b>entityId</b> (string)<br>
One of the entity's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
+ <b>entityproperty</b> (<a href="#CreateEntities">CreateEntities</a>)<br>
The properties of the entity. (Specified in body).
</li>
</ul>
@@ -1476,14 +1565,14 @@
<b>200</b>
<ul>
<li>Description: An array of updated entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1492,16 +1581,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-ZJvngxk5gr"/>
+
<div class="panel panel-default">
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/{collectionId}/{entityId}
- <a data-toggle="collapse" data-target="#collapse-JBJI86ZdNr"
- href="#collapse-JBJI86ZdNr" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-ZJvngxk5gr"
+ href="#op-ZJvngxk5gr" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-JBJI86ZdNr" class="panel-body collapse">
+ <div id="op-ZJvngxk5gr" class="panel-body collapse">
<p>Delete an entity from the collection.</p>
@@ -1509,19 +1600,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>collectionId</b> (string) <br>
+ <b>collectionId</b> (string)<br>
One of the collection's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entityId</b> (string) <br>
+ <b>entityId</b> (string)<br>
One of the entity's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -1533,14 +1624,14 @@
<b>200</b>
<ul>
<li>Description: An array of deleted entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1549,36 +1640,38 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-3y5Qc7VbKb"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/{entitytype}
- <a data-toggle="collapse" data-target="#collapse-aTXoq2rK1l"
- href="#collapse-aTXoq2rK1l" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-3y5Qc7VbKb"
+ href="#op-3y5Qc7VbKb" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-aTXoq2rK1l" class="panel-body collapse">
+ <div id="op-3y5Qc7VbKb" class="panel-body collapse">
- <p>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. </p>
+ <p>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.</p>
<h3>Parameters</h3>
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>entitytype</b> (string) <br>
+ <b>entitytype</b> (string)<br>
The entity type to create. (Specified in path).
</li>
<li>
- <b>entityproperty</b> ( <a href="#createentities">CreateEntities</a>) <br>
+ <b>entityproperty</b> (<a href="#CreateEntities">CreateEntities</a>)<br>
The properties of the entity. (Specified in body).
</li>
</ul>
@@ -1590,14 +1683,14 @@
<b>200</b>
<ul>
<li>Description: An array of created custom entity's info.</li>
- <li>Schema: [<a href="#entity">Entity</a>]</li>
+ <li>Schema: [<a href="#Entity">Entity</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1608,16 +1701,18 @@
<a name='Events-method'></a>
<h2>Events</h2>
+<a name="op-U4jz2jPCdU"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/events
- <a data-toggle="collapse" data-target="#collapse-Ye4oYQGILh"
- href="#collapse-Ye4oYQGILh" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-U4jz2jPCdU"
+ href="#op-U4jz2jPCdU" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Ye4oYQGILh" class="panel-body collapse">
+ <div id="op-U4jz2jPCdU" class="panel-body collapse">
<p>Create an event through providing both Id of organization and application.</p>
@@ -1625,15 +1720,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>CreateEvent</b> ( <a href="#createevent">CreateEvent</a>) <br>
+ <b>CreateEvent</b> (<a href="#CreateEvent">CreateEvent</a>)<br>
The required property of the event. (Specified in body).
</li>
</ul>
@@ -1645,14 +1740,14 @@
<b>200</b>
<ul>
<li>Description: An array of created event's info.</li>
- <li>Schema: [<a href="#event">Event</a>]</li>
+ <li>Schema: [<a href="#Event">Event</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1663,16 +1758,18 @@
<a name='Groups-method'></a>
<h2>Groups</h2>
+<a name="op-t6P5Jq7Cgx"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups
- <a data-toggle="collapse" data-target="#collapse-6zG2I9WKNb"
- href="#collapse-6zG2I9WKNb" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-t6P5Jq7Cgx"
+ href="#op-t6P5Jq7Cgx" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-6zG2I9WKNb" class="panel-body collapse">
+ <div id="op-t6P5Jq7Cgx" class="panel-body collapse">
<p>Create a new group through providing both Id of organization and application.</p>
@@ -1680,15 +1777,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupproperty</b> ( <a href="#creategroup">CreateGroup</a>) <br>
+ <b>groupproperty</b> (<a href="#CreateGroup">CreateGroup</a>)<br>
The property of the created group. (Specified in body).
</li>
</ul>
@@ -1700,14 +1797,14 @@
<b>200</b>
<ul>
<li>Description: An array of created group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Schema: [<a href="#Group">Group</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1716,16 +1813,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-QcQlSI3tb6"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/activities
- <a data-toggle="collapse" data-target="#collapse-Jc4I3aTW16"
- href="#collapse-Jc4I3aTW16" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-QcQlSI3tb6"
+ href="#op-QcQlSI3tb6" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-Jc4I3aTW16" class="panel-body collapse">
+ <div id="op-QcQlSI3tb6" class="panel-body collapse">
<p>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.</p>
@@ -1733,19 +1832,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
+ <b>groupId</b> (string)<br>
One of the group's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>CreateActivity</b> ( <a href="#createactivity">CreateActivity</a>) <br>
+ <b>CreateActivity</b> (<a href="#CreateActivity">CreateActivity</a>)<br>
One or more sets of activity properties. (Specified in body).
</li>
</ul>
@@ -1756,15 +1855,15 @@
<li>
<b>200</b>
<ul>
- <li>Description: An array of user's activity.</li>
- <li>Schema: [<a href="#activityfeed">ActivityFeed</a>]</li>
+ <li>Description: </li>
+ <li>Schema: [<a href="#ActivityFeed">ActivityFeed</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1773,16 +1872,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-ux3UHzZZ2T"/>
+
<div class="panel panel-default">
<div class="panel-heading POST">
<h2 class="panel-title POST-heading">POST /{orgId}/{appId}/groups/{groupId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-DSJUff0PNr"
- href="#collapse-DSJUff0PNr" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-ux3UHzZZ2T"
+ href="#op-ux3UHzZZ2T" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-DSJUff0PNr" class="panel-body collapse">
+ <div id="op-ux3UHzZZ2T" class="panel-body collapse">
<p>Add a user to a group through providing all the identifications.</p>
@@ -1790,19 +1891,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
+ <b>groupId</b> (string)<br>
One of the group's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1814,14 +1915,14 @@
<b>200</b>
<ul>
<li>Description: An array of added user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1830,16 +1931,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-XMwyKC5jSE"/>
+
<div class="panel panel-default">
<div class="panel-heading DELETE">
<h2 class="panel-title DELETE-heading">DELETE /{orgId}/{appId}/groups/{groupId}/users/{userId}
- <a data-toggle="collapse" data-target="#collapse-51z524RgVx"
- href="#collapse-51z524RgVx" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-XMwyKC5jSE"
+ href="#op-XMwyKC5jSE" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-51z524RgVx" class="panel-body collapse">
+ <div id="op-XMwyKC5jSE" class="panel-body collapse">
<p>Delete user from a group through providing all the identifications.</p>
@@ -1847,19 +1950,19 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
+ <b>groupId</b> (string)<br>
One of the group's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>userId-3</b> (string) <br>
+ <b>userId-3</b> (string)<br>
One of the user's identification which includes username or UUID. (Specified in path).
</li>
</ul>
@@ -1871,14 +1974,14 @@
<b>200</b>
<ul>
<li>Description: An array of deleted user's info.</li>
- <li>Schema: [<a href="#user">User</a>]</li>
+ <li>Schema: [<a href="#User">User</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1887,16 +1990,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-GyPmx489NH"/>
+
<div class="panel panel-default">
<div class="panel-heading GET">
<h2 class="panel-title GET-heading">GET /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-KlZpilr6UK"
- href="#collapse-KlZpilr6UK" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-GyPmx489NH"
+ href="#op-GyPmx489NH" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-KlZpilr6UK" class="panel-body collapse">
+ <div id="op-GyPmx489NH" class="panel-body collapse">
<p>Get a group through through providing all the identifications.</p>
@@ -1904,15 +2009,15 @@
<ul>
<li>
- <b>orgId</b> (string) <br>
+ <b>orgId</b> (string)<br>
One of the organization's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>appId</b> (string) <br>
+ <b>appId</b> (string)<br>
One of the application's identification which includes name or uuid. (Specified in path).
</li>
<li>
- <b>groupId</b> (string) <br>
+ <b>groupId</b> (string)<br>
One of the group's identification which includes name or uuid. (Specified in path).
</li>
</ul>
@@ -1924,14 +2029,14 @@
<b>200</b>
<ul>
<li>Description: An array of retrieved group's info.</li>
- <li>Schema: [<a href="#group">Group</a>]</li>
+ <li>Schema: [<a href="#Group">Group</a>]</li>
</ul>
</li>
<li>
<b>default</b>
<ul>
<li>Description: Unexpected error.</li>
- <li>Schema: [<a href="#error">Error</a>]</li>
+ <li>Schema: [<a href="#Error">Error</a>]</li>
</ul>
</li>
</ul>
@@ -1940,16 +2045,18 @@
<!--<div class="panel-footer"></div>-->
</div>
+<a name="op-RbH6ojRWAU"/>
+
<div class="panel panel-default">
<div class="panel-heading PUT">
<h2 class="panel-title PUT-heading">PUT /{org_Id}/{app_Id}/groups/{groupId}
- <a data-toggle="collapse" data-target="#collapse-BXLQOcewyG"
- href="#collapse-BXLQOcewyG" class="collapsed collapse-button"> </a>
+ <a data-toggle="collapse" data-target="#op-RbH6ojRWAU"
+ href="#op-RbH6ojRWAU" class="collapsed collapse-button"> </a>
</h2>
</div>
- <div id="collapse-BXLQOcewyG" class="panel-body collapse">
+ <div id="op-RbH6ojRWAU" class="panel-body collapse">
<p>Update a group through providing all the identification
<TRUNCATED>