Apache Ozone · API Governance Rules

Apache Ozone API Rules

Spectral linting rules defining API design standards and conventions for Apache Ozone.

13 Rules error 4 warn 5 info 4
View Rules File View on GitHub

Rule Categories

info no operation operationid path paths query schema security servers

Rules

error
info-title-required
API must have a title
$.info
error
operation-summary-required
$.paths[*][*]
error
operation-operationId-required
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache Ozone
$.paths[*][get,post,put,delete,patch,head].summary
info
paths-s3-compatible
Paths should follow S3 bucket/key pattern
$.paths[*]~
warn
security-s3-auth
S3 API should use AWS Signature authentication
$.info
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
info
query-params-casing
Query parameters should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
# apache-ozone — 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)
#   - path-params-casing: snake @ 100% (n=12)
#   - query-params-casing: snake @ 50% (n=4)
#   - operationid-casing: camel @ 100% (n=9)
#   - schema-names-casing: pascal @ 100% (n=5)
#   - schema-properties-casing: snake @ 58% (n=19)
#   - merge: kept 6 existing, added 7 measured, upgraded 0
#   - added: servers-https-only, path-params-casing, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, no-empty-descriptions
extends:
  - spectral:oas
rules:
  info-title-required:
    description: API must have a title
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  operation-summary-required:
    severity: error
    given: $.paths[*][*]
    then:
      field: summary
      function: truthy
  operation-operationId-required:
    severity: error
    given: $.paths[*][*]
    then:
      field: operationId
      function: truthy
  operation-summary-apache-prefix:
    description: Summaries should start with Apache Ozone
    severity: info
    given: $.paths[*][get,post,put,delete,patch,head].summary
    then:
      function: pattern
      functionOptions:
        match: ^Apache Ozone
  paths-s3-compatible:
    description: Paths should follow S3 bucket/key pattern
    severity: info
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^/[{a-z]
  security-s3-auth:
    description: S3 API should use AWS Signature authentication
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  path-params-casing:
    description: Path parameters should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: snake
  query-params-casing:
    description: Query parameters should be snake_case (the dominant convention in this API).
    severity: info
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: snake
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  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