api-info-title-description

Requires the API info object to contain nonblank string title and description fields.

Attribute	Value
Category	Metadata
Maturity	Gold
OpenAPI	Swagger 2.0; OpenAPI 3.0, 3.1, 3.2
Starter	Off
Lenient–Complete	Error

Intent

The title identifies the API; the description gives readers enough context to understand its purpose.

Flags

• A non-object info value.
• A missing, non-string, empty, or whitespace-only info.title.
• A missing, non-string, empty, or whitespace-only info.description.

An object can produce two findings.

Does not flag

An info object with both fields as nonblank strings. Content quality is not evaluated.

See it fail

info:
  title: Payments API
  version: 1.0.0

Diagnostic: Info object should contain `description` field.

Fix it

info:
  title: Payments API
  description: Creates, retrieves, and refunds payments.
  version: 1.0.0

Configure

profiles:
  default:
    rules:
      extends: [recommended]
      override:
        api-info-title-description: warn

Nearby: api-title, info-contact, info-license.