Microsoft Excel · API Governance Rules

Microsoft Excel API Rules

Spectral linting rules defining API design standards and conventions for Microsoft Excel.

24 Rules error 16 warn 6 info 2
View Rules File View on GitHub

Rule Categories

delete get info no openapi operation parameter paths response schema security servers tag

Rules

error
info-title-must-contain-microsoft-excel
Info title must contain 'Microsoft' or 'Excel'
$.info.title
error
info-description-required
Info description is required and must be at least 20 characters
$.info
error
info-version-required
Info version is required
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$.openapi
error
servers-must-be-defined
Servers array must be defined
$
error
servers-https-required
All server URLs must use HTTPS
$.servers[*].url
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
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 Excel'
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
info
tag-description-required
Global tags should have descriptions
$.tags[*]
warn
parameter-description-required
Parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Parameters must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must define a success response (2xx)
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should define a 401 Unauthorized response
$.paths[*][get,post,put,patch,delete].responses
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
security-global-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations must not have a request body
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings
$.paths[*][get,post,put,patch,delete].description

Spectral Ruleset

Raw ↑ 
rules:
  # INFO / METADATA
  info-title-must-contain-microsoft-excel:
    description: Info title must contain 'Microsoft' or 'Excel'
    given: $.info.title
    severity: error
    then:
      function: pattern
      functionOptions:
        match: (Microsoft|Excel)
  info-description-required:
    description: Info description is required and must be at least 20 characters
    given: $.info
    severity: error
    then:
      field: description
      function: truthy
  info-version-required:
    description: Info version is required
    given: $.info
    severity: error
    then:
      field: version
      function: truthy

  # OPENAPI VERSION
  openapi-version-3:
    description: Must use OpenAPI 3.x
    given: $.openapi
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^3\\."

  # SERVERS
  servers-must-be-defined:
    description: Servers array must be defined
    given: $
    severity: error
    then:
      field: servers
      function: truthy
  servers-https-required:
    description: All server URLs must use HTTPS
    given: $.servers[*].url
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  # PATHS - NAMING
  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash
    given: $.paths
    severity: error
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  # OPERATIONS
  operation-operationid-required:
    description: Every operation must have an operationId
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: operationId
      function: truthy
  operation-summary-required:
    description: Every operation must have a summary
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with 'Microsoft Excel'
    given: $.paths[*][get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^Microsoft Excel"
  operation-description-required:
    description: Every operation must have a description
    given: $.paths[*][get,post,put,patch,delete]
    severity: warn
    then:
      field: description
      function: truthy
  operation-tags-required:
    description: Every operation must have at least one tag
    given: $.paths[*][get,post,put,patch,delete]
    severity: error
    then:
      field: tags
      function: truthy
  operation-operationid-camel-case:
    description: operationId should use camelCase
    given: $.paths[*][get,post,put,patch,delete].operationId
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

  # TAGS
  tag-description-required:
    description: Global tags should have descriptions
    given: $.tags[*]
    severity: info
    then:
      field: description
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: Parameters must have a description
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    severity: warn
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Parameters must have a schema
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    severity: error
    then:
      field: schema
      function: truthy

  # RESPONSES
  response-success-required:
    description: Every operation must define a success response (2xx)
    given: $.paths[*][get,post,put,patch,delete].responses
    severity: error
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ["200"]
            - required: ["201"]
            - required: ["202"]
            - required: ["204"]
  response-401-recommended:
    description: Operations should define a 401 Unauthorized response
    given: $.paths[*][get,post,put,patch,delete].responses
    severity: warn
    then:
      field: "401"
      function: truthy

  # SCHEMAS
  schema-properties-description:
    description: Schema properties should have descriptions
    given: $.components.schemas[*].properties[*]
    severity: info
    then:
      field: description
      function: truthy

  # SECURITY
  security-global-defined:
    description: Global security must be defined
    given: $
    severity: error
    then:
      field: security
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined
    given: $.components
    severity: error
    then:
      field: securitySchemes
      function: truthy

  # HTTP METHOD CONVENTIONS
  get-no-request-body:
    description: GET operations must not have a request body
    given: $.paths[*].get
    severity: error
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations must not have a request body
    given: $.paths[*].delete
    severity: warn
    then:
      field: requestBody
      function: falsy

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    given: $.paths[*][get,post,put,patch,delete].description
    severity: error
    then:
      function: truthy