Promptary
Backend ยท API Contracts

API Contracts developer concepts

Learn 184 API Contracts concepts for Backend development, with definitions, aliases, and ready-to-use AI prompts.

Contract foundations & governance

API contract

Defines the inputs, outputs, behavior, and compatibility promises shared by an API provider and its consumers.

Also known as
Service contract, Interface contract, API agreement
AI prompt
Create a production-ready API contract for an API contract. State the operations, schemas, errors, security expectations, and evolution policy without leaking implementation details. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Interface description language

Provides a machine-readable language for describing callable operations and data structures.

Also known as
IDL, Interface definition language, Contract language
AI prompt
Create a production-ready Interface description language for an API contract. Choose an IDL that matches the transport and ecosystem, and document its version and supported tooling. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract-first design

Defines and reviews the public interface before provider implementation begins.

Also known as
API-first design, Spec-first design, Contract-first API
AI prompt
Create a production-ready Contract-first design for an API contract. Make the reviewed contract the input to mocks, implementation, tests, documentation, and code generation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Design-first workflow

Iterates on API behavior with stakeholders using a specification and mock before production code.

Also known as
API design workflow, Mock-first API, Specification-led design
AI prompt
Create a production-ready Design-first workflow for an API contract. Define review gates, mock examples, stakeholder sign-off, and the handoff into implementation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Code-first contract

Derives an API description from implementation annotations, types, or runtime metadata.

Also known as
Implementation-first API, Generated specification, Annotation-driven contract
AI prompt
Create a production-ready Code-first contract for an API contract. Identify the generation source, exclude internal models, stabilize generated names, and detect output drift in CI. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Schema-first development

Uses shared data schemas as the starting point for producers, consumers, and generated types.

Also known as
Model-first API, Type-first contract, Schema-led development
AI prompt
Create a production-ready Schema-first development for an API contract. Define canonical identifiers, references, constraints, ownership, and safe schema evolution rules. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Consumer-driven contract

Captures the interactions a consumer relies on and verifies them against the provider.

Also known as
CDC, Consumer contract, Consumer-led contract
AI prompt
Create a production-ready Consumer-driven contract for an API contract. Record only observable consumer expectations, isolate provider states, publish versions, and verify before deployment. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Provider contract

Publishes the complete interface and behavior a service provider promises to support.

Also known as
Provider specification, Service provider contract, Published API contract
AI prompt
Create a production-ready Provider contract for an API contract. Describe supported operations and variants, ownership, service levels, deprecation, and authoritative examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Bilateral API contract

Records an explicitly negotiated interface between one provider and one consumer.

Also known as
Point-to-point contract, Negotiated contract, Partner API agreement
AI prompt
Create a production-ready Bilateral API contract for an API contract. Document party-specific fields, security, environments, version pinning, approval, and exit or migration conditions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Canonical contract source

Identifies the authoritative contract artifact from which other representations are produced.

Also known as
Contract source of truth, Authoritative schema, Golden specification
AI prompt
Create a production-ready Canonical contract source for an API contract. Name the owner and repository, define generation direction, prohibit manual edits to derivatives, and add drift checks. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract ownership

Assigns responsibility for approving, maintaining, and supporting an API contract.

Also known as
API ownership, Schema ownership, Contract maintainer
AI prompt
Create a production-ready Contract ownership for an API contract. Define owners, backups, review paths, escalation contacts, and response expectations for proposed changes. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract governance

Applies organization-wide policies and review controls to API contracts.

Also known as
API governance, Schema governance, Contract policy
AI prompt
Create a production-ready Contract governance for an API contract. Define enforceable rules, justified exceptions, approval authority, severity, and automated evaluation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract review

Evaluates a proposed interface for usability, consistency, security, and compatibility before release.

Also known as
API design review, Schema review, Interface review
AI prompt
Create a production-ready Contract review for an API contract. Provide reviewer roles, checklist evidence, comments, decision state, and traceable follow-up changes. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract lifecycle

Tracks a contract from proposal through preview, stability, deprecation, and retirement.

Also known as
API lifecycle, Schema lifecycle, Contract maturity
AI prompt
Create a production-ready Contract lifecycle for an API contract. Define allowed lifecycle states, promotion criteria, support guarantees, transition notices, and terminal handling. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract version

Identifies a specific published revision of an API contract.

Also known as
Schema version, API specification version, Interface version
AI prompt
Create a production-ready Contract version for an API contract. Separate specification-format version from API version, use immutable releases, and record a content digest. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract repository

Stores reviewable source files and history for API contracts.

Also known as
Schema repository, API spec repository, Contract repo
AI prompt
Create a production-ready Contract repository for an API contract. Define directory layout, ownership, validation commands, release tags, and dependency update rules. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

API catalog entry

Makes a contract discoverable with ownership, lifecycle, documentation, and runtime links.

Also known as
Service catalog record, API registry entry, Developer portal listing
AI prompt
Create a production-ready API catalog entry for an API contract. Include purpose, owner, maturity, environments, current contract version, support channel, and dependencies. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract dependency

Pins or constrains one contract's reference to another shared schema or service contract.

Also known as
Schema dependency, Contract import, API contract dependency
AI prompt
Create a production-ready Contract dependency for an API contract. Use immutable references or explicit ranges, lock resolved versions, detect cycles, and automate upgrades. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI description

OpenAPI description

Describes an HTTP API in a language-agnostic JSON or YAML document.

Also known as
OAD, OpenAPI document, OAS document
AI prompt
Create a production-ready OpenAPI description for an API contract. Include at least paths, components, or webhooks and use OpenAPI 3.1.1 semantics consistently. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Info Object

Supplies human-facing identity and metadata for an OpenAPI description.

Also known as
API info, OpenAPI metadata, Info Object
AI prompt
Create a production-ready OpenAPI Info Object for an API contract. Provide a stable title, API version, concise description, and appropriate contact, license, and terms links. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Server Object

Declares a target server URL and its meaning for API calls.

Also known as
Server URL, OAS server, API environment server
AI prompt
Create a production-ready OpenAPI Server Object for an API contract. Use an HTTPS URL or template, describe the environment, and avoid embedding secrets or unstable hostnames. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Server Variable

Defines an allowed substitution inside a templated OpenAPI server URL.

Also known as
Server template variable, Environment variable, OAS server parameter
AI prompt
Create a production-ready OpenAPI Server Variable for an API contract. Define a default, optional enum, and description for every variable appearing in the server template. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Paths Object

Maps relative HTTP paths to their path-item contracts.

Also known as
OAS paths, Endpoint map, OpenAPI routes
AI prompt
Create a production-ready OpenAPI Paths Object for an API contract. Use leading-slash paths, avoid ambiguous templates, and keep shared path semantics consistent. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Path Item Object

