Azure Functions · API Governance Rules

Azure Functions API Rules

Spectral linting rules defining API design standards and conventions for Azure Functions.

15 Rules error 5 warn 6 info 4
View Rules File View on GitHub

Rule Categories

info openapi operation parameter paths response schema security servers tags

Rules

warn
info-title-format
API title must start with "Azure Functions"
$.info.title
warn
operation-summary-prefix
Operation summaries must start with "Azure Functions"
$.paths[*][get,post,put,patch,delete].summary
error
operation-id-required
All operations must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
All operations must have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths[*]~
warn
openapi-version
Must use OpenAPI 3.x or Swagger 2.x
$
error
servers-https
All server URLs must use HTTPS
$.servers[*].url
error
response-success-required
Operations must define at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
parameter-description-required
All inline parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[?(!@.$ref)]
info
schema-properties-description
Top-level schema properties should have descriptions
$.components.schemas[*].properties[*]
info
tags-global-definition
All tags used in operations should be defined globally
$.tags
info
operation-id-camel-case
OperationIds should use consistent naming
$.paths[*][get,post,put,patch,delete].operationId
info
security-defined
Security schemes should be defined
$.components.securitySchemes

Spectral Ruleset

Raw ↑ 
extends: spectral:oas
rules:
  info-title-format:
    description: API title must start with "Azure Functions"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^Azure

  operation-summary-prefix:
    description: Operation summaries must start with "Azure Functions"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^Azure

  operation-id-required:
    description: All operations must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy

  operation-summary-required:
    description: All operations must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy

  operation-description-required:
    description: All operations must have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy

  operation-tags-required:
    description: All operations must have at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy

  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  openapi-version:
    description: Must use OpenAPI 3.x or Swagger 2.x
    severity: warn
    given: $
    then:
      function: truthy

  servers-https:
    description: All server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  response-success-required:
    description: Operations must define at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['202']
            - required: ['204']

  parameter-description-required:
    description: All inline parameters must have descriptions
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(!@.$ref)]
    then:
      field: description
      function: truthy

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

  tags-global-definition:
    description: All tags used in operations should be defined globally
    severity: info
    given: $.tags
    then:
      function: truthy

  operation-id-camel-case:
    description: OperationIds should use consistent naming
    severity: info
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: truthy

  security-defined:
    description: Security schemes should be defined
    severity: info
    given: $.components.securitySchemes
    then:
      function: truthy