Skip to main content

id-format

Requires properties named id inside component schemas to have type: string.

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

Intent​

Treating identifiers as strings preserves leading zeros and avoids numeric size limits across clients and platforms.

Flags​

Any id property under components.schemas whose declared type is not string. A missing type is also reported.

Does not flag​

String IDs, differently named properties, or parameters outside component schemas.

See it fail​

components:
schemas:
Payment:
type: object
properties:
id:
type: integer

Diagnostic: Property `id` should be a string.

Fix it​

components:
schemas:
Payment:
type: object
properties:
id:
type: string

Configure​

profiles:
default:
rules:
extends: [recommended]
override:
id-format: error

Nearby: no-numeric-ids.