Microsoft Word · API Governance Rules
Microsoft Word API Rules
Spectral linting rules defining API design standards and conventions for Microsoft Word.
39 Rules
error 18
warn 17
info 4
Rule Categories
delete
examples
get
info
microcks
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tags
Rules
error
info-title-required
Info title must be present and non-empty.
$.info
warn
info-title-prefix
Info title should start with 'Microsoft Word'.
$.info.title
error
info-description-required
Info description must be present.
$.info
warn
info-description-min-length
Info description should be at least 50 characters.
$.info.description
error
info-version-required
Info version must be present.
$.info
warn
info-contact-required
Info should include contact information.
$.info
info
info-license-required
Info should include license information.
$.info
error
openapi-version
OpenAPI version must be 3.0.x.
$
error
servers-defined
At least one server must be defined.
$
warn
servers-https
Server URLs should use HTTPS.
$.servers[*].url
warn
servers-description
Each server should have a description.
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case.
$.paths
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with 'Microsoft Word'.
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
OperationId should use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
tags-defined
Global tags array should be defined.
$
info
tags-description
Each tag should have a description.
$.tags[*]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][*].parameters[*]
error
parameter-schema-required
Every parameter must have a schema with a type.
$.paths[*][*].parameters[*]
warn
request-body-json-content
Request bodies should specify application/json content type.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description.
$.paths[*][*].responses[*]
warn
response-401-required
Operations should include a 401 Unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-404-for-get
GET operations should include a 404 Not Found response.
$.paths[*].get.responses
error
schema-type-required
All schemas must have a type defined.
$.components.schemas[*]
warn
schema-description-required
Top-level schemas should have descriptions.
$.components.schemas[*]
warn
schema-properties-camelcase
Schema properties should use camelCase naming.
$.components.schemas[*].properties
error
security-defined
Global security must be defined.
$
error
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
security-schemes-oauth2
OAuth2 security scheme should be defined for Microsoft Graph APIs.
$.components.securitySchemes
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
examples-encouraged
Schema properties should include example values.
$.components.schemas[*].properties[*]
info
microcks-operation-extension
Operations should include x-microcks-operation extension.
$.paths[*][get,post,put,patch,delete]