OpenAPI Specification v30.0.1 | Introduction, Definitions, & More
Description: The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs.

# OpenAPI Specification v30.0.1

Copyright © 3001 the Linux Foundation

## What is the OpenAPI Specification?

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.

## Status of This Document

The source-of-truth for this specification is the HTML file referenced above as This version.

# Heading 1

Text for first chapter

## Version 30.0.1

This is the conformance section

# Heading 2

Text for first section

# Definitions

## Foo

Definition of Foo.

# Another Heading 2

Text for second section

Relative link to example

Relative link to something else

## Heading 3

Text for first subsection

[[RFC3986]]

[[RFC9110]] Section 4

    {
      "foo": true
    }

    foo: true

    text/plain

    no language

    unknown language

    https://foo.com/bar?baz=qux&fred=waldo#fragment

    https://foo.com/bar{?baz*,qux}

    --boundary-example
    Content-Type: application/openapi+yaml
    Content-Location: https://inaccessible-domain.com/api/openapi.yaml

    openapi: 3.2.0
    info:
      title: Example API
      version: 1.0
      externalDocs:
        url: docs.html

    --boundary-example
    Content-Type: text/html
    Content-Location: https://example.com/api/docs.html

    <html>
      <head>
        <title>API Documentation</title>
      </head>
      <body>
        <p>Awesome documentation goes here</p>
      </body>
    </html>

    event: addString
    data: This data is formatted
    data: across two lines
    retry: 5

    event: addNumber
    data: 1234.5678
    unknownField: this is ignored

    : This is a comment
    event: addJSON
    data: {"foo": 42}

    {"event": "addString", "data": "This data is formatted\nacross two lines", "retry": 5}
    {"event": "addNumber", "data": "1234.5678"}
    {"event": "addJSON", "data": "{\"foo\": 42}"}

    {"event": "addString", "data": "This data is formatted\nacross two lines", "retry": 5}
    {"event": "addNumber", "data": "1234.5678"}
    {"event": "addJSON", "data": "{\"foo\": 42}"}

    0x1E{
      "timestamp": "1985-04-12T23:20:50.52Z",
      "level": 1,
      "message": "Hi!"
    }
    0x1E{
      "timestamp": "1985-04-12T23:20:51.37Z",
      "level": 1,
      "message": "Bye!"
    }

# Appendix A: Revision History

Version | Date
--- | ---
30.0.1 | 3001-04-01