Field note

What it does

Sections: OpenAPI Specification v3.2.0 | Version 3.2.0 | What is the OpenAPI Specification? | Status of This Document | Table of Contents | 1. OpenAPI Specification | 1.1 Version 3.2.0 | 2. Introduction | 2.1 Versions and Deprecation | 2.2 Undefined and Implementation-Defined Behavior | 3. Format | 3.1 JSON and YAML Compatibility | 3.2 Case Sensitivity | 3.3 Rich Text Formatting | 4. Objects and Fields | 4.1 OpenAPI Object | 4.1.1 Fixed Fields | 4.1.2 OpenAPI Description Structure | 4.2 Info Object | 4.2.1 Fixed Fields | 4.2.2 Info Object Example | 4.3 Contact Object | 4.3.1 Fixed Fields | 4.3.2 Contact Object Example | 4.4 License Object | 4.4.1 Fixed Fields | 4.4.2 License Object Example | 4.5 Server Object | 4.5.1 Fixed Fields | 4.5.2 Relative References in API URLs | 4.5.3 Server Object Example | 4.6 Server Variable Object | 4.6.1 Fixed Fields | 4.7 Components Object | 4.7.1 Fixed Fields | 4.7.2 Components Object Example | 4.8 Paths Object | 4.8.1 Patterned Fields | 4.8.2 Path Templating | 4.8.3 Paths Object Example | 4.9 Path Item Object | 4.9.1 Fixed Fields | 4.9.2 Path Item Object Example | 4.10 Operation Object | 4.10.1 Fixed Fields | 4.10.2 Operation Object Example | 4.11 External Documentation Object | 4.11.1 Fixed Fields | 4.11.2 External Documentation Object Example | 4.12 Parameter Object | 4.12.1 Parameter Locations | 4.12.2 Fixed Fields | 4.12.3 Style Values | 4.12.4 URL Percent-Encoding | 4.12.5 Serialization and Examples | 4.12.6 Style Examples | 4.12.7 Extending Support for Querystring Formats | 4.12.8 Parameter Object Examples | 4.13 Request Body Object | 4.13.1 Fixed Fields | 4.13.2 Request Body Examples | 4.14 Media Type Object | 4.14.1 Fixed Fields | 4.14.2 Media Types | 4.14.3 Complete vs Streaming Content | 4.14.4 Special Considerations for Server-Sent Events | 4.14.5 Encoding Usage and Restrictions | 4.14.6 Media Type Examples | 4.14.7 Considerations for File Uploads | 4.15 Encoding Object | 4.15.1 Fixed Fields | 4.15.2 Nested Encoding | 4.15.3 Encoding the x-www-form-urlencoded Media Type | 4.15.4 Encoding multipart Media Types | 4.16 Responses Object | 4.16.1 Fixed Fields | 4.16.2 Patterned Fields | 4.16.3 HTTP Status Codes | 4.16.4 Responses Object Example | 4.17 Response Object | 4.17.1 Fixed Fields | 4.17.2 Response Object Examples | 4.18 Callback Object | 4.18.1 Patterned Fields | 4.18.2 Key Expression | 4.18.3 Callback Object Examples | 4.19 Example Object | 4.19.1 Fixed Fields | 4.19.2 Working with Examples | 4.19.3 Example Object Examples | 4.20 Link Object | 4.20.1 Fixed Fields | 4.20.2 Examples | 4.20.3 Runtime Expressions | 4.21 Header Object | 4.21.1 Fixed Fields | 4.21.2 Modeling Link Headers | 4.21.3 Representing the Set-Cookie Header | 4.21.4 Header Object Example | 4.22 Tag Object | 4.22.1 Fixed Fields | 4.22.2 Tag Object Example | 4.23 Reference Object | 4.23.1 Fixed Fields | 4.23.2 Reference Object Example | 4.23.3 Relative Schema Document Example | 4.23.4 Relative Documents with Embedded Schema Example | 4.24 Schema Object | 4.24.1 JSON Schema Keywords | 4.24.2 Fixed Fields | 4.24.3 Data Types | 4.24.4 Parsing and Serializing | 4.24.5 Extended Validation with Annotations | 4.24.6 Data Modeling Techniques | 4.24.7 Specifying Schema Dialects | 4.24.8 Schema Object Examples | 4.25 Discriminator Object | 4.25.1 Fixed Fields | 4.25.2 Conditions for Using the Discriminator Object | 4.25.3 Options for Mapping Values to Schemas | 4.25.4 Optional Discriminating Property | 4.25.5 Examples | 4.26 XML Object | 4.26.1 Fixed Fields | 4.26.2 XML Node Types | 4.26.3 XML Node Names | 4.26.4 Namespace Limitations | 4.26.5 Handling null Values | 4.26.6 XML Object Examples | 4.27 Security Scheme Object | 4.27.1 Fixed Fields | 4.27.2 Security Scheme Object Examples | 4.28 OAuth Flows Object | 4.28.1 Fixed Fields | 4.29 OAuth Flow Object | 4.29.1 Fixed Fields | 4.29.2 OAuth Flow Object Example | 4.30 Security Requirement Object | 4.30.1 Patterned Fields | 4.30.2 Security Requirement Object Examples | 5. OpenAPI Specification v3.1.2 OpenAPI Specification v3.1.2 Version 3.1.2 19 September 2025 More details about this document This version: https://spec.openapis.org/oas/v3.1.2.html Latest published version: https://spec.openapis.org/oas/latest.html Latest editor's draft: https://github.com/OAI/OpenAPI-Specification/ Editors: Henry Andrews Jeremy Whitlock Karen Etheridge Lorna Mitchell Marsh Gardiner Miguel Quintero Mike Kistler Ralf Handl Vincent Biret Former editors: Ron Ratovsky Darrel Miller Mike Ralphson Uri Sarid Jason Harmon Tony Tam Other versions: https://spec.openapis.org/oas/v3.2.0.html https://spec.openapis.org/oas/v3.1.1.html https://spec.openapis.org/oas/v3.1.0.html https://spec.openapis.org/oas/v3.0.4.html https://spec.openapis.org/oas/v3.0.3.html https://spec.openapis.org/oas/v3.0.2.html https://spec.openapis.org/oas/v3.0.1.html https://spec.openapis.org/oas/v3.0.0.html https://spec.openapis.org/oas/v2.0.html Participate GitHub O OpenAPI Specification v3.1.0 OpenAPI Specification v3.1.0 Version 3.1.0 15 February 2021 More details about this document This version: https://spec.openapis.org/oas/v3.1.0.html Latest published version: https://spec.openapis.org/oas/latest.html Latest editor's draft: https://github.com/OAI/OpenAPI-Specification/ Editors: Darrel Miller Jeremy Whitlock Marsh Gardiner Mike Ralphson Ron Ratovsky Uri Sarid Former editors: Jason Harmon Tony Tam Other versions: https://spec.openapis.org/oas/v3.2.0.html https://spec.openapis.org/oas/v3.1.2.html https://spec.openapis.org/oas/v3.1.1.html https://spec.openapis.org/oas/v3.0.4.html https://spec.openapis.org/oas/v3.0.3.html https://spec.openapis.org/oas/v3.0.2.html https://spec.openapis.org/oas/v3.0.1.html https://spec.openapis.org/oas/v3.0.0.html https://spec.openapis.org/oas/v2.0.html Participate GitHub OAI/OpenAPI-Specification File a bug Commit history Pull requests Copyright © 2021 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.

Overlay Specification

What it does

Available capabilities

Tags

Ways to use it

Product features

1.1 Version 3.2.0

1. OpenAPI Specification

2.1 Versions and Deprecation

2.2 Undefined and Implementation-Defined Behavior

2. Introduction

3.1 JSON and YAML Compatibility

3.2 Case Sensitivity

3. Format

OpenAPI Specification v3.2.0

Status of This Document

Version 3.2.0

What is the OpenAPI Specification?