33 lines
859 B
Markdown
33 lines
859 B
Markdown
Schema for a Group object
|
|
=======================
|
|
|
|
----------------------------------------
|
|
|
|
### What's a Group object for?
|
|
|
|
The Group object stores information for a given group.
|
|
A Group consists of an `id`, `name` and array of `email addresses`.
|
|
|
|
----------------------------------------
|
|
|
|
### Schema for a Group object
|
|
|
|
{
|
|
id: (string),
|
|
appId: (string),
|
|
name: (string),
|
|
members: (set)
|
|
}
|
|
|
|
----------------------------------------
|
|
|
|
### Schema description
|
|
|
|
* id, a string idenfier
|
|
* appId, the appId which created this group
|
|
* name, the name of the group
|
|
* members: a set of email addresses who belong to this group
|
|
|
|
[User]: http://theopenphotoproject.org/documentation/schemas/User
|
|
[Photo]: http://theopenphotoproject.org/documentation/schemas/Photo
|
|
[Action]: http://theopenphotoproject.org/documentation/schemas/Action
|