Groups the operations and shared parameters available at one HTTP path.

Also known as
Path Item, Endpoint contract, Route item
AI prompt
Create a production-ready OpenAPI Path Item Object for an API contract. Define path-level parameters once and ensure every template expression has a required path parameter. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Operation Object

Describes one HTTP operation including inputs, responses, security, and documentation.

Also known as
API operation, OAS operation, Endpoint operation
AI prompt
Create a production-ready OpenAPI Operation Object for an API contract. Include a summary, stable operationId, parameters, responses, tags, and security or explicitly inherited security. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI operationId

Assigns a unique, tool-friendly identifier to an API operation.

Also known as
Operation identifier, SDK method name, OAS operationId
AI prompt
Create a production-ready OpenAPI operationId for an API contract. Use a unique programming-language-friendly value and treat renames as generated-client compatibility changes. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Parameter Object

Defines a path, query, header, or cookie input outside the request body.

Also known as
OAS parameter, Operation parameter, API parameter contract
AI prompt
Create a production-ready OpenAPI Parameter Object for an API contract. Specify location, requiredness, schema or content, style, explode behavior, and examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI path parameter

Contracts a required value substituted into a templated URL path.

Also known as
Route parameter, Path variable, URI template parameter
AI prompt
Create a production-ready OpenAPI path parameter for an API contract. Mark it required, match the template name exactly, and define format, constraints, and an example. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI query parameter

Contracts an optional or required value serialized in the query string.

Also known as
Query string parameter, URL query contract, Filter parameter
AI prompt
Create a production-ready OpenAPI query parameter for an API contract. Define schema, defaults, repetition or array serialization, empty-value behavior, and examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI header parameter

Contracts an operation-specific HTTP request header.

Also known as
Request header contract, Custom header parameter, OAS header input
AI prompt
Create a production-ready OpenAPI header parameter for an API contract. Document case-insensitive semantics, schema, requiredness, and avoid redefining standard headers inaccurately. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Request Body Object

Defines body content accepted by an operation across one or more media types.

Also known as
Request payload contract, Body schema, OAS requestBody
AI prompt
Create a production-ready OpenAPI Request Body Object for an API contract. Set requiredness, media types, schemas, encoding where needed, and representative valid examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Media Type Object

Binds a media type to its schema, examples, and encoding rules.

Also known as
Content contract, OAS content entry, Media type schema
AI prompt
Create a production-ready OpenAPI Media Type Object for an API contract. Define the exact media type, schema, realistic examples, and per-property encoding for multipart or form data. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Encoding Object

Controls serialization of individual properties in multipart or form request bodies.

Also known as
Property encoding, Multipart encoding, OAS encoding
AI prompt
Create a production-ready OpenAPI Encoding Object for an API contract. Declare part content type, headers, style, and explode rules only where the selected media type supports them. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Response Object

Describes headers, content, and links returned for one response condition.

Also known as
API response contract, OAS response, Response definition
AI prompt
Create a production-ready OpenAPI Response Object for an API contract. Provide a meaningful description, headers, all supported media types, schemas, examples, and links. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Responses Object

Maps status codes, ranges, and a default case to response definitions.

Also known as
Response map, Status response contract, OAS responses
AI prompt
Create a production-ready OpenAPI Responses Object for an API contract. Document all intentional success and error outcomes and use default only for genuinely shared unexpected responses. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Header Object

Defines the schema and serialization of a response header.

Also known as
Response header contract, OAS header, Header definition
AI prompt
Create a production-ready OpenAPI Header Object for an API contract. Define schema, description, and examples without repeating the header name inside the object. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Callback Object

Describes provider-initiated HTTP requests whose target URL is derived at runtime.

Also known as
API callback contract, Out-of-band callback, OAS callback
AI prompt
Create a production-ready OpenAPI Callback Object for an API contract. Define the runtime expression, callback operations, authentication, responses, retries, and duplicate handling. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Webhook Object

Describes incoming provider-supported requests that are not tied to one initiating operation.

Also known as
OAS webhook, Incoming event endpoint, Webhook contract
AI prompt
Create a production-ready OpenAPI Webhook Object for an API contract. Define event payloads, signatures, acknowledgement responses, replay behavior, and versioning. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Components Object

Holds reusable schemas, parameters, responses, security schemes, and other contract parts.

Also known as
OAS components, Reusable definitions, Component registry
AI prompt
Create a production-ready OpenAPI Components Object for an API contract. Name reusable components clearly, avoid premature reuse, and keep references acyclic and resolvable. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Reference Object

Points to a reusable component or an external description fragment.

Also known as
$ref, OAS reference, Component reference
AI prompt
Create a production-ready OpenAPI Reference Object for an API contract. Use valid URI references, choose stable external locations, define sibling behavior intentionally, and test resolution. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Tag Object

Groups related operations and provides shared documentation for that group.

Also known as
Operation tag, API documentation group, OAS tag
AI prompt
Create a production-ready OpenAPI Tag Object for an API contract. Use a small stable taxonomy, describe each tag, and ensure operation tags have matching top-level definitions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI External Documentation Object

Links a contract element to authoritative documentation outside the description.

Also known as
externalDocs, API guide link, External reference
AI prompt
Create a production-ready OpenAPI External Documentation Object for an API contract. Link to stable, access-appropriate content and explain what the external document adds. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Security Scheme Object

Defines how an API authenticates requests, such as API keys, HTTP auth, OAuth 2.0, or OpenID Connect.

Also known as
Auth scheme contract, OAS security scheme, API authentication definition
AI prompt
Create a production-ready OpenAPI Security Scheme Object for an API contract. Choose the correct scheme type and flow, declare scopes and URLs accurately, and never include real secrets. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Security Requirement Object

Applies one alternative or combined set of security schemes to an API or operation.

Also known as
Operation security, Auth requirement, OAS security requirement
AI prompt
Create a production-ready OpenAPI Security Requirement Object for an API contract. Model alternatives as separate requirement objects, combined schemes together, and deliberate anonymous access with an empty requirement. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Specification Extension

Adds vendor-specific metadata through an x- prefixed field.

Also known as
Vendor extension, x-extension, Custom OpenAPI field
AI prompt
Create a production-ready OpenAPI Specification Extension for an API contract. Namespace the extension, document its schema and consumers, avoid replacing standard fields, and lint its allowed locations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema data modeling

JSON Schema

Describes and validates the structure, constraints, and annotations of JSON-compatible data.

Also known as
JSON data schema, Validation schema, Draft 2020-12 schema
AI prompt
Create a production-ready JSON Schema for an API contract. Declare the dialect and use Core, Applicator, and Validation keywords according to Draft 2020-12. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema dialect

