Dubai Setup Index · API Governance Rules
Dubai Setup Index API Rules
Spectral linting rules defining API design standards and conventions for Dubai Setup Index.
51 Rules
error 49
warn 1
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Dubai Setup Index's APIs. It is a starting point, not a ruleset Dubai Setup Index publishes or enforces.
Rule Categories
info
license
mediatype
operation
operationid
parameter
path
property
response
schema
securityscheme
server
servers
Rules
warn
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operationid-casing-camel
operationIds are camel case (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].operationId
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-description
Every operation has a description (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
error
schema-has-description
Every component schema carries a title or description (measured: 100% of this contract)
$.components.schemas[*]
error
property-name-casing-camel
Schema property names are camel case (measured: 100% of this contract)
$.components.schemas[*].properties[*]~
error
info-has-description
The contract's info block carries a description (measured: 100% of this contract)
$.info
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
error
info-summary-present
Info declares summary (measured: 100% of this contract)
$.info
error
info-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-license-present
Info declares license (measured: 100% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
license-name-present
License declares name (measured: 100% of this contract)
$.info.license
error
license-identifier-present
License declares identifier (measured: 100% of this contract)
$.info.license
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
server-description-present
Server declares description (measured: 100% of this contract)
$.servers[*]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-min-length
Operation.summary runs at least 13 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-description-present
Operation declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-description-min-length
Operation.description runs at least 98 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-operationid-casing-camel
Operation.operationId is camel case (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].operationId
error
operation-parameters-present
Operation declares parameters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-values
Parameter.in is one of header, path (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
error
parameter-description-present
Parameter declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-description-min-length
Parameter.description runs at least 30 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-required-present
Parameter declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
mediatype-schema-present
MediaType declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
info
response-description-min-length
Response.description runs at least 15 characters (measured: 95% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
error
schema-title-present
Schema declares title (measured: 100% of this contract)
$.components.schemas[*]
error
schema-type-present
Schema declares type (measured: 100% of this contract)
$.components.schemas[*]
error
schema-type-values
Schema.type is one of object (measured: 100% of this contract)
$.components.schemas[*].type
error
schema-required-present
Schema declares required (measured: 100% of this contract)
$.components.schemas[*]
error
schema-properties-present
Schema declares properties (measured: 100% of this contract)
$.components.schemas[*]
error
securityscheme-type-present
SecurityScheme declares type (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-type-values
SecurityScheme.type is one of apiKey (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-description-present
SecurityScheme declares description (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-name-present
SecurityScheme declares name (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-in-present
SecurityScheme declares in (measured: 100% of this contract)
$.components.securitySchemes[*]
error
securityscheme-in-values
SecurityScheme.in is one of cookie (measured: 100% of this contract)
$.components.securitySchemes[*].in
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.