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 BDD Scenarios API

The BDD Scenarios API from Acceptance Criteria — 1 operation(s) for bdd scenarios.

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 BDD Scenarios 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.

BDD Scenarios 2
GET
/scenarios
List BDD scenarios
listScenarios 4 params → 200401500
POST
/scenarios
Create a BDD scenario
createScenario body → 201400401500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Scenario (9 properties), CreateScenarioRequest (5 properties), ScenarioList (4 properties), ErrorResponse (3 properties). Each schema is shown below with its type and property counts.

CreateScenarioRequest
object
Request body for creating a BDD scenario
5 properties 4 required
ScenarioList
object
Paginated list of BDD scenarios
4 properties
Scenario
object
A Gherkin BDD scenario that automates verification of an acceptance criterion
9 properties 3 required
ErrorResponse
object
Standard error response
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acceptance-criteria-bdd-scenarios-api-openapi.yml Raw ↑