DeepL · API Governance Rules

DeepL API Rules

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

5 Rules error 2 warn 3

View Rules File View on GitHub

Rule Categories

deepl

Rules

warn

deepl-info-contact

API info should include the DeepL developer contact.

$.info

warn

deepl-base-url

Servers should reference api.deepl.com or api-free.deepl.com.

$.servers[*].url

error

deepl-auth-key

API should declare the DeepL-Auth-Key authentication scheme.

$.components.securitySchemes

error

deepl-translate-resource

API should expose a /translate endpoint.

$.paths

warn

deepl-operation-tags

Operations should be tagged Translate, Documents, Glossaries, Languages, Usage, or Write.

$.paths[*][*]

Spectral Ruleset

extends:
  - spectral:oas
rules:
  deepl-info-contact:
    description: API info should include the DeepL developer contact.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  deepl-base-url:
    description: Servers should reference api.deepl.com or api-free.deepl.com.
    given: $.servers[*].url
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "deepl\\.com"
  deepl-auth-key:
    description: API should declare the DeepL-Auth-Key authentication scheme.
    given: $.components.securitySchemes
    severity: error
    then:
      field: authKey
      function: truthy
  deepl-translate-resource:
    description: API should expose a /translate endpoint.
    given: $.paths
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "/translate"
  deepl-operation-tags:
    description: Operations should be tagged Translate, Documents, Glossaries, Languages, Usage, or Write.
    given: $.paths[*][*]
    severity: warn
    then:
      field: tags
      function: truthy