Autonomy dokumentatsioon
HTTP API v1

Toimingud

Kõigi 18 HTTP API toimingu marsruudid, õigused, idempotentsusnõuded ja eesmärgid.

Kutsu iga toimingut POST /api/v1/<operation> ja JSON-objektist kehaga. Tabelis olev toimingu nimi on täpne järelliide pärast /api/v1/.

Testjuhtumid

ToimingÕigusIdempotentsusEesmärk
test_case.listautonomy:readPuudubLoetle organisatsiooni testjuhtumid, uusimad eespool. Filtreeri platvormi või nimepäringu järgi. Kasuta enne juhtumi loomist, et olemasolevat katvust taaskasutada.
test_case.getautonomy:readPuudubToo üks testjuhtum koos selle täieliku sammude loendiga.
test_case.createautonomy:test_cases:writeNõutudLoo selgelt määratud sammudest testjuhtum. Täiteväärtused on literal, agent (Agent valib käivitamise ajal) või environment (nimeline keskkonna käitusaegne väärtus); mandaadi kujuga literaalid lükatakse tagasi, kui neid ei teisaldata sõnaselgelt keskkonna saladuseks.
test_case.update_stepsautonomy:test_cases:writeNõutudAsenda testjuhtumi kogu sammude loend. Nõuab confirm: true; ilma selleta kirjeldab vastus, mis muutuks, ja midagi ei kirjutata.

Testiplaanid

ToimingÕigusIdempotentsusEesmärk
test_plan.listautonomy:readPuudubLoetle organisatsiooni testiplaanid ehk testjuhtumite nimelised valikud.
test_plan.getautonomy:readPuudubToo üks testiplaan koos selle järjestatud liikmetest testjuhtumitega.
test_plan.createautonomy:test_plans:writeNõutudLoo testiplaan ja soovi korral selle esialgsed järjestatud liikmetest testjuhtumid.
test_plan.set_membersautonomy:test_plans:writeNõutudAsenda testiplaani järjestatud liikmesus. Juhtumite eemaldamine nõuab confirm: true; ilma selleta loetleb vastus juhtumid, mis eemaldataks, ja midagi ei kirjutata.

Käivitused

ToimingÕigusIdempotentsusEesmärk
run.triggerautonomy:runs:writeNõutudLisa käivitused järjekorda. Anna täpselt üks järgmistest: testCaseId või testPlanId (plaan lisab järjekorda ühe käivituse iga liikmest juhtumi kohta). Sihi salvestatud keskkonda slug'i järgi või edasta uue juurutuse või artefakti jaoks selged sihtmärgid. Tagastab kohe; jätka toiminguga run.get.
run.listautonomy:readPuudubLoetle hiljutised käivitused, uusimad eespool. Filtreeri oleku, testjuhtumi, keskkonna või haru järgi. Kontrolli siit enne topelttöö käivitamist.
run.getautonomy:readPuudubToo käivituse olek. Edasta eelmine cursor ja waitMs (≤ 25000), et blokeerida kuni millegi muutumiseni; timedOut: true tähendab, et midagi ei muutunud, ega ole viga. next on soovitus, mitte kunagi määrav juhis.
run.evidenceautonomy:readPuudubToo käivituse välised tõendid: iga sammu kohta see, mida toode näitas ja mida oodati, otsus ja diagnoos, neutraalsed toimingud ning lühikese kehtivusega meedialingid. Mudeli, viiba, tokeni ega käitaja siseandmeid ei lisata kunagi. Filtreeri parameetriga step.

Keskkonnad

ToimingÕigusIdempotentsusEesmärk
environment.listautonomy:readPuudubLoetle keskkonnad ehk nimelised juurutussihtmärgid koos nende platvormipõhiste sihtmärkidega. Kuvatakse käitusaegsete väärtuste nimed, kuid mitte kunagi väärtusi.
environment.getautonomy:readPuudubToo üks keskkond slug'i järgi.
environment.upsertautonomy:environments:writeNõutudLoo keskkond või uuenda seda slug'i järgi. Olemasoleva slug'i uuendamine kirjutab antud sihtmärgid üle ja nõuab confirm: true; ilma selleta kirjeldab vastus muudatust ja midagi ei kirjutata.

Märkmed

Märkmed on saadaval ainult HTTP kaudu ega ilmu MCP tööriistakataloogi.

ToimingÕigusIdempotentsusEesmärk
note.listautonomy:readPuudubLoetle keskkonna märkmed, uusimad eespool. Filtreeri oleku järgi.
note.createautonomy:notes:writeNõutudLisa keskkonnale märge. Sisu on lihttekst, kus reavahetus alustab uut lõiku. Viita käivitustele väljaga runIds.
note.commentautonomy:notes:writeNõutudLisa märkme tegevustele lihttekstis kommentaar.

Idempotentsed mutatsioonid

Iga toiming, mille idempotentsus on Nõutud, peab JSON-kehas sisaldama stringi idempotencyKey. Sama kavandatud mutatsiooni kordamisel kasuta sama võtit; teise mutatsiooni jaoks kasuta uut võtit. Lugemistoimingud idempotentsusvõtit ei kasuta.

Testjuhtumi loomine

See päring kasutab ainult test_case.create poolt aktsepteeritud välju. Objektid valueSpec eristavad tavalist literaali käivituse ajal lahendatavast keskkonnaväärtusest.

test_case.createbash
curl --request POST "$AUTONOMY_API_BASE/api/v1/test_case.create" \
--header "Authorization: Bearer $AUTONOMY_API_KEY" \
--header "Content-Type: application/json" \
--data '{
  "idempotencyKey": "ci-test-case-checkout-smoke-v1",
  "name": "Checkout smoke",
  "description": "A customer can complete checkout.",
  "platforms": ["web"],
  "tags": ["checkout", "smoke"],
  "steps": [
    { "action": "navigate", "target": "/checkout" },
    {
      "action": "fill",
      "target": "Email",
      "valueSpec": { "kind": "literal", "text": "qa@example.com" }
    },
    {
      "action": "fill",
      "target": "Password",
      "valueSpec": { "kind": "environment", "variable": "LOGIN_PASSWORD" }
    },
    { "action": "click", "target": "Place order" }
  ]
}'

Määra AUTONOMY_API_BASE väärtuseks NEXT_PUBLIC_CONVEX_SITE_URL ja hoia aut_ võtit muutujas AUTONOMY_API_KEY.

Käivituse käivitamine

Anna täpselt üks järgmistest: testCaseId või testPlanId. Näide sihib uut veebieelvaadet; kasuta selle asemel environmentSlug, kui sihtmärk on salvestatud.

run.triggerbash
curl --request POST "$AUTONOMY_API_BASE/api/v1/run.trigger" \
--header "Authorization: Bearer $AUTONOMY_API_KEY" \
--header "Content-Type: application/json" \
--data '{
  "idempotencyKey": "ci-run-pr-128-checkout-smoke-9f3a2c1",
  "testCaseId": "jh7exampletestcaseid",
  "platforms": ["web"],
  "targets": {
    "web": { "baseUrl": "https://preview-128.example.com" }
  },
  "branch": "feature/checkout-copy",
  "pr": "128",
  "deployment": { "commitSha": "9f3a2c1d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b" },
  "scope": "changed",
  "changedFiles": ["src/checkout/page.tsx"]
}'

Vastus sisaldab runIds ja testiplaani puhul võib sisaldada planGroupRunId. Käivitamine tagastab kohe; jälgi iga ID-d toiminguga run.get.

Kinnitus enne asendamist

confirm: true pole loomisel ega toimingus run.trigger kunagi nõutud. See on vajalik ainult siis, kui toiming asendaks olemasoleva konfiguratsiooni:

  • test_case.update_steps nõuab seda alati, sest kogu sammude loend asendatakse.
  • test_plan.set_members nõuab seda ainult juhul, kui juhtumeid eemaldataks.
  • environment.upsert nõuab seda, kui olemasolevat slug'i uuendataks esitatud väljade või sihtmärkidega.

Kinnituseta tagastab API INVALID_ARGUMENT koos väärtusega details.confirmRequired: true ja eelvaatega details.wouldChange. Vaata eelvaade enne kordamist üle; ära lisa confirm: true automaatselt.

Kursoriga lehitsemine

Iga *.list päring aktsepteerib valikulist limit-it ja läbipaistmatut cursor-it:

Codejson
1{2  "limit": 20,3  "cursor": "<nextCursor from the previous response>"4}

limit on vaikimisi 20 ja peab olema täisarv vahemikus 1 kuni 100. Iga vastus on kujul { items, nextCursor }. Järgmise lehe toomiseks edasta nextCursor muutmata; null tähendab, et rohkem lehti pole. Filtriargumendid on samas kehas ja peavad lehtede vahel samaks jääma.

On this page