Cleared API Rules

# authorship: generated by API Evangelist tooling (derive-rules.py, 2026-11-04). x-method: generated
# Every rule below was MEASURED against Cleared's own contract before it was written; a rule is present only
# when the contract satisfies it at 80% or more. Severity: 100% -> error, >= 90% -> warn, else info.
# Provenance:
#   - operation-has-summary: 100%
#   - operation-has-success-response: 100%
#   - operation-declares-4xx: 100%
#   - path-no-trailing-slash: 100%
#   - path-params-in-braces: 100%
#   - response-media-type: 100%
#   - property-name-casing-camel: 87%
#   - info-has-description: 100%
#   - info-title-present: 100%
#   - info-description-present: 100%
#   - info-license-present: 100%
#   - info-version-present: 100%
#   - info-version-semver: 100%
#   - license-name-present: 100%
#   - server-url-present: 100%
#   - operation-summary-present: 100%
#   - operation-summary-min-length: 100%
#   - operation-responses-present: 100%
#   - operation-security-present: 100%
#   - mediatype-schema-present: 100%
#   - response-description-present: 100%
#   - response-description-min-length: 100%
#   - schema-type-present: 100%
#   - schema-type-values: 100%
#   - schema-required-present: 89%
#   - schema-properties-present: 100%
#   - securityscheme-type-present: 100%
#   - securityscheme-type-values: 100%
#   - securityscheme-description-present: 100%
#   - securityscheme-name-casing-pascal: 100%
#   - securityscheme-in-values: 100%
#   - securityscheme-scheme-values: 100%
#   - securityscheme-bearerformat-values: 100%
x-method: generated
x-generator: derive-rules.py
x-generated: '2026-11-04'
x-source:
- openapi/_original/clearedpay-xyz-v1-openapi.json
x-self-check:
  status: checked
  rules: 33
  dropped: {}
extends:
- - spectral:oas
  - recommended
