Abacus · API Governance Rules

Abacus API Rules

Spectral linting rules defining API design standards and conventions for Abacus.

46 Rules error 13 warn 26 info 7
View Rules File View on GitHub

Rule Categories

delete error examples get info microcks no openapi operation pagination parameter path paths query request response schema security servers tag

Rules

error
info-title-required
API info must have a title
$.info
warn
info-title-prefix
API title should start with "Abacus"
$.info.title
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must have a version
$.info
warn
info-contact-required
API info should have contact information
$.info
warn
openapi-version-3
Should use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Each server should have a description
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case or snake_case with underscores
$.paths[*]~
warn
paths-no-trailing-slash
Paths should not have trailing slashes
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-summary-prefix
Operation summaries should start with "Abacus"
$.paths[*][get,post,put,patch,delete,options,head].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete,options,head]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete,options,head]
warn
operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete,options,head].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete,options,head]
warn
tag-global-defined
Tags used in operations should be defined at the global level
$.tags
info
tag-description
Global tags should have descriptions
$.tags[*]
warn
parameter-description-required
All parameters must have a description
$..parameters[*]
warn
parameter-snake-case
Parameter names should use snake_case
$.paths[*][*].parameters[*].name
info
request-body-content-json
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,patch,delete]
error
response-description-required
All responses must have a description
$.paths[*][*].responses[*]
warn
response-401-for-auth
Endpoints should document 401 Unauthorized responses
$.paths[*][get,post,put,delete].responses
warn
response-404-for-resource-endpoints
Endpoints with path parameters should document 404 responses
$.paths[*][get,put,delete].responses
warn
schema-description-recommended
Top-level schemas should have descriptions
$.components.schemas[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-property-snake-case
Schema property names should use snake_case
$.components.schemas[*].properties
error
security-schemes-defined
Security schemes should be defined in components
$.components.securitySchemes
warn
security-scheme-description
Security schemes should have descriptions
$.components.securitySchemes[*]
warn
security-global-defined
Global security should be defined
$
info
security-oauth2-scopes
OAuth2 scopes should be defined
$.components.securitySchemes[?(@.type == 'oauth2')]
error
get-no-request-body
GET operations should not have request bodies
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have request bodies
$.paths[*].delete
error
no-empty-descriptions
Descriptions should not be empty strings
$..description
info
examples-on-schemas
Schema properties should have examples for better DX
$.components.schemas[*].properties[*]
info
microcks-operation-extension
Operations should have x-microcks-operation for mock compatibility
$.paths[*][get,post,put,patch,delete]
info
pagination-params-standard
Paginated endpoints should use standard page/per_page parameters
$.paths[*].get.parameters[*].name
warn
servers-expected-domain
Server URLs should be on the abacus.com domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
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
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 snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
error-schema-defined
A shared error schema (Error) should be defined for error payloads.
$.components.schemas
warn
operation-documents-401
Operations should document a 401 response (documented on 100% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses

Spectral Ruleset

Raw ↑ 
# abacus — 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 abacus.com
#   - path-params-casing: snake @ 100% (n=4)
#   - query-params-casing: snake @ 100% (n=8)
#   - operationid-casing: camel @ 100% (n=8)
#   - schema-names-casing: pascal @ 100% (n=9)
#   - schema-properties-casing: snake @ 100% (n=43)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: Error
#   - operation-documents-401: 100% adherence
#   - pagination params observed: ['page', 'per_page']
#   - merge: kept 39 existing, added 7 measured, upgraded 0
#   - added: servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, error-schema-defined, operation-documents-401
extends:
  - spectral:oas
rules:
  info-title-required:
    description: API info must have a title
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-title-prefix:
    description: API title should start with "Abacus"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^Abacus
  info-description-required:
    description: API info must have a description
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: API info must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  info-contact-required:
    description: API info should have contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  openapi-version-3:
    description: Should use OpenAPI 3.x
    severity: warn
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.
  servers-defined:
    description: Servers must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-description:
    description: Each server should have a description
    severity: warn
    given: $.servers[*]
    then:
      field: description
      function: truthy
  paths-kebab-case:
    description: Path segments should use kebab-case or snake_case with underscores
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(\/([a-z0-9_{}/-]+))*\/?$
  paths-no-trailing-slash:
    description: Paths should not have trailing slashes
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: \/$
  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with "Abacus"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,options,head].summary
    then:
      function: pattern
      functionOptions:
        match: ^Abacus
  operation-description-required:
    description: Every operation must have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: description
      function: truthy
  operation-id-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: operationId
      function: truthy
  operation-id-camel-case:
    description: operationId should use camelCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete,options,head].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-tags-required:
    description: Every operation must have at least one tag
    severity: error
    given: $.paths[*][get,post,put,patch,delete,options,head]
    then:
      field: tags
      function: truthy
  tag-global-defined:
    description: Tags used in operations should be defined at the global level
    severity: warn
    given: $.tags
    then:
      function: truthy
  tag-description:
    description: Global tags should have descriptions
    severity: info
    given: $.tags[*]
    then:
      field: description
      function: truthy
  parameter-description-required:
    description: All parameters must have a description
    severity: warn
    given: $..parameters[*]
    then:
      field: description
      function: truthy
  parameter-snake-case:
    description: Parameter names should use snake_case
    severity: warn
    given: $.paths[*][*].parameters[*].name
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-z0-9_]*$
  request-body-content-json:
    description: Request bodies should use application/json content type
    severity: info
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1
  response-success-required:
    description: Operations must have at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses
      function: truthy
  response-description-required:
    description: All responses must have a description
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  response-401-for-auth:
    description: Endpoints should document 401 Unauthorized responses
    severity: warn
    given: $.paths[*][get,post,put,delete].responses
    then:
      function: truthy
  response-404-for-resource-endpoints:
    description: Endpoints with path parameters should document 404 responses
    severity: warn
    given: $.paths[*][get,put,delete].responses
    then:
      function: truthy
  schema-description-recommended:
    description: Top-level schemas should have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  schema-property-description:
    description: Schema properties should have descriptions
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: description
      function: truthy
  schema-property-snake-case:
    description: Schema property names should use snake_case
    severity: warn
    given: $.components.schemas[*].properties
    then:
      function: schema
      functionOptions:
        schema:
          type: object
  security-schemes-defined:
    description: Security schemes should be defined in components
    severity: error
    given: $.components.securitySchemes
    then:
      function: truthy
  security-scheme-description:
    description: Security schemes should have descriptions
    severity: warn
    given: $.components.securitySchemes[*]
    then:
      field: description
      function: truthy
  security-global-defined:
    description: Global security should be defined
    severity: warn
    given: $
    then:
      field: security
      function: truthy
  security-oauth2-scopes:
    description: OAuth2 scopes should be defined
    severity: info
    given: $.components.securitySchemes[?(@.type == 'oauth2')]
    then:
      function: truthy
  get-no-request-body:
    description: GET operations should not have request bodies
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations should not have request bodies
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions should not be empty strings
    severity: error
    given: $..description
    then:
      function: pattern
      functionOptions:
        notMatch: ^\s*$
  examples-on-schemas:
    description: Schema properties should have examples for better DX
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: example
      function: truthy
  microcks-operation-extension:
    description: Operations should have x-microcks-operation for mock compatibility
    severity: info
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: x-microcks-operation
      function: truthy
  pagination-params-standard:
    description: Paginated endpoints should use standard page/per_page parameters
    severity: info
    given: $.paths[*].get.parameters[*].name
    then:
      function: pattern
      functionOptions:
        match: ^(page|per_page|cursor|limit|offset|sort|order|status|from_date|to_date|member_id|[a-z_]+)$
  servers-expected-domain:
    description: Server URLs should be on the abacus.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: abacus\.com
  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: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: snake
  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 snake_case (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  error-schema-defined:
    description: A shared error schema (Error) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: Error
      function: truthy
  operation-documents-401:
    description: Operations should document a 401 response (documented on 100% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy