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 Acceptance Criteria API

The Acceptance Criteria API from Acceptance Criteria — 2 operation(s) for acceptance criteria.

This API exposes 4 operations across 2 paths, and defines 5 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.

4 operations 2 paths 5 schemas 1 DELETE1 GET1 POST1 PUT

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 Acceptance Criteria API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

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

Acceptance Criteria 4
GET
/stories/{storyId}/acceptance-criteria
List acceptance criteria for a story
listAcceptanceCriteria 1 param → 200401404500
POST
/stories/{storyId}/acceptance-criteria
Add acceptance criterion
addAcceptanceCriterion 1 param body → 201400401404500
PUT
/stories/{storyId}/acceptance-criteria/{criterionId}
Update an acceptance criterion
updateAcceptanceCriterion 2 params body → 200400401404500
DELETE
/stories/{storyId}/acceptance-criteria/{criterionId}
Delete an acceptance criterion
deleteAcceptanceCriterion 2 params → 204401404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AcceptanceCriterion (10 properties), CreateAcceptanceCriterionRequest (6 properties), UpdateAcceptanceCriterionRequest (6 properties), AcceptanceCriteriaList (4 properties). Each schema is shown below with its type and property counts.

UpdateAcceptanceCriterionRequest
object
Request body for updating an acceptance criterion
6 properties
CreateAcceptanceCriterionRequest
object
Request body for adding an acceptance criterion to a story
6 properties 1 required
ErrorResponse
object
Standard error response
3 properties
AcceptanceCriterion
object
A single testable condition that must be met for a user story to be accepted as complete
10 properties 2 required
AcceptanceCriteriaList
object
List of acceptance criteria for a user story
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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