Forms

Reject standalone Forms API editing.

Standalone Forms API editing has been removed. Update the source review artifact or draft review file instead.

patch/api/v1/forms/{formId}

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/forms/{formId}
  • Auth: HTTP bearer

Path parameters

formIdstring required

Form id or reference id.

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Request body

contractFormContract

Normalized Commentary Form Contract v1.

contractSourcestring

Literal JSON or YAML form contract source.

sourceFormat'json' | 'yaml' | 'auto'
referenceIdstring
titlestring
descriptionstring
visibility'private' | 'shared' | 'public_placeholder'
sourceType'commentary' | 'github' | 'embedded' | 'custom'
sourceMetadataobject
destinationConfigobject
agentAliasstring
clientNamestring

Changes

No recorded changes to this operation across all 1 revision of this API.