beyourspace · API Governance Rules

beyourspace API Rules

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

25 Rules error 23 warn 1 info 1
Generated by API Evangelist Written by API Evangelist tooling for beyourspace's APIs. It is a starting point, not a ruleset beyourspace publishes or enforces.
View Rules File View on GitHub

Rule Categories

contact info operation path requestbody response server servers write

Rules

info
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
operation-has-description
Every operation has a description (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-success-response
Every operation declares a 2xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
operation-declares-4xx
Every operation declares at least one 4xx response (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete].responses
error
path-no-trailing-slash
Paths carry no trailing slash (measured: 100% of this contract)
$.paths[*]~
error
path-params-in-braces
Path parameters use {braces}, not :colon (measured: 100% of this contract)
$.paths[*]~
error
servers-https
Servers are https (measured: 100% of this contract)
$.servers[*].url
error
write-declares-request-body
POST and PUT declare a request body (measured: 100% of this contract)
$.paths[*][post,put]
error
info-has-description
The contract's info block carries a description (measured: 100% of this contract)
$.info
error
info-has-contact-or-terms
The contract's info block names a contact or terms of service (measured: 100% of this contract)
$.info
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
error
info-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-contact-present
Info declares contact (measured: 100% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
contact-email-present
Contact declares email (measured: 100% of this contract)
$.info.contact
error
server-url-present
Server declares url (measured: 100% of this contract)
$.servers[*]
error
server-url-https
Server.url is https (measured: 100% of this contract)
$.servers[*].url
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-description-present
Operation declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-requestbody-present
Operation declares requestBody (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-responses-present
Operation declares responses (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
requestbody-required-present
RequestBody declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
response-description-present
Response declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
response-description-min-length
Response.description runs at least 9 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description

Spectral Ruleset

beyourspace-es-rules.yml Raw ↑ 
# authorship: generated by API Evangelist tooling (derive-rules.py, 2026-11-02). x-method: generated
# Every rule below was MEASURED against beyourspace'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-description: 100%
#   - operation-has-success-response: 100%
#   - operation-declares-4xx: 100%
#   - path-no-trailing-slash: 100%
#   - path-params-in-braces: 100%
#   - servers-https: 100%
#   - write-declares-request-body: 100%
#   - info-has-description: 100%
#   - info-has-contact-or-terms: 100%
#   - info-title-present: 100%
#   - info-description-present: 100%
#   - info-contact-present: 100%
#   - info-version-present: 100%
#   - contact-email-present: 100%
#   - server-url-present: 100%
#   - server-url-https: 100%
#   - operation-summary-present: 100%
#   - operation-description-present: 100%
#   - operation-requestbody-present: 100%
#   - operation-responses-present: 100%
#   - requestbody-content-present: 100%
#   - requestbody-required-present: 100%
#   - response-description-present: 100%
#   - response-description-min-length: 100%
x-method: generated
x-generator: derive-rules.py
x-generated: '2026-11-02'
x-source:
- openapi/convierte-json-schema.beyourspace.es-openapi.json
- openapi/normaliza-handoffs.beyourspace.es-openapi.json
- openapi/normaliza-logs-uso-llm.beyourspace.es-openapi.json
- openapi/normalize-saas.beyourspace.es-openapi.json
x-self-check:
  status: skipped
  reason: gate not installed
extends:
- - spectral:oas
  - recommended
formats:
- oas3
rules:
  operation-has-summary:
    description: 'Every operation has a summary (measured: 100% of this contract)'
    severity: info
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
    x-pattern-key: Operation.summary|present
  operation-has-description:
    description: 'Every operation has a description (measured: 100% of this contract)'
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
    x-pattern-key: Operation.description|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:!:'
  servers-https:
    description: 'Servers are https (measured: 100% of this contract)'
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^(https://|\{)
    x-pattern-key: Server.url|pattern:^(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
    x-pattern-key: Operation.requestBody|present
  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-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
    x-pattern-key: OpenAPI.info|schema:093268bf
  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-contact-present:
    description: 'Info declares contact (measured: 100% of this contract)'
    severity: error
    given: $.info
    then:
      field: contact
      function: defined
    x-pattern-key: Info.contact|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
  contact-email-present:
    description: 'Contact declares email (measured: 100% of this contract)'
    severity: error
    given: $.info.contact
    then:
      field: email
      function: defined
    x-pattern-key: Contact.email|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
  server-url-https:
    description: 'Server.url is https (measured: 100% of this contract)'
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
    x-pattern-key: Server.url|pattern:^https://
  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-description-present:
    description: 'Operation declares description (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: description
      function: defined
    x-pattern-key: Operation.description|present
  operation-requestbody-present:
    description: 'Operation declares requestBody (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: requestBody
      function: defined
    x-pattern-key: Operation.requestBody|present
  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
  requestbody-content-present:
    description: 'RequestBody declares content (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
    then:
      field: content
      function: defined
    x-pattern-key: RequestBody.content|present
  requestbody-required-present:
    description: 'RequestBody declares required (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
    then:
      field: required
      function: defined
    x-pattern-key: RequestBody.required|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 9 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: 9
    x-pattern-key: Response.description|length

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset 
curl "https://apis.io/api/v1/rules/beyourspace-es-rules"
All spectral rules 
curl "https://apis.io/api/v1/rules?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.