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 User Stories API

The User Stories API from Acceptance Criteria — 2 operation(s) for user stories.

This API exposes 4 operations across 2 paths, and defines 6 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 6 schemas 2 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 User Stories 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 — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Stories 4
GET
/stories
List user stories
listUserStories 3 params → 200401500
POST
/stories
Create a user story
createUserStory body → 201400401500
GET
/stories/{storyId}
Get a user story
getUserStory 1 param → 200401404500
PUT
/stories/{storyId}
Update a user story
updateUserStory 1 param body → 200400401404500

Schemas 6

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

UpdateUserStoryRequest
object
Request body for updating an existing user story
5 properties
ErrorResponse
object
Standard error response
3 properties
UserStoryList
object
Paginated list of user stories
4 properties
CreateUserStoryRequest
object
Request body for creating a new user story
6 properties 1 required
UserStory
object
A user story representing a feature or requirement from the perspective of an end user
11 properties 3 required
AcceptanceCriterion
object
A single testable condition that must be met for a user story to be accepted as complete
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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