Civil Infrastructure Platform · API Governance Rules

Civil Infrastructure Platform API Rules

Spectral linting rules defining API design standards and conventions for Civil Infrastructure Platform.

5 Rules error 2 warn 3
View Rules File View on GitHub

Rule Categories

cip

Rules

warn
cip-info-contact
API info MUST contain a contact for the maintaining working group.
$.info
warn
cip-info-license
CIP-derived API descriptions SHOULD declare an open source license.
$.info
error
cip-https-only
API servers MUST use HTTPS.
$.servers[*].url
error
cip-operation-id
Operations MUST have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
cip-tag-required
Operations MUST be tagged for working group grouping.
$.paths[*][get,post,put,delete,patch].tags