PeopleSoft · API Governance Rules

PeopleSoft API Rules

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

19 Rules error 14 warn 4 info 1
View Rules File View on GitHub

Rule Categories

get info no operation parameter paths response schema security servers tags

Rules

error
info-title-required
API title must be present.
$.info
warn
info-title-format
Title should start with "PeopleSoft".
$.info.title
error
info-description-required
API description must be present.
$.info
error
info-version-required
API version must be specified.
$.info
error
servers-defined
At least one server must be defined.
$
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths
error
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-unique
Operation IDs must be unique.
$
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
tags-title-case
Tag names should use Title Case.
$.tags[*].name
error
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must define a success response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-names-pascalcase
Schema names should use PascalCase.
$.components.schemas
warn
security-schemes-defined
Security schemes should be defined.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty.
$..description

Spectral Ruleset

Raw ↑ 
rules:
  info-title-required:
    description: API title must be present.
    severity: error
    given: $.info
    then: {field: title, function: truthy}
  info-title-format:
    description: Title should start with "PeopleSoft".
    severity: warn
    given: $.info.title
    then: {function: pattern, functionOptions: {match: "^PeopleSoft "}}
  info-description-required:
    description: API description must be present.
    severity: error
    given: $.info
    then: {field: description, function: truthy}
  info-version-required:
    description: API version must be specified.
    severity: error
    given: $.info
    then: {field: version, function: truthy}
  servers-defined:
    description: At least one server must be defined.
    severity: error
    given: $
    then: {field: servers, function: truthy}
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then: {function: pattern, functionOptions: {match: "^https://"}}
  paths-no-trailing-slash:
    description: Paths must not have trailing slashes.
    severity: error
    given: $.paths
    then: {field: "@key", function: pattern, functionOptions: {notMatch: "\\/$"}}
  operation-description-required:
    description: Every operation must have a description.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then: {field: description, function: truthy}
  operation-operationid-required:
    description: Every operation must have an operationId.
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then: {field: operationId, function: truthy}
  operation-operationid-unique:
    description: Operation IDs must be unique.
    severity: error
    given: $
    then: {function: oasOpId}
  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then: {field: tags, function: truthy}
  tags-title-case:
    description: Tag names should use Title Case.
    severity: info
    given: $.tags[*].name
    then: {function: pattern, functionOptions: {match: "^[A-Z][a-zA-Z0-9]*(\\s[A-Za-z0-9]+)*$"}}
  parameter-description-required:
    description: All parameters must have a description.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then: {field: description, function: truthy}
  response-success-required:
    description: Every operation must define a success response.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then: {function: schema, functionOptions: {schema: {anyOf: [{required: ["200"]}, {required: ["201"]}, {required: ["204"]}]}}}
  response-description-required:
    description: All responses must have a description.
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then: {field: description, function: truthy}
  schema-names-pascalcase:
    description: Schema names should use PascalCase.
    severity: warn
    given: $.components.schemas
    then: {field: "@key", function: pattern, functionOptions: {match: "^[A-Z][a-zA-Z0-9]*$"}}
  security-schemes-defined:
    description: Security schemes should be defined.
    severity: warn
    given: $.components
    then: {field: securitySchemes, function: truthy}
  get-no-request-body:
    description: GET operations must not have a request body.
    severity: error
    given: $.paths[*].get
    then: {field: requestBody, function: falsy}
  no-empty-descriptions:
    description: Descriptions must not be empty.
    severity: error
    given: "$..description"
    then: {function: truthy}