SAS Institute · API Governance Rules
SAS Institute API Rules
Spectral linting rules defining API design standards and conventions for SAS Institute.
11 Rules
error 2
warn 7
info 2
Rule Categories
no
path
sas
schema
security
servers
Rules
warn
sas-tags-title-case
Tags should be in Title Case (e.g., Decisions, Reports)
$.tags[*].name
error
sas-operation-id-camel-case
operationId should be camelCase
$.paths.*.*.operationId
warn
sas-summary-title-case
Operation summaries should use Title Case
$.paths.*.*.summary
warn
sas-oauth-required
Operations should be secured via OAuth via SAS Logon
$.paths.*.*
info
sas-vendor-media-type
SAS Viya uses application/vnd.sas.* vendor media types for resources
$.paths.*.*.responses.*.content
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description