Archbee 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
# archbee — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions, then self-validated against the spec.
#
# REBASED 2026-09-04. The measurements below previously came from a fabricated scaffold
# specification (7 operations under /spaces and /spaces/{spaceId}/pages) that Archbee does not
# ship. They are now measured against openapi/archbee-public-api-openapi.yml, which is assembled
# from Archbee's own published api-oas-v2 documentation blocks.
#
# Provenance (measured 2026-09-04 against archbee-public-api-openapi.yml):
#   - operations: 24 across 22 paths, 8 tags
#   - servers-https-only: 1/1 servers https
#   - servers-expected-domain: 1/1 servers on archbee.com
#   - operationid-casing: camel @ 100% (n=24)
#   - path-params-casing: n=0 — this API has no path parameters; every identifier travels in the body
#   - security: global (root) http bearer — NOT emitting operation-security-required
#   - error responses: 400 @ 100% (n=24); NO operation documents a 401, so response-401-required
#     was replaced with response-400-documented, which is what this API actually does
#   - openapi-version-3 widened from ^3\.0\. to 3.0/3.1/3.2 — the contract is 3.1.0
#   - operation-summary-prefix REMOVED: Archbee's own operation names ("Get document",
#     "Create Space") do not start with "Archbee"; that rule was an artifact of the scaffold
#   - get-no-request-body KEPT as error, and it fires: GET /doc genuinely requires a JSON body.
#     That is a real interoperability hazard, not a lint false positive — see
#     conventions/archbee-conventions.yml.
#   - pagination: none observed — this API declares no limit/offset/page/cursor parameter
extends:
  - spectral:oas
rules:
  info-title-archbee-prefix:
    description: API title must start with "Archbee"
    severity: error
    given: $.info
    then:
      field: title
      function: pattern
      functionOptions:
        match: ^Archbee
  info-description-required:
    description: API must have a description
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: API must specify a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version-3:
    description: Use OpenAPI 3.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.[0-2]\.
  servers-defined:
    description: Server URLs must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: ^https://
  operation-id-required:
    description: All operations must have an operationId
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy
  operation-id-camel-case:
    description: OperationIds should use camelCase
    severity: warn
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-summary-required:
    description: All operations must have a summary
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: summary
      function: truthy
  operation-tags-required:
    description: All operations must have at least one tag
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: tags
      function: truthy
  parameter-description-required:
    description: All parameters must have a description
    severity: warn
    given: $.paths[*][*].parameters[*]
    then:
      field: description
      function: truthy
  response-success-required:
    description: All operations must define a success response
    severity: error
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      function: truthy
  response-400-documented:
    description: >-
      Every operation must document its 400 response. Archbee answers authentication failure,
      validation failure and refused operations all with HTTP 400 and never with a 401 on the REST
      Public API, so 400 is the error contract a consumer has to read.
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      field: '400'
      function: truthy
  response-description-required:
    description: All responses must have a description
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  schema-type-defined:
    description: Schema properties should define a type
    severity: warn
    given: $.components.schemas[*].properties[*]
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
          - required:
            - type
          - required:
            - $ref
  security-schemes-defined:
    description: Security schemes must be defined
    severity: error
    given: $.components
    then:
      field: securitySchemes
      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-returns-204:
    description: DELETE operations should return 204
    severity: info
    given: $.paths[*].delete.responses
    then:
      field: '204'
      function: truthy
  servers-expected-domain:
    description: Server URLs should be on the archbee.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: archbee\.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
  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
  error-schema-defined:
    description: A shared error schema (ErrorResponse) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: ErrorResponse
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy