TEteaflask
authed

Approve a suggested action

Approves a suggested action: a create adds it to the catalog, an update changes its action and a deprecation archives it, after the definition passes the checks register_org_action applies. An update keeps the member edits on its action that the code didn't change; where the code changed an edited part too, send keep with the version to keep for each. Approval is refused when the suggestion or those edits changed since you read its payload_fingerprint (read it again), and a create that conflicts with the catalog stays open. While published agents use the action an update or deprecation changes, approving needs confirm.

post/api/v1/org-actions/proposals/{proposal_id}/approve

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/org-actions/proposals/{proposal_id}/approve
  • Auth
    none declared

Path parameters

proposal_idstring uuid required

The suggested action's id, as list_org_action_proposals returns it.

Query parameters

confirmboolean

Set true only after the person you're acting for has agreed to go ahead, having been told which published agents use this action; a call without it names those agents and changes nothing.

Request body

reviewed_fingerprintstring required

The payload_fingerprint of the suggestion as you read it; approval is consent to exactly that version.

Response

Successful Response

idstring uuid required
organization_idstring uuid required
kind'create' | 'update' | 'deprecate' required
org_action_idstring uuid nullable required
payloadobject required
payload_fingerprintstring required
status'open' | 'approved' | 'dismissed' | 'withdrawn' required
reviewed_by_user_idstring uuid nullable required
reviewed_atstring date-time nullable required
withdrawn_reasonstring nullable required
edited_by_user_idstring uuid nullable required
edited_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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