Feature · Knowledge
Examples & Procedures
Reuse approved examples and review proposed procedures.
How it works
Approved examples
An example is a pull request description, commit message, review reply, code snippet or status report that a person approved. Workers use examples as style references. Nothing becomes an example without a person. An approver selects Add example, and can pin, unpin or remove examples. An example applies to the organization, a project, or just you.
Procedures
When workers repeat the same tool sequence, Agent proposes it as a procedure. An approver selects Approve or Reject. A failing run demotes a procedure until someone approves it again. An admin sets how many repeats come before a proposal, and how many failing runs come before a demotion.
From the help article Examples and procedures, checked against the product on .
What you can do
The operations this feature's screens call. Each one is POST /api/<name>, and the badge says who may call it.
ViewerlistApprovedExamplesLists approved examples.
Types:
ListApprovedExamplesRequestreturnsListResponse<ApprovedExampleDto>
ApproverNo API tokenspinExamplePins the example.
Types:
PinExampleRequestreturnsApprovedExampleDto
ApproverNo API tokensremoveExampleRemoves the example.
Types:
RemoveExampleRequestreturnsApprovedExampleDto
ApproverNo API tokensapproveExampleApproves the example.
Types:
ApproveExampleRequestreturnsApprovedExampleDto
ViewerlistProceduresLists procedures.
Types:
ListProceduresRequestreturnsListResponse<ProcedureDto>
ViewergetProcedureSettingsGets procedure settings.
Types:
EmptyRequestreturnsProcedureSettingsDto
ApproverNo API tokensreviewProcedureReviews the procedure.
Types:
ReviewProcedureRequestreturnsProcedureDto
AdminlearnProceduresLearns procedures.
Types:
EmptyRequestreturnsLearnProceduresResponse
AdminNo API tokensupdateProcedureSettingsUpdates procedure settings.
Types:
UpdateProcedureSettingsRequestreturnsProcedureSettingsDto
ViewerlistMembersLists members.
Types:
EmptyRequestreturnsListMembersResponse