Dreamspace/adventures
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(stamps): Add GET method.

Interitio
2025-06-07 00:34:27 +10:00
parent 016d6351da
commit 2c3583f160
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api-reference.md

@@ -20,6 +20,9 @@ Represents a document stamp.
- `PUT` `/stamps` - `PUT` `/stamps`
- Create and return a list of `Stamp`s. - Create and return a list of `Stamp`s.
- Should generally not be used directly. Instead, create the `Stamps` with the `Document` or with `PUT /documents/{document_id}/stamps` - Should generally not be used directly. Instead, create the `Stamps` with the `Document` or with `PUT /documents/{document_id}/stamps`
- `GET` `/stamps`
- Get all `Stamp`s matching the given parameters.
- Supported filter parameters: `stamp_id`, `document_id`, `stamp_type`
- `GET` `/stamps/{stamp_id}` - `GET` `/stamps/{stamp_id}`
- Returns a `Stamp` with the given `stamp_id`, or raises `Not Found` if no stamp exists. - Returns a `Stamp` with the given `stamp_id`, or raises `Not Found` if no stamp exists.
- `PATCH` `/stamps/{stamp_id}` - `PATCH` `/stamps/{stamp_id}`