Selects the meta-schema and vocabularies that define keyword semantics.

Also known as
Schema dialect, $schema URI, JSON Schema version
AI prompt
Create a production-ready JSON Schema dialect for an API contract. Use an absolute supported meta-schema URI and validate tooling support before publishing. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema meta-schema

A schema that describes which keywords and shapes are valid in another schema.

Also known as
Metaschema, Schema for schemas, Validation meta-schema
AI prompt
Create a production-ready JSON Schema meta-schema for an API contract. Reference or compose the intended vocabularies and distinguish schema syntax validation from instance validation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema identifier

Assigns a canonical base URI to a schema resource with the $id keyword.

Also known as
$id, Schema URI, Canonical schema ID
AI prompt
Create a production-ready JSON Schema identifier for an API contract. Use an immutable or version-aware absolute URI and preserve correct base-URI resolution in bundled artifacts. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema anchor

Gives a human-readable fragment name to a schema location for referencing.

Also known as
$anchor, Named schema fragment, Schema anchor
AI prompt
Create a production-ready JSON Schema anchor for an API contract. Choose a unique plain-name anchor and preserve it when reorganizing internal schema structure. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema vocabulary

Declares a coherent set of keywords and whether implementations must understand them.

Also known as
$vocabulary, Keyword vocabulary, Schema extension vocabulary
AI prompt
Create a production-ready JSON Schema vocabulary for an API contract. Declare vocabulary URIs in a meta-schema and mark required support deliberately for interoperability. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Boolean JSON Schema

Accepts every instance with true or rejects every instance with false.

Also known as
True schema, False schema, Boolean schema
AI prompt
Create a production-ready Boolean JSON Schema for an API contract. Use boolean schemas where unconditional acceptance or rejection is clearer than an empty or impossible object schema. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Object schema

Defines named properties and structural rules for a JSON object.

Also known as
JSON object contract, Record schema, Object type schema
AI prompt
Create a production-ready Object schema for an API contract. Specify properties, required names, unknown-field policy, constraints, and realistic examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Property schema

Applies a subschema to one named property of an object.

Also known as
Field schema, Object property contract, JSON field definition
AI prompt
Create a production-ready Property schema for an API contract. Define semantic meaning, type, constraints, nullability, read/write behavior, and examples for the field. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Required properties

Lists object property names that must be present in a valid instance.

Also known as
required keyword, Mandatory fields, Required members
AI prompt
Create a production-ready Required properties for an API contract. Require only semantically mandatory fields and distinguish absence from null and empty values. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

additionalProperties

Controls schemas for object properties not explicitly named by properties or patternProperties.

Also known as
Unknown property rule, Open object schema, Map value schema
AI prompt
Create a production-ready additionalProperties for an API contract. Choose closed, open, or typed-map behavior intentionally and assess forward-compatibility consequences. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

unevaluatedProperties

Constrains object properties left unevaluated after composed subschemas run.

Also known as
Unevaluated field rule, Composed closed schema, JSON Schema unevaluatedProperties
AI prompt
Create a production-ready unevaluatedProperties for an API contract. Use it with composition only when validator support and annotation collection behavior are understood. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

patternProperties

Applies schemas to object property names matched by regular expressions.

Also known as
Dynamic key schema, Patterned fields, Regex properties
AI prompt
Create a production-ready patternProperties for an API contract. Anchor patterns where appropriate, prevent overlaps, and combine with additionalProperties deliberately. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

propertyNames schema

Validates every property name in an object independently of its value.

Also known as
Key name validation, Object key schema, propertyNames
AI prompt
Create a production-ready propertyNames schema for an API contract. Use a portable regular expression and explain casing, reserved prefixes, and normalization expectations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

dependentRequired

Requires additional properties when a triggering property is present.

Also known as
Property dependency, Conditional required fields, dependentRequired keyword
AI prompt
Create a production-ready dependentRequired for an API contract. List only presence dependencies and use dependentSchemas when the relationship needs richer validation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

dependentSchemas

Applies an entire subschema when a triggering property is present.

Also known as
Conditional object schema, Schema dependency, dependentSchemas keyword
AI prompt
Create a production-ready dependentSchemas for an API contract. Keep the trigger clear, avoid contradictory adjacent constraints, and include passing and failing examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Array schema

Defines constraints and a shared item schema for a JSON array.

Also known as
List schema, Collection payload schema, Array contract
AI prompt
Create a production-ready Array schema for an API contract. Specify item schema, minimum and maximum size, uniqueness semantics, ordering meaning, and examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Tuple schema

Defines position-specific array items with prefixItems and optional trailing items.

Also known as
Positional array schema, prefixItems, Tuple contract
AI prompt
Create a production-ready Tuple schema for an API contract. Use prefixItems for fixed positions and decide whether trailing items are allowed by the items keyword. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

contains constraint

Requires an array to include items matching a subschema, optionally within minimum and maximum counts.

Also known as
Array membership rule, contains keyword, minContains
AI prompt
Create a production-ready contains constraint for an API contract. Define the matching subschema and minContains or maxContains while documenting duplicate and uniqueness behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

uniqueItems constraint

Requires all array values to be structurally unique.

Also known as
Unique array values, Set-like array, uniqueItems keyword
AI prompt
Create a production-ready uniqueItems constraint for an API contract. Use only when JSON value equality matches the domain's identity semantics and consider validator cost for large arrays. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Primitive type schema

Constrains a value to string, number, integer, boolean, or null.

Also known as
Scalar schema, JSON primitive contract, Type keyword
AI prompt
Create a production-ready Primitive type schema for an API contract. Choose the narrowest semantic type and define constraints rather than relying on coercion. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Numeric constraints

Bounds and quantizes number or integer values with minimum, maximum, and multipleOf.

Also known as
Number validation, Range constraint, multipleOf
AI prompt
Create a production-ready Numeric constraints for an API contract. Choose inclusive or exclusive bounds intentionally and account for decimal precision and representation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

String constraints

Bounds string length and content with minLength, maxLength, and pattern.

Also known as
Text validation, Regex constraint, String length rules
AI prompt
Create a production-ready String constraints for an API contract. Use Unicode-aware length assumptions, portable regular expressions, and examples near each boundary. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Format annotation

Annotates a string with a semantic format such as date-time, email, URI, or UUID.

Also known as
format keyword, Semantic string format, JSON Schema format
AI prompt
Create a production-ready Format annotation for an API contract. Document whether format is annotation-only or asserted by the selected validator and test that policy. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Enum schema

Restricts a value to one of a finite set of JSON values.

Also known as
Enumerated values, Closed value set, enum keyword
AI prompt
Create a production-ready Enum schema for an API contract. Use stable semantic values, describe each one, plan for unknown future values, and test consumer behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Const schema

Requires a value to equal one exact JSON value.

Also known as
Constant value schema, const keyword, Literal discriminator
AI prompt
Create a production-ready Const schema for an API contract. Use const for fixed tags and discriminators, with compatible composition and a representative example. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Nullable type union

Allows null alongside one or more non-null JSON Schema types.

Also known as
Nullable schema, Null union, Optional null value
AI prompt
Create a production-ready Nullable type union for an API contract. Model null with a type union or composition, distinguish it from absence, and avoid obsolete nullable flags. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

allOf composition

Requires an instance to satisfy every listed subschema.

Also known as
Schema intersection, allOf, Combined constraints
AI prompt
Create a production-ready allOf composition for an API contract. Compose compatible constraints, avoid inheritance assumptions, and verify required and unknown-property behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

anyOf composition

Requires an instance to satisfy at least one listed subschema.

Also known as
Schema alternatives, anyOf, Non-exclusive union
AI prompt
Create a production-ready anyOf composition for an API contract. Make overlapping alternatives intentional and provide examples for single and multiple matches. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

oneOf composition

Requires an instance to satisfy exactly one listed subschema.

Also known as
Exclusive schema union, oneOf, Tagged union
AI prompt
Create a production-ready oneOf composition for an API contract. Prefer explicit discriminators or mutually exclusive constraints and test ambiguous and no-match instances. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

not schema

Rejects an instance when it validates against a specified subschema.

Also known as
Negative schema, Exclusion constraint, not keyword
AI prompt
Create a production-ready not schema for an API contract. Keep negative rules understandable, add explicit failing examples, and avoid opaque nested negation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Conditional schema

Applies then or else constraints based on whether an if schema matches.

Also known as
if then else schema, Conditional validation, Branching schema
AI prompt
Create a production-ready Conditional schema for an API contract. Keep the predicate focused, define both branches when needed, and include examples for every path. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

JSON Schema reference

Applies a schema resource identified by a URI reference through $ref.

Also known as
$ref, Schema reuse, Referenced schema
AI prompt
Create a production-ready JSON Schema reference for an API contract. Use stable resolvable identifiers, validate reference graphs, and preserve base URIs during bundling. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Dynamic JSON Schema reference

Resolves $dynamicRef through matching dynamic anchors in an evaluation scope.

Also known as
$dynamicRef, $dynamicAnchor, Extensible recursive schema
AI prompt
Create a production-ready Dynamic JSON Schema reference for an API contract. Use only for genuinely extensible recursive models and verify support and resolution across all validators. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

readOnly and writeOnly annotations

Marks properties intended only for responses or only for requests.

Also known as
Directional fields, Input-output annotation, readOnly/writeOnly
AI prompt
Create a production-ready readOnly and writeOnly annotations for an API contract. Treat annotations consistently in generators, validation, examples, and required-field handling for each direction. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Schema metadata annotations

Adds title, description, default, examples, and deprecation information without directly asserting validity.

Also known as
Schema annotations, Model documentation, JSON Schema metadata
AI prompt
Create a production-ready Schema metadata annotations for an API contract. Write semantic descriptions, realistic examples, and defaults that match actual provider behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Encoded content schema

Annotates a string's encoding, media type, and decoded content schema.

Also known as
contentEncoding, contentMediaType, contentSchema
AI prompt
Create a production-ready Encoded content schema for an API contract. Declare encoding and media type, validate decoded content where tooling supports it, and set safe size limits. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Event & message contracts

AsyncAPI document

Describes a message-driven API in a protocol-agnostic, machine-readable document.

Also known as
AsyncAPI description, Event API contract, Messaging specification
AI prompt
Create a production-ready AsyncAPI document for an API contract. Describe channels, messages, operations, servers, bindings, and reusable components using AsyncAPI 3.1 semantics. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI Server Object

Defines a message broker or endpoint and the protocol used to connect.

Also known as
Broker contract, Messaging server, AsyncAPI server
AI prompt
Create a production-ready AsyncAPI Server Object for an API contract. Specify host, protocol and version, security, variables, bindings, and environment purpose. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI Channel Object

Defines an addressable message destination and the messages available on it.

Also known as
Topic contract, Queue contract, Messaging channel
AI prompt
Create a production-ready AsyncAPI Channel Object for an API contract. Define address, parameters, allowed messages, servers, bindings, retention assumptions, and ownership. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI Operation Object

Describes an application action that sends or receives messages on a channel.

Also known as
Message operation, Publish-subscribe operation, AsyncAPI operation
AI prompt
Create a production-ready AsyncAPI Operation Object for an API contract. State send or receive action, channel reference, messages, reply behavior, traits, and security expectations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI send operation

Contracts messages an application sends to a channel.

Also known as
Publish operation, Producer contract, Message send contract
AI prompt
Create a production-ready AsyncAPI send operation for an API contract. Identify every possible message, key or partition behavior, headers, ordering, and delivery guarantees. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI receive operation

Contracts messages an application receives from a channel.

Also known as
Subscribe operation, Consumer contract, Message receive contract
AI prompt
Create a production-ready AsyncAPI receive operation for an API contract. Define accepted message variants, acknowledgement, retries, dead-letter behavior, ordering, and idempotency. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI Message Object

Defines a message's headers, payload, identity, traits, bindings, and examples.

Also known as
Event message contract, Async message, Message definition
AI prompt
Create a production-ready AsyncAPI Message Object for an API contract. Provide a stable name, content type, schema format, headers, payload, correlation ID, and examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Message headers schema

Defines transport-independent metadata carried alongside a message payload.

Also known as
Event headers, Message metadata contract, Envelope headers
AI prompt
Create a production-ready Message headers schema for an API contract. Separate routing and observability metadata from business data and define requiredness and limits. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Message payload schema

Defines the business data carried by an event or command message.

Also known as
Event body schema, Message data contract, Payload definition
AI prompt
Create a production-ready Message payload schema for an API contract. Model facts at event time, use stable identifiers, avoid database snapshots, and define privacy classification. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Message correlation ID

Identifies where a request, reply, or related event correlation value is located.

Also known as
Correlation identifier, Trace correlation, AsyncAPI correlationId
AI prompt
Create a production-ready Message correlation ID for an API contract. Define the location expression, generation ownership, uniqueness scope, and propagation behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI Message Trait

Applies reusable message fields such as headers, bindings, or common metadata.

Also known as
Message mixin, Reusable event metadata, AsyncAPI trait
AI prompt
Create a production-ready AsyncAPI Message Trait for an API contract. Use traits for genuinely shared concerns, document merge effects, and prevent conflicting fields. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI protocol binding

