Parasail · API Governance Rules
Parasail API Rules
Spectral linting rules defining API design standards and conventions for Parasail.
5 Rules
error 3
warn 2
Rule Categories
parasail
Rules
error
parasail-server-base-url
All Parasail OpenAPI specs must use one of the canonical Parasail base URLs.
$.servers[*].url
error
parasail-bearer-auth
Parasail APIs authenticate via HTTP Bearer (API key) — securitySchemes must include a bearer scheme.
$.components.securitySchemes
warn
parasail-operation-id-camelcase
operationId must be lowerCamelCase verbs (e.g. createChatCompletion, listBatches).
$.paths.*.*.operationId
warn
parasail-summary-title-case
Operation summaries should use Title Case (e.g. "Create Chat Completion").
$.paths.*.*.summary
error
parasail-tags-required
Every operation must have at least one tag.
$.paths.*.*.tags