Standardization · Example Payload

Standardization Openapi Standard Example

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, allowing both humans and computers to discover and understand the capabilities of a service without access to source code, additional documentation, or inspection of network traffic.

API DesignRESTOpenAPIMachine-ReadableDocumentationCode Generation

Standardization Openapi Standard Example is an example object payload from Standardization, with 19 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idtitleabbreviationversionstatustypedomaindescriptionpublisherpublished_dateurlspecification_urlgithub_urlsupersedesprevious_versionsrelated_standardsknown_implementationsconformance_levelstags

Example Payload

standardization-openapi-standard-example.json Raw ↑ 
{
  "id": "OAS-3.1.0",
  "title": "OpenAPI Specification",
  "abbreviation": "OAS",
  "version": "3.1.0",
  "status": "published",
  "type": "specification",
  "domain": "API Design",
  "description": "The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, allowing both humans and computers to discover and understand the capabilities of a service without access to source code, additional documentation, or inspection of network traffic.",
  "publisher": {
    "name": "OpenAPI Initiative",
    "abbreviation": "OAI",
    "url": "https://www.openapis.org/"
  },
  "published_date": "2021-02-15",
  "url": "https://www.openapis.org/",
  "specification_url": "https://spec.openapis.org/oas/v3.1.0",
  "github_url": "https://github.com/OAI/OpenAPI-Specification",
  "supersedes": "OAS-3.0.3",
  "previous_versions": [
    { "version": "3.0.3", "date": "2020-02-20", "url": "https://spec.openapis.org/oas/v3.0.3" },
    { "version": "2.0", "date": "2014-09-08", "url": "https://swagger.io/specification/v2/" }
  ],
  "related_standards": ["JSON-Schema-2020-12", "JSON-Reference", "CommonMark"],
  "known_implementations": [
    { "name": "swagger-editor", "language": "JavaScript", "url": "https://github.com/swagger-api/swagger-editor" },
    { "name": "Redoc", "language": "TypeScript", "url": "https://github.com/Redocly/redoc" },
    { "name": "FastAPI", "language": "Python", "url": "https://fastapi.tiangolo.com/" },
    { "name": "oapi-codegen", "language": "Go", "url": "https://github.com/oapi-codegen/oapi-codegen" },
    { "name": "Spectral", "language": "TypeScript", "url": "https://github.com/stoplightio/spectral" }
  ],
  "conformance_levels": ["MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL"],
  "tags": ["API Design", "REST", "OpenAPI", "Machine-Readable", "Documentation", "Code Generation"]
}