Apache OpenNLP · API Governance Rules

Apache OpenNLP API Rules

Spectral linting rules defining API design standards and conventions for Apache OpenNLP.

10 Rules error 4 warn 5 info 1
View Rules File View on GitHub

Rule Categories

info operation paths request response schema

Rules

error
info-title-required
API must have a title
$.info
warn
info-description-required
API must have a description
$.info
error
operation-summary-required
Operations must have summaries
$.paths[*][*]
error
operation-operationId-required
Operations must have operationIds
$.paths[*][*]
warn
operation-tags-required
Operations must have tags
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache OpenNLP
$.paths[*][get,post,put,delete,patch].summary
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
request-body-content-type
Request bodies should use application/json
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must have a 200 success response
$.paths[*][*].responses
warn
schema-type-defined
Schema properties should have types defined
$.components.schemas[*].properties[*]

Spectral Ruleset

Raw ↑ 
extends: "spectral:oas"
rules:
  info-title-required:
    description: "API must have a title"
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy
  info-description-required:
    description: "API must have a description"
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy
  operation-summary-required:
    description: "Operations must have summaries"
    severity: error
    given: "$.paths[*][*]"
    then:
      field: summary
      function: truthy
  operation-operationId-required:
    description: "Operations must have operationIds"
    severity: error
    given: "$.paths[*][*]"
    then:
      field: operationId
      function: truthy
  operation-tags-required:
    description: "Operations must have tags"
    severity: warn
    given: "$.paths[*][*]"
    then:
      field: tags
      function: truthy
  operation-summary-apache-prefix:
    description: "Summaries should start with Apache OpenNLP"
    severity: info
    given: "$.paths[*][get,post,put,delete,patch].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Apache OpenNLP"
  paths-kebab-case:
    description: "Path segments should use kebab-case"
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^(/[a-z0-9{}-]+)+$"
  request-body-content-type:
    description: "Request bodies should use application/json"
    severity: warn
    given: "$.paths[*][post,put,patch].requestBody.content"
    then:
      function: schema
      functionOptions:
        schema:
          required: ["application/json"]
  response-success-required:
    description: "Operations must have a 200 success response"
    severity: error
    given: "$.paths[*][*].responses"
    then:
      function: schema
      functionOptions:
        schema:
          required: ["200"]
  schema-type-defined:
    description: "Schema properties should have types defined"
    severity: warn
    given: "$.components.schemas[*].properties[*]"
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ["type"]
            - required: ["$ref"]