formats:
- oas3
rules:
  operation-has-summary:
    description: 'Every operation has a summary (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
    x-pattern-key: Operation.summary|present
  operation-has-success-response:
    description: 'Every operation declares a 2xx response (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            ^2\d\d$: {}
          minProperties: 1
    x-pattern-key: Operation.responses|schema:07e20b47
  operation-declares-4xx:
    description: 'Every operation declares at least one 4xx response (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            ^4\d\d$: {}
          minProperties: 1
    x-pattern-key: Operation.responses|schema:4aea4da4
  path-no-trailing-slash:
    description: 'Paths carry no trailing slash (measured: 100% of this contract)'
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: ./$
    x-pattern-key: Paths.{key}|pattern:!./$
  path-params-in-braces:
    description: 'Path parameters use {braces}, not :colon (measured: 100% of this contract)'
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: ':'
    x-pattern-key: 'Paths.{key}|pattern:!:'
  response-media-type:
    description: 'Responses are served as application/json (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*].content
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required:
          - application/json
    x-pattern-key: Response.content|schema:2919cf38
  property-name-casing-camel:
    description: 'Schema property names are camel case (measured: 87% of this contract)'
    severity: info
    given: $.components.schemas[*].properties[*]~
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
    x-pattern-key: Schema.properties{key}|pattern:^[a-z][a-zA-Z0-9]*$
  info-has-description:
    description: 'The contract''s info block carries a description (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
    x-pattern-key: Info.description|present
  info-title-present:
    description: 'Info declares title (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: title
      function: defined
    x-pattern-key: Info.title|present
  info-description-present:
    description: 'Info declares description (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: description
      function: defined
    x-pattern-key: Info.description|present
  info-license-present:
    description: 'Info declares license (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: license
      function: defined
    x-pattern-key: Info.license|present
  info-version-present:
    description: 'Info declares version (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: version
      function: defined
    x-pattern-key: Info.version|present
  info-version-semver:
    description: 'info.version is numeric (measured: 100% of this contract)'
    severity: error
    given: $.info.version
    then:
      function: pattern
      functionOptions:
        match: ^v?\d+(\.\d+)*
    x-pattern-key: Info.version|pattern:^v?\d+(\.\d+)*
  license-name-present:
    description: 'License declares name (measured: 100% of this contract)'
    severity: error
    given: $.info.license
    then:
      field: name
      function: defined
    x-pattern-key: License.name|present
  server-url-present:
    description: 'Server declares url (measured: 100% of this contract)'
    severity: error
    given: $.servers[*]
    then:
      field: url
      function: defined
    x-pattern-key: Server.url|present
  operation-summary-present:
    description: 'Operation declares summary (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: summary
      function: defined
    x-pattern-key: Operation.summary|present
  operation-summary-min-length:
    description: 'Operation.summary runs at least 33 characters (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].summary
    then:
      function: length
      functionOptions:
        min: 33
    x-pattern-key: Operation.summary|length
  operation-responses-present:
    description: 'Operation declares responses (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: responses
      function: defined
    x-pattern-key: Operation.responses|present
  operation-security-present:
    description: 'Operation declares security (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: security
      function: defined
    x-pattern-key: Operation.security|present
  mediatype-schema-present:
    description: 'MediaType declares schema (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
    then:
      field: schema
      function: defined
    x-pattern-key: MediaType.schema|present
  response-description-present:
    description: 'Response declares description (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
    then:
      field: description
      function: defined
    x-pattern-key: Response.description|present
  response-description-min-length:
    description: 'Response.description runs at least 13 characters (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
    then:
      function: length
      functionOptions:
        min: 13
    x-pattern-key: Response.description|length
  schema-type-present:
    description: 'Schema declares type (measured: 100% of this contract)'
    severity: error
    given: $.components.schemas[*]
    then:
      field: type
      function: defined
    x-pattern-key: Schema.type|present
  schema-type-values:
    description: 'Schema.type is one of object (measured: 100% of this contract)'
    severity: error
    given: $.components.schemas[*].type
    then:
      function: enumeration
      functionOptions:
        values:
        - object
    x-pattern-key: Schema.type|enum:object
  schema-required-present:
    description: 'Schema declares required (measured: 88% of this contract)'
    severity: warn
    given: $.components.schemas[*]
    then:
      field: required
      function: defined
    x-pattern-key: Schema.required|present
  schema-properties-present:
    description: 'Schema declares properties (measured: 100% of this contract)'
    severity: error
    given: $.components.schemas[*]
    then:
      field: properties
      function: defined
    x-pattern-key: Schema.properties|present
  securityscheme-type-present:
    description: 'SecurityScheme declares type (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*]
    then:
      field: type
      function: defined
    x-pattern-key: SecurityScheme.type|present
  securityscheme-type-values:
    description: 'SecurityScheme.type is one of apiKey, http (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].type
    then:
      function: enumeration
      functionOptions:
        values:
        - apiKey
        - http
    x-pattern-key: SecurityScheme.type|enum:apiKey,http
  securityscheme-description-present:
    description: 'SecurityScheme declares description (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*]
    then:
      field: description
      function: defined
    x-pattern-key: SecurityScheme.description|present
  securityscheme-name-casing-pascal:
    description: 'SecurityScheme.name is pascal case (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].name
    then:
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9]*$
    x-pattern-key: SecurityScheme.name|pattern:^[A-Z][a-zA-Z0-9]*$
  securityscheme-in-values:
    description: 'SecurityScheme.in is one of header (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].in
    then:
      function: enumeration
      functionOptions:
        values:
        - header
    x-pattern-key: SecurityScheme.in|enum:header
  securityscheme-scheme-values:
    description: 'SecurityScheme.scheme is one of bearer (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].scheme
    then:
      function: enumeration
      functionOptions:
        values:
        - bearer
    x-pattern-key: SecurityScheme.scheme|enum:bearer
  securityscheme-bearerformat-values:
    description: 'SecurityScheme.bearerFormat is one of JWT, opaque (measured: 100% of this contract)'
    severity: error
    given: $.components.securitySchemes[*].bearerFormat
    then:
      function: enumeration
      functionOptions:
        values:
        - JWT
        - opaque
    x-pattern-key: SecurityScheme.bearerFormat|enum:JWT,opaque