Optional ReadonlycredentialsWhat's required to call this operation -- descriptive only, never an authorization/enforcement claim.
Optional ReadonlydescriptionWhat this operation does.
Optional ReadonlyendpointsDeclared data-flow boundaries this operation crosses -- see DataFlowEndpoint.
Optional ReadonlymetadataFree-form extension bag for anything data-cap itself has no named
concept for -- opaque, never inspected or validated by any code path in
this package. The index signature below remains for the same reason it
always has (documenting never fights the type checker); metadata is
the recommended place for new extension data going forward.
Optional ReadonlyresponseDocumented shape of what this operation returns/produces.
Optional ReadonlysourceShort identifier for where this operation acquires/sends data (e.g. "stripe-api", "postgres:users"), not prose.
Documentation metadata for one getter/mutator/subscription. Reserved keys are explicitly typed (mirroring the vocabulary real capabilities tend to document -- what it does, where it talks to, what it costs to call) while still accepting arbitrary extra keys for anything project-specific, so documenting never fights the type checker.
credentialsis descriptive only -- documentingcredentials: "user session"is never proof that authorization is actually enforced.endpointsis likewise author-declared, never verified.