Dataiku · API Governance Rules

Dataiku API Rules

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

5 Rules error 2 warn 3
View Rules File View on GitHub

Rule Categories

dataiku

Rules

warn
dataiku-info-contact
API info should include a contact for Dataiku support.
$.info
warn
dataiku-public-api-prefix
Public API paths must be served under /public/api.
$.paths
error
dataiku-operation-tags
Every operation must declare at least one tag.
$.paths[*][*]
error
dataiku-server-https
Server URLs must use HTTPS.
$.servers[*].url
warn
dataiku-project-key-pattern
ProjectKey path parameters must follow the upper-case alphanumeric convention.
$.paths.*.*.parameters[?(@.name=='projectKey')].schema

Spectral Ruleset

Raw ↑ 
extends:
  - spectral:oas
rules:
  dataiku-info-contact:
    description: API info should include a contact for Dataiku support.
    given: $.info
    severity: warn
    then:
      field: contact
      function: truthy
  dataiku-public-api-prefix:
    description: Public API paths must be served under /public/api.
    given: $.paths
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^/public/api"
  dataiku-operation-tags:
    description: Every operation must declare at least one tag.
    given: $.paths[*][*]
    severity: error
    then:
      field: tags
      function: truthy
  dataiku-server-https:
    description: Server URLs must use HTTPS.
    given: $.servers[*].url
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^https://"
  dataiku-project-key-pattern:
    description: ProjectKey path parameters must follow the upper-case alphanumeric convention.
    given: $.paths.*.*.parameters[?(@.name=='projectKey')].schema
    severity: warn
    then:
      field: pattern
      function: truthy