Federal Laboratory Consortium for Technology Transfer · API Governance Rules
Federal Laboratory Consortium for Technology Transfer API Rules
Spectral linting rules defining API design standards and conventions for Federal Laboratory Consortium for Technology Transfer.
48 Rules
error 46
warn 1
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Federal Laboratory Consortium for Technology Transfer's APIs. It is a starting point, not a ruleset Federal Laboratory Consortium for Technology Transfer publishes or enforces.
Rule Categories
info
mediatype
operation
parameter
path
property
requestbody
response
schema
securityscheme
tag
write
Rules
info
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
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-tags
Every operation is tagged (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
operation-secured
Every operation declares its own security requirement (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
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
write-declares-request-body
POST and PUT declare a request body (measured: 100% of this contract)
$.paths[*][post,put]
error
response-media-type
Responses are served as application/json (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses[*].content
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-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-contact-present
Info declares contact (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
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
error
tag-name-casing-pascal
Tag.name is pascal case (measured: 100% of this contract)
$.tags[*].name
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-description-present
Operation declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-parameters-present
Operation declares parameters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-requestbody-present
Operation declares requestBody (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
operation-security-present
Operation declares security (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-name-casing-kebab
Parameter.name is kebab case (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].name
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 (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
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
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
requestbody-required-present
RequestBody declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
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[*]
error
response-content-present
Response declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
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, http (measured: 100% of this contract)
$.components.securitySchemes[*].type
error
securityscheme-name-casing-kebab
SecurityScheme.name is kebab case (measured: 100% of this contract)
$.components.securitySchemes[*].name
error
securityscheme-in-values
SecurityScheme.in is one of header (measured: 100% of this contract)
$.components.securitySchemes[*].in
error
securityscheme-scheme-values
SecurityScheme.scheme is one of bearer (measured: 100% of this contract)
$.components.securitySchemes[*].scheme
error
securityscheme-bearerformat-values
SecurityScheme.bearerFormat is one of JWT (measured: 100% of this contract)
$.components.securitySchemes[*].bearerFormat
Spectral Ruleset
Work with this as data
Every ruleset here is available over the APIs.io API and to AI agents over MCP.