Apache PDFBox · API Governance Rules

Apache PDFBox API Rules

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

6 Rules error 4 info 2
View Rules File View on GitHub

Rule Categories

info operation paths response

Rules

error
info-title-required
$.info
error
operation-summary-required
$.paths[*][*]
error
operation-operationId-required
$.paths[*][*]
info
operation-summary-apache-prefix
Summaries should start with Apache PDFBox
$.paths[*][get,post,put,delete,patch].summary
info
paths-document-resource
Document paths should follow /documents pattern
$.paths[*]~
error
response-success-required
$.paths[*][get,post,put].responses

Spectral Ruleset

Raw ↑ 
extends: "spectral:oas"
rules:
  info-title-required:
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy
  operation-summary-required:
    severity: error
    given: "$.paths[*][*]"
    then:
      field: summary
      function: truthy
  operation-operationId-required:
    severity: error
    given: "$.paths[*][*]"
    then:
      field: operationId
      function: truthy
  operation-summary-apache-prefix:
    description: "Summaries should start with Apache PDFBox"
    severity: info
    given: "$.paths[*][get,post,put,delete,patch].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Apache PDFBox"
  paths-document-resource:
    description: "Document paths should follow /documents pattern"
    severity: info
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^/documents"
  response-success-required:
    severity: error
    given: "$.paths[*][get,post,put].responses"
    then:
      function: schema
      functionOptions:
        schema:
          required: ["200"]