Nanonets · API Governance Rules
Nanonets API Rules
Spectral linting rules defining API design standards and conventions for Nanonets.
7 Rules
error 3
warn 4
Rule Categories
nanonets
Rules
warn
nanonets-info-contact
Every Nanonets OpenAPI must include the canonical contact block.
$.info.contact
error
nanonets-server-base
All Nanonets servers must point at app.nanonets.com.
$.servers[*].url
warn
nanonets-basic-auth
Nanonets APIs authenticate with HTTP Basic.
$.components.securitySchemes[*]
warn
nanonets-operation-summary
Every operation must have a Title Case summary.
$.paths.*[get,post,put,patch,delete].summary
error
nanonets-operation-id-required
Every operation must have an operationId.
$.paths.*[get,post,put,patch,delete]
warn
nanonets-tag-defined
Operations must declare at least one tag.
$.paths.*[get,post,put,patch,delete]
error
nanonets-https-only
All servers must be HTTPS — HTTP is rejected by Nanonets.
$.servers[*].url