Commit 78f7899d authored by Lyza Danger Gardner's avatar Lyza Danger Gardner Committed by Lyza Gardner

Expand type descriptions on a couple of Group properties

All Group objects have an `id`, some have a `groupid`. First party
groups deal in `id`s only (aka `pubid`s), while LMS groups use
`groupid`s as they include authority information and are unique across
all authorities.
parent e92fe755
......@@ -141,8 +141,9 @@
* TODO - Fill out remaining properties
*
* @typedef Group
* @prop {string} id
* @prop {string} groupid
* @prop {string} id - a.k.a. "pubid", unique per authority.
* @prop {string} [groupid] - Fully-qualified ID with authority.
* Not all groups have a `groupid`. LMS groups always have a `groupid`.
* @prop {'private'|'open'} type
* @prop {Organization} organization - nb. This field is nullable in the API, but
* we assign a default organization on the client.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment