mirror of https://github.com/vernonkeenan/lib
24 lines
1.2 KiB
Markdown
24 lines
1.2 KiB
Markdown
# Members DocumentParameter client
|
|
|
|
The generated `document_parameters` client exposes the governed
|
|
`GET /documentparameters`, `POST /documentparameters`, and
|
|
`PUT /documentparameters` operations.
|
|
|
|
Every call requires the caller to provide both the server-held API-key
|
|
authentication writer and the native `kvSession` cookie through the request
|
|
transport. The Members service enforces the exact
|
|
`members:document-parameter:read`, `:create`, or `:update` machine scope.
|
|
Active Contributors can read only their own records. Creates and
|
|
compare-and-swap updates require tenant Owner or Manager authority.
|
|
|
|
`DocumentID` is required and validated against the same tenant.
|
|
`LastModifiedDate` is the optimistic concurrency token; stale updates return
|
|
409. IDs, tenant ownership, and audit fields remain server-owned.
|
|
`IsDeleted` and `DeletedDate` are lifecycle-owned, and the client exposes no
|
|
generic delete operation.
|
|
|
|
Folder client generation is deferred because the authoritative Folder schema
|
|
contains `AccountID` and a polymorphic `ObjectID`/`ObjectType` pair without
|
|
governed same-tenant reference metadata. Publishing those writes would be less
|
|
safe than the unambiguous DocumentParameter-to-Document relationship.
|