---
title: OpenAPI
description: OpenAPI is the industry-standard, machine-readable way to describe a REST API — its endpoints, parameters, request and response shapes and authentication — in one specification file. TracePass publishes an OpenAPI 3.1 spec so any tool or AI agent can discover and call the passport API without bespoke documentation.
canonical: "https://www.tracepass.eu/glossary/openapi"
locale: en
source: "https://www.tracepass.eu/glossary/openapi"
---

# OpenAPI

> OpenAPI is the industry-standard, machine-readable way to describe a REST API — its endpoints, parameters, request and response shapes and authentication — in one specification file. TracePass publishes an OpenAPI 3.1 spec so any tool or AI agent can discover and call the passport API without bespoke documentation.

OpenAPI is the industry-standard, machine-readable way to describe a REST API — its endpoints, parameters, request and response shapes and authentication — in one specification file. TracePass publishes an OpenAPI 3.1 spec so any tool or AI agent can discover and call the passport API without bespoke documentation.

An OpenAPI document is a single, structured contract describing exactly what a REST API offers: every path, the methods it accepts, the fields of each request and response, the status codes and the auth scheme. Because the format is standardised, tools like Postman, Insomnia and openapi-generator can import it to produce client SDKs, mock servers and interactive docs automatically.

TracePass's OpenAPI 3.1 spec is the public, downloadable contract behind the API and docs — and increasingly the thing AI agents read first to understand how to operate the passport workflow before calling it. It is the REST counterpart to the MCP server: same capabilities, exposed as a conventional HTTP API.

## FAQ

### What does OpenAPI 3.1 add over earlier versions?

OpenAPI 3.1 aligns the spec fully with JSON Schema, so request and response models can be described with the same vocabulary used elsewhere in modern tooling. That makes the contract cleaner to validate and easier for code generators and AI agents to consume.

### Can I import the TracePass OpenAPI spec into Postman?

Yes. The spec is published as a downloadable OpenAPI 3.1 file (YAML and JSON) and imports directly into Postman, Insomnia, Bruno or openapi-generator to scaffold requests, client code and tests against the passport API.

## Related terms

- [MCP (Model Context Protocol)](https://www.tracepass.eu/glossary/mcp)
- [JSON-LD](https://www.tracepass.eu/glossary/json-ld)
- [Digital Product Passport (DPP)](https://www.tracepass.eu/glossary/digital-product-passport)
- [Confidence score](https://www.tracepass.eu/glossary/confidence-score)