Adds protocol-specific details to a server, channel, operation, or message.

Also known as
Kafka binding, MQTT binding, Messaging binding
AI prompt
Create a production-ready AsyncAPI protocol binding for an API contract. Select the matching binding version and define only protocol-specific behavior not covered by the core model. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

AsyncAPI operation reply

Describes reply messages and their destination for a request-reply messaging interaction.

Also known as
Message reply contract, Async request-response, Operation Reply Object
AI prompt
Create a production-ready AsyncAPI operation reply for an API contract. Define reply channel, address, message variants, correlation, timeout, and missing-reply behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

CloudEvents envelope

Wraps event data in interoperable context attributes such as id, source, type, and specversion.

Also known as
CloudEvent, Event envelope, CloudEvents 1.0
AI prompt
Create a production-ready CloudEvents envelope for an API contract. Define required attributes, content type, data schema URI, extension attributes, and structured or binary binding. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Event type versioning

Evolves event semantics through a stable type name and explicit compatibility policy.

Also known as
Event schema version, Message versioning, CloudEvent type version
AI prompt
Create a production-ready Event type versioning for an API contract. Keep the type stable for backward-compatible changes, define when a new type is required, and publish migration guidance. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL & RPC contracts

GraphQL schema

Defines the types, fields, directives, and root operations exposed by a GraphQL service.

Also known as
GraphQL SDL, Type system schema, GraphQL contract
AI prompt
Create a production-ready GraphQL schema for an API contract. Provide SDL with descriptions, stable names, nullability, arguments, directives, and root operation types. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL object type

Defines a named set of fields that a GraphQL service can return.

Also known as
GraphQL type, Output object, Object type definition
AI prompt
Create a production-ready GraphQL object type for an API contract. Define field semantics, nullability, resolver ownership, authorization, and deprecation independently of storage models. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL scalar

Represents an indivisible leaf value, built-in or custom.

Also known as
Scalar type, Custom scalar, GraphQL leaf type
AI prompt
Create a production-ready GraphQL scalar for an API contract. Document input coercion, result serialization, accepted format, invalid values, and specifiedBy URL for custom scalars. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL enum

Defines a finite set of symbolic values usable in inputs and outputs.

Also known as
Enum type, GraphQL enumeration, Symbolic value set
AI prompt
Create a production-ready GraphQL enum for an API contract. Describe every value, use stable names, deprecate before removal, and plan client handling for additions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL input object

Groups named input fields for arguments and mutations.

Also known as
Input type, GraphQL input, Mutation input object
AI prompt
Create a production-ready GraphQL input object for an API contract. Define required fields with non-null, avoid output-type reuse, validate cross-field rules, and support idempotency when needed. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL interface

Defines fields shared by multiple implementing object types.

Also known as
Abstract GraphQL type, Interface type, Shared field contract
AI prompt
Create a production-ready GraphQL interface for an API contract. Keep shared semantics identical across implementations and ensure runtime type resolution is deterministic. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL union

Allows a field to return one of several object types without shared declared fields.

Also known as
Union type, Result union, GraphQL variant
AI prompt
Create a production-ready GraphQL union for an API contract. Choose meaningful member types, define runtime resolution, and show inline-fragment query examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL query root

Exposes read operations as fields on the schema's query operation type.

Also known as
Query type, Read root, GraphQL Query
AI prompt
Create a production-ready GraphQL query root for an API contract. Define clear field names, arguments, nullability, pagination, authorization, caching, and typed errors where appropriate. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL mutation root

Exposes write operations as serially executed top-level mutation fields.

Also known as
Mutation type, Write root, GraphQL Mutation
AI prompt
Create a production-ready GraphQL mutation root for an API contract. Use purpose-built input and payload types, client mutation IDs or idempotency where useful, and explicit business errors. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL subscription root

Exposes long-lived event streams as subscription fields.

Also known as
Subscription type, GraphQL stream, Realtime root
AI prompt
Create a production-ready GraphQL subscription root for an API contract. Define event triggers, filtering, authorization over connection lifetime, ordering, backpressure, and disconnect behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL field argument

Defines a named input value accepted by a field.

Also known as
GraphQL argument, Field parameter, Resolver input
AI prompt
Create a production-ready GraphQL field argument for an API contract. Set a precise input type, nullability and defaults, document semantics, and avoid opaque catch-all arguments. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL list and non-null modifiers

Combines list and non-null wrappers to express container and item presence guarantees.

Also known as
GraphQL nullability, List type, Non-null type
AI prompt
Create a production-ready GraphQL list and non-null modifiers for an API contract. Choose each wrapper intentionally and explain how null, empty lists, and partial field errors behave. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL directive

Attaches standard or custom behavior to schema definitions or executable documents.

Also known as
Schema directive, Custom directive, GraphQL annotation
AI prompt
Create a production-ready GraphQL directive for an API contract. Define locations, repeatability, arguments, execution semantics, tooling support, and behavior for unknown directives. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL deprecation directive

Marks a field or enum value as discouraged while keeping it available to clients.

Also known as
@deprecated, Schema deprecation, GraphQL sunset marker
AI prompt
Create a production-ready GraphQL deprecation directive for an API contract. Give an actionable reason, replacement path, timeline in external policy, and usage monitoring before removal. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

GraphQL introspection

Makes the service's type system queryable through built-in meta-fields and types.

Also known as
Schema introspection, __schema, GraphQL reflection
AI prompt
Create a production-ready GraphQL introspection for an API contract. Define production exposure policy, authorization implications, schema registry alternatives, and tooling expectations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protocol Buffers schema

Defines typed messages, enums, and services in a .proto interface definition.

Also known as
.proto contract, Protobuf IDL, Protocol Buffer definition
AI prompt
Create a production-ready Protocol Buffers schema for an API contract. Declare syntax or edition first, stable packages, imports, options, messages, enums, and services. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf message

Defines a structured wire-format record composed of numbered fields.

Also known as
Proto message, Binary message schema, Message type
AI prompt
Create a production-ready Protobuf message for an API contract. Use stable field numbers, clear types and names, presence deliberately, and reserve removed identifiers. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf field number

Identifies a message field on the binary wire format and must remain stable.

Also known as
Field tag, Proto tag number, Wire field number
AI prompt
Create a production-ready Protobuf field number for an API contract. Assign a unique allowed number, favor low numbers for frequent fields, and never renumber or reuse it. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf field presence

Distinguishes an explicitly set field from its default value where the language supports presence.

Also known as
optional field, Explicit presence, Proto presence
AI prompt
Create a production-ready Protobuf field presence for an API contract. Prefer explicit optional presence when absence is meaningful and document generated-language behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf repeated field

Represents zero or more ordered values of the same field type.

Also known as
Repeated value, Proto list, Repeated message field
AI prompt
Create a production-ready Protobuf repeated field for an API contract. Define ordering and duplicate semantics, expected size, compatibility, and avoid relying on null collections. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf map field

Represents key-value entries with constrained key types and one value type.

Also known as
Proto map, Map field, Dictionary field
AI prompt
Create a production-ready Protobuf map field for an API contract. Define key normalization, limits, ordering non-guarantees, and compatibility with generated-language maps. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf oneof

Allows at most one member of a named group to be set in a message.

Also known as
Oneof field, Proto union, Exclusive message variant
AI prompt
Create a production-ready Protobuf oneof for an API contract. Use unique field numbers, handle unknown variants, and review unsafe changes when moving existing fields into a oneof. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Protobuf reserved fields

Prevents deleted field numbers or names from being reused.

Also known as
reserved statement, Tombstoned proto field, Proto field reservation
AI prompt
Create a production-ready Protobuf reserved fields for an API contract. Reserve every removed number and relevant name, document the removal, and lint against reuse. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

gRPC service definition

Declares remotely callable methods and their request and response message types.

Also known as
RPC service, Proto service, gRPC contract
AI prompt
Create a production-ready gRPC service definition for an API contract. Use cohesive method names, typed messages, package versioning, deadlines, status model, and authorization rules. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Unary gRPC method

Accepts one request message and returns one response message.

Also known as
Unary RPC, Request-response RPC, Single-call gRPC
AI prompt
Create a production-ready Unary gRPC method for an API contract. Define request and response, deadline expectations, idempotency, status codes, metadata, and cancellation behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Server-streaming gRPC method

Accepts one request and returns an ordered stream of response messages.

Also known as
Server stream RPC, Response streaming, gRPC server stream
AI prompt
Create a production-ready Server-streaming gRPC method for an API contract. Define completion, ordering, heartbeats, backpressure, resume behavior, deadlines, and partial failure. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Client-streaming gRPC method

Accepts a stream of request messages and returns one response.

Also known as
Client stream RPC, Upload streaming, gRPC client stream
AI prompt
Create a production-ready Client-streaming gRPC method for an API contract. Define ordering, chunk limits, partial acceptance, cancellation, deadline, and final summary behavior. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Bidirectional-streaming gRPC method

Lets client and server independently exchange ordered message streams.

Also known as
Bidi RPC, Duplex gRPC stream, Two-way streaming
AI prompt
Create a production-ready Bidirectional-streaming gRPC method for an API contract. Define message correlation, independent ordering, flow control, half-close, cancellation, and error semantics. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Evolution & compatibility

Backward compatibility

Allows newer providers or schemas to keep serving existing consumers correctly.

Also known as
Consumer compatibility, Backward-compatible change, Non-breaking evolution
AI prompt
Create a production-ready Backward compatibility for an API contract. Define which syntax, wire, source, and semantic guarantees must remain stable and test representative old consumers. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Forward compatibility

Allows older implementations to tolerate data or messages produced by newer versions.

Also known as
Future compatibility, Forward-compatible reader, Old consumer tolerance
AI prompt
Create a production-ready Forward compatibility for an API contract. Specify unknown-field and unknown-enum behavior, preserved data, and limits to tolerated evolution. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Additive contract change

Adds optional operations, fields, values, or variants without removing existing behavior.

Also known as
Non-breaking addition, Compatible API change, Schema extension
AI prompt
Create a production-ready Additive contract change for an API contract. Classify the addition across request, response, generated source, and exhaustive-consumer behavior before release. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Breaking contract change

Invalidates a previously valid consumer, request, response, wire message, or generated interface.

Also known as
Incompatible API change, Contract break, Breaking schema change
AI prompt
Create a production-ready Breaking contract change for an API contract. Identify affected consumers and compatibility layer, require explicit approval, new versioning, migration, and rollback. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Semantic breaking change

Changes meaning or behavior while the machine-readable shape may remain compatible.

Also known as
Behavioral breaking change, Semantic incompatibility, Silent contract break
AI prompt
Create a production-ready Semantic breaking change for an API contract. Document invariants, ordering, defaults, side effects, and performance expectations that structural diff tools cannot detect. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract diff

Compares two contract versions and classifies additions, removals, and modifications.

Also known as
Schema diff, API specification diff, Interface comparison
AI prompt
Create a production-ready Contract diff for an API contract. Compare resolved artifacts, classify by compatibility policy, suppress only justified noise, and retain the report. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Compatibility policy

Defines which contract changes are permitted for each lifecycle stage and version line.

Also known as
API evolution policy, Breaking-change policy, Schema compatibility mode
AI prompt
Create a production-ready Compatibility policy for an API contract. Specify compatibility dimensions, exceptions, approval, versioning response, enforcement point, and examples. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract deprecation

Marks an operation, field, or value as supported but scheduled for replacement or removal.

Also known as
API deprecation, Schema deprecation, Deprecated contract element
AI prompt
Create a production-ready Contract deprecation for an API contract. Include a replacement, reason, announcement date, usage telemetry, support window, and removal criteria. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract sunset

Defines when a deprecated contract version or element will stop being supported.

Also known as
API retirement, End-of-life contract, Removal deadline
AI prompt
Create a production-ready Contract sunset for an API contract. Publish dates through contract metadata and communication channels, monitor remaining use, and define rollback contingency. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Tolerant reader

Consumes only required fields and safely ignores compatible additions.

Also known as
Robust consumer, Lenient reader, Postel reader pattern
AI prompt
Create a production-ready Tolerant reader for an API contract. Ignore unknown optional data without weakening validation of known fields, required invariants, or security boundaries. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Unknown field policy

Defines whether unrecognized request, response, or message fields are rejected, ignored, or preserved.

Also known as
Extra-field handling, Unknown property behavior, Extension policy
AI prompt
Create a production-ready Unknown field policy for an API contract. Choose behavior per direction and trust boundary, document it, and test nested and extension-field cases. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Enum evolution

Changes an enumerated value set without surprising exhaustive consumers or corrupting wire data.

Also known as
Open enum, Enum compatibility, Value-set evolution
AI prompt
Create a production-ready Enum evolution for an API contract. Define unknown-value handling, generated-client impact, fallback UI, reserved numeric values, and deprecation. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract field lifecycle

Tracks one field through introduction, stability, deprecation, and removal.

Also known as
Property lifecycle, Schema field evolution, Member lifecycle
AI prompt
Create a production-ready Contract field lifecycle for an API contract. Record first version, requiredness changes, replacements, data migration, usage, deprecation, and safe removal proof. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Version negotiation contract

Defines how a consumer selects a supported API or representation version.

Also known as
API version selection, Content negotiation version, Protocol version handshake
AI prompt
Create a production-ready Version negotiation contract for an API contract. Specify selection location, default, supported range, error response, cache behavior, and downgrade rules. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract migration mapping

Maps old operations, fields, values, and errors to their replacements in a new contract.

Also known as
Schema migration map, API upgrade mapping, Contract transformation
AI prompt
Create a production-ready Contract migration mapping for an API contract. Provide before and after examples, transformation rules, lossy cases, sequencing, and validation checks. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Compatibility matrix

Shows which consumer, provider, contract, and transport versions are supported together.

Also known as
Version matrix, Support matrix, Interoperability matrix
AI prompt
Create a production-ready Compatibility matrix for an API contract. Use tested version ranges, lifecycle status, known limitations, and ownership rather than aspirational compatibility. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract changelog

Records human-readable contract changes with compatibility and migration context.

Also known as
API changelog, Schema release notes, Contract history
AI prompt
Create a production-ready Contract changelog for an API contract. Link machine diffs, label compatibility, explain behavior changes, identify affected consumers, and give migration steps. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Consumer impact analysis

Uses dependency and usage evidence to identify consumers affected by a proposed contract change.

Also known as
API impact assessment, Change impact analysis, Downstream analysis
AI prompt
Create a production-ready Consumer impact analysis for an API contract. Combine registry dependencies, telemetry, generated-code versions, contract tests, and owner confirmation before approval. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Validation, testing & delivery

Contract syntax validation

Checks that a contract document parses and conforms to its specification schema.

Also known as
Spec validation, Contract parser check, Structural validation
AI prompt
Create a production-ready Contract syntax validation for an API contract. Pin validator and specification versions, resolve references, surface source locations, and fail on errors. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract semantic validation

Checks cross-reference and meaning rules that syntax validation alone cannot prove.

Also known as
Semantic lint, Cross-field validation, Contract consistency check
AI prompt
Create a production-ready Contract semantic validation for an API contract. Check uniqueness, reference targets, path parameters, security references, response coverage, and organization invariants. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Request contract validation

Validates incoming parameters, headers, and bodies against the published operation contract.

Also known as
Input validation, API request validator, Schema request enforcement
AI prompt
Create a production-ready Request contract validation for an API contract. Validate after safe decoding, return stable problem details, cap resource use, and avoid exposing sensitive values. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Response contract validation

Checks provider status, headers, and body against the response contract.

Also known as
Output validation, API response validator, Schema response enforcement
AI prompt
Create a production-ready Response contract validation for an API contract. Validate representative and error responses in tests, sample safely in production, and alert without leaking data. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Message contract validation

Checks event headers and payloads before publish or consumption.

Also known as
Event validation, Payload validator, Messaging schema enforcement
AI prompt
Create a production-ready Message contract validation for an API contract. Define validation point, schema version lookup, quarantine or dead-letter handling, observability, and replay rules. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract example validation

Verifies that documented examples satisfy their associated schemas and media types.

Also known as
Example linting, Sample payload validation, Documentation example test
AI prompt
Create a production-ready Contract example validation for an API contract. Validate every request, response, message, and parameter example after reference resolution in CI. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract linting

Applies style, quality, and governance rules to a contract document.

Also known as
API lint, Schema lint, Specification linting
AI prompt
Create a production-ready Contract linting for an API contract. Separate errors from advice, include source locations and remediation, pin the ruleset, and support justified exceptions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract style-guide ruleset

Turns naming and design conventions into reusable automated rules.

Also known as
API ruleset, Governance rules, Contract conventions
AI prompt
Create a production-ready Contract style-guide ruleset for an API contract. Encode objective rules, document rationale and examples, version the ruleset, and provide a controlled waiver process. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract test

Verifies an implementation's observable interaction against an explicit API contract.

Also known as
API contract test, Interface test, Schema conformance test
AI prompt
Create a production-ready Contract test for an API contract. Test requests and responses at the real boundary with deterministic fixtures and clear mismatch reports. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Consumer contract test

Generates a contract from the interactions one consumer expects from a provider.

Also known as
Consumer test, Pact consumer test, CDC test
AI prompt
Create a production-ready Consumer contract test for an API contract. Exercise the real client mapping, match flexibly on irrelevant values, and publish with consumer version metadata. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Provider verification

Replays published consumer interactions against a provider implementation.

Also known as
Pact verification, Provider contract test, Contract conformance verification
AI prompt
Create a production-ready Provider verification for an API contract. Run against a local provider in CI, configure isolated provider states, publish results, and fail on mismatches. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract-test provider state

Defines the provider data and conditions required for one consumer interaction.

Also known as
Pact provider state, Test precondition, Contract fixture state
AI prompt
Create a production-ready Contract-test provider state for an API contract. Create minimal idempotent setup and teardown through test-only controls without coupling the consumer to implementation details. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Pact contract

Serializes consumer-provider interactions and matching rules into a versioned contract artifact.

Also known as
Pact file, Consumer pact, Interaction contract
AI prompt
Create a production-ready Pact contract for an API contract. Include participant names, specification version, interactions, matching rules, generators, and stable descriptions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract broker

Stores contracts, participant versions, verification results, and deployment compatibility evidence.

Also known as
Pact Broker, Contract registry, Verification broker
AI prompt
Create a production-ready Contract broker for an API contract. Publish immutable participant versions, branch and environment metadata, verification results, retention, and access controls. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Can-I-Deploy check

Determines whether known contract verification results make a participant version safe to deploy.

Also known as
Deployment compatibility check, Pact deployment gate, Contract release check
AI prompt
Create a production-ready Can-I-Deploy check for an API contract. Query the broker with exact version and target environment before deployment and record deployments afterward. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract mock server

Serves deterministic responses generated from a contract before or without the real provider.

Also known as
API mock, Specification mock, Mock provider
AI prompt
Create a production-ready Contract mock server for an API contract. Select examples or generated values predictably, validate requests, simulate errors and latency, and label mock limitations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract stub server

Provides scenario-specific canned behavior for development and integration tests.

Also known as
API stub, Service virtualisation, Fake provider
AI prompt
Create a production-ready Contract stub server for an API contract. Define state transitions and faults explicitly, reset between tests, and verify stubs remain compatible with the contract. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Generated client SDK

Produces typed client models and calls from a machine-readable contract.

Also known as
API client generation, Generated consumer, Contract-generated SDK
AI prompt
Create a production-ready Generated client SDK for an API contract. Pin generator and templates, stabilize names, isolate custom code, compile and test output, and publish with provenance. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Generated server stub

