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

API Evangelist Contracts API

An agreement between API producer and consumers.

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

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

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://api.apievangelist.com/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

API Evangelist Contracts API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (api_key).

Paths & Operations 1

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

Contracts 1

An agreement between API producer and consumers.

GET
/contracts
API Evangelist Standards Get Contracts
getContracts → 200400401403404429500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Problem (5 properties), Meta (5 properties), Contract (3 properties), Response (2 properties). Each schema is shown below with its type and property counts.

Meta
object
5 properties 3 required
Contracts
array
Listing of repositories pulled for and organization.
Contract
object
A single repository.
3 properties
Response
object
An JSON API object with metadata, data, and links.
2 properties 2 required
Problem
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posts-contracts-api-openapi.yml Raw ↑