The Philadelphia Inquirer · API Governance Rules

The Philadelphia Inquirer API Rules

Spectral linting rules defining API design standards and conventions for The Philadelphia Inquirer.

4 Rules error 1 warn 3
View Rules File View on GitHub

Rule Categories

inquirer

Rules

warn
inquirer-rss-title-case-summaries
Operation summaries should be Title Case.
$.paths[*][get,post,put,patch,delete].summary
error
inquirer-rss-operation-id-camel
operationId should be lowerCamelCase.
$.paths[*][get,post,put,patch,delete].operationId
warn
inquirer-rss-output-type-xml
RSS endpoints must accept outputType=xml.
$.paths[*][get].parameters[?(@.name=='outputType')]
warn
inquirer-rss-tag-required
Operations must carry at least one tag.
$.paths[*][get,post,put,patch,delete].tags

Spectral Ruleset

Raw ↑ 
extends:
- spectral:oas
rules:
  inquirer-rss-title-case-summaries:
    description: Operation summaries should be Title Case.
    given: $.paths[*][get,post,put,patch,delete].summary
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "^([A-Z][\\w'-]*)( [A-Z][\\w'-]*)*$"
  inquirer-rss-operation-id-camel:
    description: operationId should be lowerCamelCase.
    given: $.paths[*][get,post,put,patch,delete].operationId
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]+$"
  inquirer-rss-output-type-xml:
    description: RSS endpoints must accept outputType=xml.
    given: $.paths[*][get].parameters[?(@.name=='outputType')]
    severity: warn
    then:
      function: truthy
  inquirer-rss-tag-required:
    description: Operations must carry at least one tag.
    given: $.paths[*][get,post,put,patch,delete].tags
    severity: warn
    then:
      function: length
      functionOptions:
        min: 1