Webflow API and Documentation · API Governance Rules

Webflow API and Documentation API Rules

Spectral linting rules defining API design standards and conventions for Webflow API and Documentation.

12 Rules error 1 warn 10 info 1

View Rules File View on GitHub

Rule Categories

no operation operationid path query security servers

Rules

error

servers-https-only

Server URLs must use HTTPS.

$.servers[*].url

warn

servers-expected-domain

Server URLs should be on the webflow.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

info

query-params-casing

Query parameters should be camelCase (the dominant convention in this API).

$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]

warn

operationid-casing

Operation IDs should be kebab-case (the dominant convention in this API).

$.paths[*][get,post,put,patch,delete].operationId

warn

security-schemes-defined

Security schemes should be defined in components.

$.components

warn

operation-documents-400

Operations should document a 400 response (documented on 93% of this API's operations).

$.paths[*][get,post,put,patch,delete].responses

warn

operation-documents-401

Operations should document a 401 response (documented on 99% of this API's operations).

$.paths[*][get,post,put,patch,delete].responses

warn

operation-documents-404

Operations should document a 404 response (documented on 99% of this API's operations).

$.paths[*][get,post,put,patch,delete].responses

warn

operation-documents-429

Operations should document a 429 response (documented on 99% of this API's operations).

$.paths[*][get,post,put,patch,delete].responses

warn

operation-documents-500

Operations should document a 500 response (documented on 96% of this API's operations).

$.paths[*][get,post,put,patch,delete].responses

warn

no-empty-descriptions

Descriptions must not be empty strings.

$..description

Spectral Ruleset

# webflow-api-and-documentation-webflow — 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: 5/5 servers on webflow.com
#   - path-params-casing: snake @ 100% (n=191)
#   - query-params-casing: camel @ 52% (n=127)
#   - operationid-casing: kebab @ 97% (n=153)
#   - security: global (root) — NOT emitting operation-security-required
#   - operation-documents-400: 93% adherence
#   - operation-documents-401: 99% adherence
#   - operation-documents-404: 99% adherence
#   - operation-documents-429: 99% adherence
#   - operation-documents-500: 96% adherence
#   - pagination params observed: ['limit', 'offset']
extends:
  - spectral:oas
rules:
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the webflow.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: webflow\.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 camelCase (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: camel
  operationid-casing:
    description: Operation IDs should be kebab-case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: kebab
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  operation-documents-400:
    description: Operations should document a 400 response (documented on 93% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '400'
      function: truthy
  operation-documents-401:
    description: Operations should document a 401 response (documented on 99% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy
  operation-documents-404:
    description: Operations should document a 404 response (documented on 99% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '404'
      function: truthy
  operation-documents-429:
    description: Operations should document a 429 response (documented on 99% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '429'
      function: truthy
  operation-documents-500:
    description: Operations should document a 500 response (documented on 96% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '500'
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy