Skip to main content

api-title

Restricts a nonblank API title to letters, digits, spaces, hyphens, and periods.

AttributeValue
CategoryMetadata
MaturityGold
OpenAPISwagger 2.0; OpenAPI 3.0, 3.1, 3.2
StarterOff
Lenient–CompleteError

Intent

A conservative character set keeps titles portable across generated documentation, filenames, and downstream systems.

Flags

A nonblank string info.title containing anything outside ASCII letters, digits, spaces, -, and ..

Does not flag

Missing, non-string, empty, or whitespace-only titles; api-info-title-description handles those. Valid titles may contain repeated spaces or punctuation.

See it fail

info:
title: Payments API!

Diagnostic: API title should use only letters, numbers, spaces, hyphens and periods.

Fix it

info:
title: Payments API

Configure

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

Nearby: api-info-title-description.