Skip to content
Status

OpenAPI Hub

Info in OpenAPI best practices

Info Object in OpenAPI

The document’s info object contains information about the document, including fields like title, version, and description that help to identify the purpose and owner of the document.

Example:

openapi: 3.1.0
info:
  title: The Speakeasy Bar
  version: 1.0.0
  summary: A bar that serves drinks
  description: A secret underground bar that serves drinks to those in the know.
  contact:
    name: Speakeasy Support
    url: https://support.speakeasy.bar
    email: support@speakeasy.bar
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://speakeasy.bar/terms
Field
title
Type
String
Description
A name for the API contained within the document.
Required
✅
version
Type
String
Description
The version of this OpenAPI document, not the version of the API or the OpenAPI Specification used. This is recommended to be a Semantic Version.
Required
✅
summary
Type
String
Description
(Available in OpenAPI 3.1.x ONLY)A short sentence summarizing the API contained with the document.
Required
description
Type
String
Description
A longer description of the API contained within the document. This may contain CommonMark syntax to provide a rich description.
Required
contact
Description
Contact information for the maintainer of the API. Note: Currently not supported by Speakeasy tooling.
Required
license
Description
The license the API is made available under.
Required
termsOfService
Type
String
Description
A URL to the terms of service for the API.
Required
x-*
Description
Any number of extension fields can be added to the info object that can be used by tooling and vendors to add additional metadata and functionality to the OpenAPI Specification.
Required

The above order of fields is recommended (but is not required by the OpenAPI specification) as it puts the most important information first and allows the reader to get a quick overview of the document and API.

Contact Object in OpenAPI

Contact information for the maintainer of the API.

Field
name
Type
String
Description
The name of a contact that could be approached, for example, for support.
Required
url
Type
String
Description
A URL to a website or similar providing contact information.
Required
email
Type
String
Description
An email address for the contact.
Required
x-*
Description
Any number of extension fields can be added to the contact object that can be used by tooling and vendors.
Required

License Object in OpenAPI

The license the API is made available under.

Field
name
Type
String
Description
The name of the license.
Required
✅
identifier
Type
String
Description
(Available in OpenAPI 3.1.x ONLY)An SPDX identifier for the license. Provided only if url isn't set.
Required
url
Type
String
Description
A URL to the license information. Provided only if identifier isn't set.
Required
x-*
Description
Any number of extension fields can be added to the license object that can be used by tooling and vendors.
Required