Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acceptance Criteria Test Runs API

The Test Runs API from Acceptance Criteria — 1 operation(s) for test runs.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.example.com/v1.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.github.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Acceptance Criteria Test Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Test Runs 2
GET
/test-runs
List acceptance test runs
listTestRuns 2 params → 200401500
POST
/test-runs
Create a test run
createTestRun body → 201400401500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TestRun (11 properties), TestRunList (4 properties), ErrorResponse (3 properties), CreateTestRunRequest (2 properties). Each schema is shown below with its type and property counts.

TestRunList
object
Paginated list of test runs
4 properties
TestRun
object
An execution instance of acceptance criteria tests across one or more stories or scenarios
11 properties 2 required
CreateTestRunRequest
object
Request body for creating and triggering a test run
2 properties
ErrorResponse
object
Standard error response
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acceptance-criteria-test-runs-api-openapi.yml Raw ↑