EHRbase · API Governance Rules

EHRbase API Rules

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

52 Rules error 41 warn 8 info 3
Generated by API Evangelist Written by API Evangelist tooling for EHRbase's APIs. It is a starting point, not a ruleset EHRbase publishes or enforces.
View Rules File View on GitHub

Rule Categories

header info license mediatype operation operationid parameter path property requestbody response schema server servers tag write

Rules

error
operation-has-operationid
Every operation declares an operationId (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
info
operationid-casing-camel
operationIds are camel case (measured: 82% of this contract)
$.paths[*][get,post,put,patch,delete].operationId
error
operation-has-summary
Every operation has a summary (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
error
operation-has-tags
Every operation is tagged (measured: 100% of this contract)
$.paths[*][get,post,put,patch,delete]
warn
operation-has-success-response
Every operation declares a 2xx response (measured: 98% of this contract)
$.paths[*][get,post,put,patch,delete].responses
warn
path-segment-casing-snake
Path segments are snake case (measured: 98% of this contract)
$.paths[*]~
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
warn
write-declares-request-body
POST and PUT declare a request body (measured: 90% of this contract)
$.paths[*][post,put]
warn
property-name-casing-camel
Schema property names are camel case (measured: 93% of this contract)
$.components.schemas[*].properties[*]~
error
info-has-description
The contract's info block carries a description (measured: 100% of this contract)
$.info
error
info-title-present
Info declares title (measured: 100% of this contract)
$.info
warn
info-title-min-length
Info.title runs at least 17 characters (measured: 95% of this contract)
$.info.title
error
info-description-present
Info declares description (measured: 100% of this contract)
$.info
error
info-description-min-length
Info.description runs at least 352 characters (measured: 100% of this contract)
$.info.description
error
info-license-present
Info declares license (measured: 100% of this contract)
$.info
error
info-version-present
Info declares version (measured: 100% of this contract)
$.info
error
info-version-semver
info.version is numeric (measured: 100% of this contract)
$.info.version
error
license-name-present
License declares name (measured: 100% of this contract)
$.info.license
error
license-url-present
License declares url (measured: 100% of this contract)
$.info.license
error
license-url-https
License.url is https (measured: 100% of this contract)
$.info.license.url
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
server-description-present
Server declares description (measured: 100% of this contract)
$.servers[*]
error
server-description-min-length
Server.description runs at least 20 characters (measured: 100% of this contract)
$.servers[*].description
error
tag-name-present
Tag declares name (measured: 100% of this contract)
$.tags[*]
error
operation-tags-present
Operation declares tags (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-present
Operation declares summary (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
error
operation-summary-min-length
Operation.summary runs at least 10 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].summary
error
operation-description-min-length
Operation.description runs at least 53 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].description
error
operation-operationid-present
Operation declares operationId (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace]
info
operation-operationid-casing-camel
Operation.operationId is camel case (measured: 82% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].operationId
warn
operation-parameters-present
Operation declares parameters (measured: 96% 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
parameter-name-present
Parameter declares name (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-present
Parameter declares in (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-in-values
Parameter.in is one of header, path, query (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
error
parameter-description-min-length
Parameter.description runs at least 18 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
error
parameter-required-present
Parameter declares required (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
parameter-schema-present
Parameter declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
error
requestbody-content-present
RequestBody declares content (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].requestBody
error
mediatype-schema-present
MediaType declares schema (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].content[*]
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 2 characters (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].description
info
response-content-present
Response declares content (measured: 85% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
error
header-description-present
Header declares description (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*]
error
header-style-present
Header declares style (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*]
error
header-style-values
Header.style is one of simple (measured: 100% of this contract)
$.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*].style
warn
schema-type-present
Schema declares type (measured: 99% of this contract)
$.components.schemas[*]
error
schema-type-values
Schema.type is one of null, object (measured: 100% of this contract)
$.components.schemas[*].type
warn
schema-properties-present
Schema declares properties (measured: 98% of this contract)
$.components.schemas[*]

Spectral Ruleset

Raw ↑ 
# authorship: generated by API Evangelist tooling (derive-rules.py, 2026-11-01). x-method: generated
# Every rule below was MEASURED against EHRbase'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-operationid: 100%
#   - operationid-casing-camel: 83%
#   - operation-has-summary: 100%
#   - operation-has-tags: 100%
#   - operation-has-success-response: 98%
#   - path-segment-casing-snake: 98%
#   - path-no-trailing-slash: 100%
#   - path-params-in-braces: 100%
#   - servers-https: 100%
#   - write-declares-request-body: 90%
#   - property-name-casing-camel: 93%
#   - info-has-description: 100%
#   - info-title-present: 100%
#   - info-title-min-length: 95%
#   - info-description-present: 100%
#   - info-description-min-length: 100%
#   - info-license-present: 100%
#   - info-version-present: 100%
#   - info-version-semver: 100%
#   - license-name-present: 100%
#   - license-url-present: 100%
#   - license-url-https: 100%
#   - server-url-present: 100%
#   - server-url-https: 100%
#   - server-description-present: 100%
#   - server-description-min-length: 100%
#   - tag-name-present: 100%
#   - operation-tags-present: 100%
#   - operation-summary-present: 100%
#   - operation-summary-min-length: 100%
#   - operation-description-min-length: 100%
#   - operation-operationid-present: 100%
#   - operation-operationid-casing-camel: 83%
#   - operation-parameters-present: 97%
#   - operation-responses-present: 100%
#   - parameter-name-present: 100%
#   - parameter-in-present: 100%
#   - parameter-in-values: 100%
#   - parameter-description-min-length: 100%
#   - parameter-required-present: 100%
#   - parameter-schema-present: 100%
#   - requestbody-content-present: 100%
#   - mediatype-schema-present: 100%
#   - response-description-present: 100%
#   - response-description-min-length: 100%
#   - response-content-present: 86%
#   - header-description-present: 100%
#   - header-style-present: 100%
#   - header-style-values: 100%
#   - schema-type-present: 99%
#   - schema-type-values: 100%
#   - schema-properties-present: 99%
x-method: generated
x-generator: derive-rules.py
x-generated: '2026-11-01'
x-source:
- openapi/ehrbase-adl-1-4-template-api-openapi.yml
- openapi/ehrbase-adl-2-template-api-openapi.yml
- openapi/ehrbase-admin-composition-api-openapi.yml
- openapi/ehrbase-admin-contribution-api-openapi.yml
- openapi/ehrbase-admin-directory-api-openapi.yml
x-self-check:
  status: checked
  rules: 52
  dropped: {}
extends:
- - spectral:oas
  - recommended
formats:
- oas3
rules:
  operation-has-operationid:
    description: 'Every operation declares an operationId (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
    x-pattern-key: Operation.operationId|present
  operationid-casing-camel:
    description: 'operationIds are camel case (measured: 82% of this contract)'
    severity: info
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
    x-pattern-key: Operation.operationId|pattern:^[a-z][a-zA-Z0-9]*$
  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-tags:
    description: 'Every operation is tagged (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
    x-pattern-key: Operation.tags|present
  operation-has-success-response:
    description: 'Every operation declares a 2xx response (measured: 98% of this contract)'
    severity: warn
    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
  path-segment-casing-snake:
    description: 'Path segments are snake case (measured: 98% of this contract)'
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z0-9]+(_[a-z0-9]+)*|/\{[^}]+\})+/?$
    x-pattern-key: Paths.{key}|pattern:^(/[a-z0-9]+(_[a-z0-9]+)*|/\{[^}]+\})+/?$
  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: 90% of this contract)'
    severity: warn
    given: $.paths[*][post,put]
    then:
      field: requestBody
      function: truthy
    x-pattern-key: Operation.requestBody|present
  property-name-casing-camel:
    description: 'Schema property names are camel case (measured: 93% of this contract)'
    severity: warn
    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-title-min-length:
    description: 'Info.title runs at least 17 characters (measured: 95% of this contract)'
    severity: warn
    given: $.info.title
    then:
      function: length
      functionOptions:
        min: 17
    x-pattern-key: Info.title|length
  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-description-min-length:
    description: 'Info.description runs at least 352 characters (measured: 100% of this contract)'
    severity: error
    given: $.info.description
    then:
      function: length
      functionOptions:
        min: 352
    x-pattern-key: Info.description|length
  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
  license-url-present:
    description: 'License declares url (measured: 100% of this contract)'
    severity: error
    given: $.info.license
    then:
      field: url
      function: defined
    x-pattern-key: License.url|present
  license-url-https:
    description: 'License.url is https (measured: 100% of this contract)'
    severity: error
    given: $.info.license.url
    then:
      function: pattern
      functionOptions:
        match: ^https://
    x-pattern-key: License.url|pattern:^https://
  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://
  server-description-present:
    description: 'Server declares description (measured: 100% of this contract)'
    severity: error
    given: $.servers[*]
    then:
      field: description
      function: defined
    x-pattern-key: Server.description|present
  server-description-min-length:
    description: 'Server.description runs at least 20 characters (measured: 100% of this contract)'
    severity: error
    given: $.servers[*].description
    then:
      function: length
      functionOptions:
        min: 20
    x-pattern-key: Server.description|length
  tag-name-present:
    description: 'Tag declares name (measured: 100% of this contract)'
    severity: error
    given: $.tags[*]
    then:
      field: name
      function: defined
    x-pattern-key: Tag.name|present
  operation-tags-present:
    description: 'Operation declares tags (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: tags
      function: defined
    x-pattern-key: Operation.tags|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 10 characters (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].summary
    then:
      function: length
      functionOptions:
        min: 10
    x-pattern-key: Operation.summary|length
  operation-description-min-length:
    description: 'Operation.description runs at least 53 characters (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].description
    then:
      function: length
      functionOptions:
        min: 53
    x-pattern-key: Operation.description|length
  operation-operationid-present:
    description: 'Operation declares operationId (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: operationId
      function: defined
    x-pattern-key: Operation.operationId|present
  operation-operationid-casing-camel:
    description: 'Operation.operationId is camel case (measured: 82% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
    x-pattern-key: Operation.operationId|pattern:^[a-z][a-zA-Z0-9]*$
  operation-parameters-present:
    description: 'Operation declares parameters (measured: 96% of this contract)'
    severity: warn
    given: $.paths[*][get,put,post,delete,patch,options,head,trace]
    then:
      field: parameters
      function: defined
    x-pattern-key: Operation.parameters|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
  parameter-name-present:
    description: 'Parameter declares name (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: name
      function: defined
    x-pattern-key: Parameter.name|present
  parameter-in-present:
    description: 'Parameter declares in (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: in
      function: defined
    x-pattern-key: Parameter.in|present
  parameter-in-values:
    description: 'Parameter.in is one of header, path, query (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].in
    then:
      function: enumeration
      functionOptions:
        values:
        - header
        - path
        - query
    x-pattern-key: Parameter.in|enum:header,path,query
  parameter-description-min-length:
    description: 'Parameter.description runs at least 18 characters (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*].description
    then:
      function: length
      functionOptions:
        min: 18
    x-pattern-key: Parameter.description|length
  parameter-required-present:
    description: 'Parameter declares required (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: required
      function: defined
    x-pattern-key: Parameter.required|present
  parameter-schema-present:
    description: 'Parameter declares schema (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].parameters[*]
    then:
      field: schema
      function: defined
    x-pattern-key: Parameter.schema|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
  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 2 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: 2
    x-pattern-key: Response.description|length
  response-content-present:
    description: 'Response declares content (measured: 85% of this contract)'
    severity: info
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*]
    then:
      field: content
      function: defined
    x-pattern-key: Response.content|present
  header-description-present:
    description: 'Header declares description (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*]
    then:
      field: description
      function: defined
    x-pattern-key: Header.description|present
  header-style-present:
    description: 'Header declares style (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*]
    then:
      field: style
      function: defined
    x-pattern-key: Header.style|present
  header-style-values:
    description: 'Header.style is one of simple (measured: 100% of this contract)'
    severity: error
    given: $.paths[*][get,put,post,delete,patch,options,head,trace].responses[*].headers[*].style
    then:
      function: enumeration
      functionOptions:
        values:
        - simple
    x-pattern-key: Header.style|enum:simple
  schema-type-present:
    description: 'Schema declares type (measured: 99% of this contract)'
    severity: warn
    given: $.components.schemas[*]
    then:
      field: type
      function: defined
    x-pattern-key: Schema.type|present
  schema-type-values:
    description: 'Schema.type is one of null, object (measured: 100% of this contract)'
    severity: error
    given: $.components.schemas[*].type
    then:
      function: enumeration
      functionOptions:
        values:
        - 'null'
        - object
    x-pattern-key: Schema.type|enum:null,object
  schema-properties-present:
    description: 'Schema declares properties (measured: 98% of this contract)'
    severity: warn
    given: $.components.schemas[*]
    then:
      field: properties
      function: defined
    x-pattern-key: Schema.properties|present

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/ehrbase-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.