Produces provider interfaces, route scaffolding, or handlers from a contract.

Also known as
Server code generation, Generated provider, API skeleton
AI prompt
Create a production-ready Generated server stub for an API contract. Generate into a controlled directory, separate implementation code, regenerate reproducibly, and test unimplemented operations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract code-generation template

Customizes generated code layout, names, annotations, and runtime integrations.

Also known as
Generator template, SDK template, Codegen customization
AI prompt
Create a production-ready Contract code-generation template for an API contract. Version templates with the generator, test golden output across representative schemas, and document extension points. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract documentation generation

Renders reference documentation and examples from a machine-readable contract.

Also known as
API docs generation, Schema documentation, Developer portal rendering
AI prompt
Create a production-ready Contract documentation generation for an API contract. Preserve descriptions and examples, resolve references safely, sanitize rich text, and link guides for behavior beyond the schema. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract bundling

Packages a multi-file contract and its referenced schemas into one compound artifact.

Also known as
Schema bundle, Specification bundle, Contract packaging
AI prompt
Create a production-ready Contract bundling for an API contract. Preserve identifiers and reference semantics, detect cycles, pin remote inputs, and validate the bundled result. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract dereferencing

Replaces references with their resolved target content for tools that require an expanded document.

Also known as
Reference expansion, $ref resolution, Flattened specification
AI prompt
Create a production-ready Contract dereferencing for an API contract. Preserve recursion safely, avoid identity changes, cap expansion size, and validate semantic equivalence. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract publishing

Releases an immutable validated contract artifact for consumers and tools.

Also known as
Schema publishing, API spec release, Contract distribution
AI prompt
Create a production-ready Contract publishing for an API contract. Publish only after review and gates, attach version and provenance, prevent overwrite, and update discoverability metadata. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Schema registry

Stores versioned schemas and enforces discovery, compatibility, and access policies.

Also known as
Contract registry, Event schema registry, API schema store
AI prompt
Create a production-ready Schema registry for an API contract. Define subject naming, immutable versions, compatibility mode, authentication, references, retention, and client caching. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Breaking-change gate

Blocks a contract change when automated compatibility checks find disallowed differences.

Also known as
Compatibility gate, Schema diff gate, API change guard
AI prompt
Create a production-ready Breaking-change gate for an API contract. Select an authoritative baseline, resolve both artifacts identically, classify findings, and require explicit exception approval. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract drift detection

Finds differences between the published contract and actual implementation or traffic.

Also known as
API drift, Schema drift, Spec implementation mismatch
AI prompt
Create a production-ready Contract drift detection for an API contract. Compare safely sampled boundary behavior, exclude sensitive data, distinguish implementation bugs from stale specs, and assign owners. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Contract coverage

Measures which contract operations, statuses, variants, and constraints have executable verification.

Also known as
API contract coverage, Schema test coverage, Interaction coverage
AI prompt
Create a production-ready Contract coverage for an API contract. Report meaningful behavior dimensions rather than line counts and link every gap to a test or accepted risk. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Workflows & overlays

Arazzo description

Describes multi-step workflows that span operations from OpenAPI, AsyncAPI, or other Arazzo sources.

Also known as
Arazzo document, API workflow description, Workflow contract
AI prompt
Create a production-ready Arazzo description for an API contract. Declare source descriptions, workflows, components, inputs, steps, outputs, and recovery actions using Arazzo 1.1. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo Source Description Object

Names and locates an OpenAPI, AsyncAPI, or Arazzo document used by workflows.

Also known as
Workflow source, API source description, Arazzo source
AI prompt
Create a production-ready Arazzo Source Description Object for an API contract. Provide a unique name, stable URL, correct type, access policy, and validation of referenced operations. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo Workflow Object

Defines an ordered objective with inputs, steps, outputs, parameters, and shared actions.

Also known as
API workflow, Multi-step contract, Arazzo workflow
AI prompt
Create a production-ready Arazzo Workflow Object for an API contract. Use a unique workflowId, typed inputs, ordered steps, output expressions, parameters, and success and failure actions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo Step Object

Invokes an API operation or another workflow with parameters, request data, outputs, and criteria.

Also known as
Workflow step, API journey step, Arazzo operation step
AI prompt
Create a production-ready Arazzo Step Object for an API contract. Give a unique stepId, one operation or workflow target, mapped parameters, request body, success criteria, outputs, and failure handling. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo runtime expression

Selects request, response, component, step, or source values for use across workflow steps.

Also known as
Workflow expression, Arazzo selector, Dynamic workflow value
AI prompt
Create a production-ready Arazzo runtime expression for an API contract. Use valid expressions, preserve value types, handle missing values, and test against concrete workflow responses. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo success criteria

Defines assertions that determine whether a workflow step succeeded.

Also known as
Step assertion, Workflow success condition, Arazzo criterion
AI prompt
Create a production-ready Arazzo success criteria for an API contract. Choose the correct context and condition type, include all required outcomes, and keep assertions deterministic. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo success action

Ends or redirects workflow execution when success criteria match.

Also known as
Workflow success branch, Arazzo successAction, Success transition
AI prompt
Create a production-ready Arazzo success action for an API contract. Name the action, choose end or goto semantics, define criteria, and avoid ambiguous multiple matching actions. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Arazzo failure action

Ends, retries, or redirects workflow execution after a step failure.

Also known as
Workflow recovery action, Arazzo failureAction, Failure transition
AI prompt
Create a production-ready Arazzo failure action for an API contract. Choose end, retry, or goto, set retry limits and delays, avoid loops, and preserve diagnostic outputs. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

OpenAPI Overlay

Applies a separate ordered set of repeatable changes to an OpenAPI description.

Also known as
Overlay document, OpenAPI augmentation, OAS transform
AI prompt
Create a production-ready OpenAPI Overlay for an API contract. Declare Overlay 1.1, metadata, optional extends target, ordered actions, and validate the transformed result. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Overlay target expression

Selects one or more OpenAPI document nodes using an RFC 9535 JSONPath expression.

Also known as
Overlay JSONPath, Action target, Contract selection expression
AI prompt
Create a production-ready Overlay target expression for an API contract. Use portable JSONPath, test zero, one, and many matches, and avoid fragile array indexes. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.

Overlay action

Updates, copies, or removes selected OpenAPI nodes in a defined sequence.

Also known as
Overlay update, Overlay remove, Overlay copy
AI prompt
Create a production-ready Overlay action for an API contract. Choose one modifier, ensure compatible target node types, order actions deliberately, and diff the final document. Include a concrete machine-readable example, validation rules, compatibility considerations, failure cases, and automated checks so consumers and providers can implement the same behavior independently.