TEteaflask
authed

List suggested actions

Suggested actions from scans and uploads, newest first, each as a summary without its schemas; pass status=open for the ones waiting for review, and read one in full with get_org_action_proposal. Approve with its payload_fingerprint. A full page means more may exist.

get/api/v1/org-actions/proposals

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
  • Auth
    none declared

Query parameters

status'open' | 'approved' | 'dismissed' | 'withdrawn'

Only proposals in this state; open ones are waiting for review.

before_created_atstring date-time nullable

With before_id: the last row of the previous page's created_at, to read the next page.

before_idstring uuid nullable

With the sort cursor: the last row of the previous page's id.

limitinteger

The most suggested actions to return.

Response

Successful Response

idstring uuid required

The suggested action's id.

kind'create' | 'update' | 'deprecate' required
status'open' | 'approved' | 'dismissed' | 'withdrawn' required
org_action_idstring uuid nullable required

The catalog action an update or deprecation changes; null for a new action.

titlestring required

The title the action would have.

descriptionstring nullable required

What an agent would read when deciding whether to call the action; null when the suggestion carries none.

slugstring nullable required

The unique short name the action would have; null when the suggestion carries none.

method'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required

The catalog's method whitelist: an action can only ever speak these.

path_templatestring nullable required

The endpoint path on the organization's own API, with {placeholder} segments; null when the suggestion carries none.

effect'read_only' | 'idempotent' | 'destructive' required

What calling the action does to the world — an annotation, never a policy. It feeds the policy default for rows registered without one and the approval gate's prompt tone; an explicit policy always wins, and a mutating method never defaults above ask whatever the annotation claims.

policy'allow' | 'deny' | 'ask' required
edited_atstring date-time nullable required

When a member last edited the suggestion, which later scans then leave alone; null when never edited.

keptinteger required

How many member edits on the action approving keeps, because the code didn't change them.

conflictsinteger required

How many member edits the code changed too; approving needs a version picked for each, which get_org_action_proposal lists.

kept_labelsstring[] required

The parts approving keeps as members edited them, in words.

kept_by_user_idsstring[] required

Who made the kept edits, each member once; null stands for an edit whose author isn't known.

payload_fingerprintstring required

The suggestion's version; approving sends it as reviewed_fingerprint, so only what you read is approved.

created_atstring date-time required

When the suggestion was filed.

Changes

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