shipcloud API Rules

# authorship: generated by API Evangelist tooling (derive-rules.py, 2026-10-09). x-method: generated
# Every rule below was MEASURED against shipcloud'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-description: 100%
#   - operation-has-success-response: 100%
#   - operation-declares-4xx: 94%
#   - operation-declares-401-or-403: 94%
#   - operation-secured: 100%
#   - path-no-trailing-slash: 100%
#   - path-params-in-braces: 100%
#   - servers-https: 100%
#   - write-declares-request-body: 100%
#   - response-media-type: 100%
#   - info-has-description: 100%
#   - info-has-contact-or-terms: 100%
x-method: generated
x-generator: derive-rules.py
x-generated: '2026-10-09'
x-source:
- openapi/shipcloud-openapi.yml
extends:
- - spectral:oas
  - recommended
formats:
- oas3
rules:
  operation-has-description:
    description: 'Every operation has a description (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  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
  operation-declares-4xx:
    description: 'Every operation declares at least one 4xx response (measured: 94% of this contract)'
    severity: info
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          patternProperties:
            ^4\d\d$: {}
          minProperties: 1
  operation-declares-401-or-403:
    description: 'Every operation declares 401 or 403 (measured: 94% of this contract)'
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
          - required:
            - '401'
          - required:
            - '403'
  operation-secured:
    description: 'Every operation is covered by a security requirement (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: security
      function: truthy
  path-no-trailing-slash:
    description: 'Paths carry no trailing slash (measured: 100% of this contract)'
    severity: error
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        notMatch: ./$
  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: ':'
  servers-https:
    description: 'Servers are https (measured: 100% of this contract)'
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^(https://|\{)
  write-declares-request-body:
    description: 'POST and PUT declare a request body (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][post,put]
    then:
      field: requestBody
      function: truthy
  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
  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
  info-has-contact-or-terms:
    description: 'The contract''s info block names a contact or terms of service (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
          - required:
            - contact
          - required:
            - termsOfService