Schema
What POST /v1/workspaces/{id}/documents/{document}/note answers with.
[Created] would lose the one fact the caller cannot otherwise learn: whether this call made the note or the file already had one. The store reports it - created is its answer, not an inference from the delta - so the answer carries it through unchanged.
Type object
| Field | Type | Description |
|---|---|---|
| idrequired | DocumentId | The note's document id - the existing one when the file already had a note. |
| createdrequired | boolean | Whether this call created the note. |
{
"id": {},
"created": false
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .