Amazon EventBridge Scheduler · API Governance Rules

Amazon EventBridge Scheduler API Rules

Spectral linting rules defining API design standards and conventions for Amazon EventBridge Scheduler.

24 Rules error 10 warn 13 info 1
View Rules File View on GitHub

Rule Categories

delete get info no openapi operation parameter path query response schema security servers

Rules

error
info-title-required
OpenAPI info must have a title.
$.info
warn
info-description-required
OpenAPI info must have a description.
$.info
error
info-version-required
OpenAPI info must have a version.
$.info
error
openapi-version-3
Must use OpenAPI 3.x.
$
error
servers-required
OpenAPI must define at least one server.
$
error
servers-https-required
All server URLs must use HTTPS.
$.servers[*]
error
operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-description-required
All operations must have a description.
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-operationId-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-operationId-camelCase
operationId must use camelCase.
$.paths[*][get,post,put,patch,delete,head,options].operationId
warn
operation-tags-required
All operations must have at least one tag.
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete,head,options].parameters[*]
error
operation-success-response-required
All operations must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete,head,options].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete,head,options].responses[*]
warn
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
schema-properties-have-types
Schema properties should specify a type.
$.components.schemas[*].properties[*]
info
schema-description-required
Top-level component schemas should have a description.
$.components.schemas[*]
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
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
warn
path-params-casing
Path parameters should be PascalCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties

Spectral Ruleset

Raw ↑ 
# amazon-eventbridge-scheduler — 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: 50% of servers already https (warn)
#   - path-params-casing: pascal @ 100% (n=10)
#   - query-params-casing: pascal @ 69% (n=13)
#   - operationid-casing: pascal @ 100% (n=12)
#   - schema-names-casing: pascal @ 100% (n=117)
#   - schema-properties-casing: pascal @ 93% (n=117)
#   - security: global (root) — NOT emitting operation-security-required
#   - merge: kept 20 existing, added 4 measured, upgraded 0
#   - added: path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing
extends:
  - spectral:oas
rules:
  info-title-required:
    description: OpenAPI info must have a title.
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-description-required:
    description: OpenAPI info must have a description.
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: OpenAPI info must have a version.
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version-3:
    description: Must use OpenAPI 3.x.
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.
  servers-required:
    description: OpenAPI must define at least one server.
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https-required:
    description: All server URLs must use HTTPS.
    severity: error
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: ^https://
  operation-summary-required:
    description: All operations must have a summary.
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: summary
      function: truthy
  operation-description-required:
    description: All operations must have a description.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: description
      function: truthy
  operation-operationId-required:
    description: All operations must have an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: operationId
      function: truthy
  operation-operationId-camelCase:
    description: operationId must use camelCase.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-tags-required:
    description: All operations must have at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: All parameters must have a description.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,head,options].parameters[*]
    then:
      field: description
      function: truthy
  operation-success-response-required:
    description: All operations must define at least one 2xx response.
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1
  response-description-required:
    description: All responses must have a description.
    severity: error
    given: $.paths[*][get,post,put,patch,delete,head,options].responses[*]
    then:
      field: description
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  schema-properties-have-types:
    description: Schema properties should specify a type.
    severity: warn
    given: $.components.schemas[*].properties[*]
    then:
      field: type
      function: truthy
  schema-description-required:
    description: Top-level component schemas should have a description.
    severity: info
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body.
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations should not have a request body.
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy
  path-params-casing:
    description: Path parameters should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: pascal
  query-params-casing:
    description: Query parameters should be PascalCase (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: pascal
  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: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  schema-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$