Opérations

Appelez chaque opération avec POST /api/v1/<operation> et un corps objet JSON. Dans les tableaux, le nom de l’opération est le suffixe exact après /api/v1/.

Cas de test

Plans de test

Exécutions

Environnements

Notes

Les Notes sont réservées à HTTP et n’apparaissent pas dans le catalogue d’outils MCP.

Mutations idempotentes

Toute mutation marquée Requise doit inclure une chaîne idempotencyKey dans son corps JSON. Réutilisez la même clé pour réessayer la même mutation voulue ; utilisez une nouvelle clé pour une autre mutation. Les opérations de lecture n’utilisent pas de clé d’idempotence.

Créer un cas de test

Cette requête n’utilise que les champs acceptés par test_case.create. Les objets valueSpec distinguent une valeur littérale ordinaire d’une valeur d’environnement résolue à l’exécution.

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" }
  ]
}'

Définissez AUTONOMY_API_BASE avec NEXT_PUBLIC_CONVEX_SITE_URL et stockez la clé aut_ dans AUTONOMY_API_KEY.

Déclencher une exécution

Fournissez exactement l’un de testCaseId ou testPlanId. Cet exemple cible une prévisualisation web récente ; utilisez plutôt environmentSlug lorsque la cible est enregistrée.

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"]
}'

La réponse contient runIds et, pour un plan de test, peut contenir planGroupRunId. Le déclenchement renvoie immédiatement ; suivez chaque identifiant avec run.get.

Confirmation avant remplacement

confirm: true n’est jamais requis pour une création ni pour run.trigger. Il l’est uniquement lorsqu’une opération remplacerait une configuration existante :

• test_case.update_steps l’exige toujours, car toute la liste d’étapes est remplacée.
• test_plan.set_members l’exige seulement si des cas seraient retirés.
• environment.upsert l’exige lorsqu’un slug existant serait mis à jour avec les champs ou cibles fournis.

Sans confirmation, l’API renvoie INVALID_ARGUMENT avec details.confirmRequired: true et un aperçu details.wouldChange. Examinez-le avant de réessayer ; n’ajoutez pas confirm: true automatiquement.

Pagination par curseur

Chaque requête *.list accepte un limit et un cursor opaque facultatifs :

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

limit vaut 20 par défaut et doit être un entier de 1 à 100. Chaque réponse a la forme { items, nextCursor }. Transmettez nextCursor sans le modifier pour obtenir la page suivante ; null signifie qu’il n’y a plus de page. Les filtres restent dans le même corps et doivent rester inchangés entre les pages.