Skip to content

Commit

Permalink
clarify collection docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff committed Jun 12, 2024
1 parent 8af8752 commit 1779a01
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/seqcol.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ inherent:
#### 3.2 Collection
- *Endpoint*: `GET /collection/:digest?level=:level` (`REQUIRED`)
- *Description*: The retrieval function specifies an API endpoint that retrieves original sequences from a database keyed by the unique digest. Here `:digest` is the seqcol digest computed above. The level corresponds to the "expansion level" of the returned sequence collection returned. The default is `?level=2`, which returns the canonical structure.
- *Description*: Retrieves original sequence collection from a database, keyed by the unique top-level digest. Here `:digest` is the seqcol digest computed above. The level corresponds to the "expansion level" of the returned sequence collection returned. The default is `?level=2`, which returns the canonical structure.
- *Return value*: The sequence collection identified by the `:digest` variable. The structure of the data `MUST` be modulated by the `:level` query parameter. Specifying `?level=2` returns the canonical structure, and `?level=1` returns the collection with digested attributes.

Non-inherent attributes `MUST` be stored and returned by the collection endpoint alongside inherent attributes.
Expand Down

0 comments on commit 1779a01

Please sign in to comment.