Microsoft Azure API Rules

# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# azure — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on azure.com
#   - path-params-casing: camel @ 100% (n=4)
#   - query-params-casing: kebab @ 83% (n=6)
#   - schema-names-casing: pascal @ 100% (n=6)
#   - schema-properties-casing: snake @ 67% (n=27)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 15 existing, added 6 measured, upgraded 0
#   - added: servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  info-title-format:
    description: API title must start with "Microsoft Azure"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^Microsoft
  operation-summary-prefix:
    description: Operation summaries must start with "Microsoft Azure"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^Microsoft
  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
  servers-expected-domain:
    description: Server URLs should be on the azure.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: azure\.com
  path-params-casing:
    description: Path parameters should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: camel
  query-params-casing:
    description: Query parameters should be kebab-case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: kebab
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy