veeva · API Governance Rules

veeva API Rules

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

34 Rules error 11 warn 19 info 4
View Rules File View on GitHub

Rule Categories

delete get info no openapi operation parameter paths requestbody response schema security servers tag tags vault

Rules

error
info-title-required
Info title must be defined.
$.info
warn
info-title-prefix
Info title must start with "Veeva".
$.info.title
warn
info-description-required
Info description must be defined and non-empty.
$.info
error
info-version-required
API version must be defined.
$.info
warn
info-contact-required
Contact information must be defined.
$.info
error
openapi-version-3
Must use OpenAPI 3.x.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-description
Each server must have a description.
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case (lowercase with hyphens, not underscores or camelCase).
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not end with a trailing slash.
$.paths[*]~
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-title-case
Operation summaries must start with "Veeva" (company name prefix).
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,delete,patch]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
operation-operationid-camelcase
operationId must use camelCase.
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,delete,patch]
warn
tags-defined
Global tags array should be defined.
$
warn
tag-description-required
Each tag must have a description.
$.tags[*]
warn
parameter-description-required
All parameters must have a description.
$..parameters[*]
warn
parameter-schema-type
All parameters must have a schema with a type.
$..parameters[*].schema
info
requestbody-description-required
Request bodies should have a description.
$.paths[*][post,put,patch].requestBody
error
response-success-required
Every operation must have at least one success (2xx) response.
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description.
$.paths[*][get,post,put,delete,patch].responses[*]
warn
response-401-defined
Authenticated operations should define a 401 response.
$.paths[*][get,post,put,delete,patch].responses
warn
schema-description-required
Top-level component schemas must have a description.
$.components.schemas[*]
info
schema-properties-snake-case
Schema property names should use snake_case (Vault convention with __v/__c suffixes).
$.components.schemas[*].properties[*]~
error
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
security-global-defined
Global security must be defined.
$
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
info
vault-session-auth
Vault operations should use VaultSession security scheme.
$.paths[*][get,post,put,delete,patch]
info
vault-response-status
Vault API responses should include responseStatus in schemas.
$.components.schemas[*].properties
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description

Spectral Ruleset

Raw ↑ 
rules:

  # INFO / METADATA
  info-title-required:
    description: Info title must be defined.
    severity: error
    given: "$.info"
    then:
      field: title
      function: truthy

  info-title-prefix:
    description: Info title must start with "Veeva".
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^Veeva"

  info-description-required:
    description: Info description must be defined and non-empty.
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy

  info-version-required:
    description: API version must be defined.
    severity: error
    given: "$.info"
    then:
      field: version
      function: truthy

  info-contact-required:
    description: Contact information must be defined.
    severity: warn
    given: "$.info"
    then:
      field: contact
      function: truthy

  # OPENAPI VERSION
  openapi-version-3:
    description: Must use OpenAPI 3.x.
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  # SERVERS
  servers-defined:
    description: At least one server must be defined.
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  servers-https:
    description: Server URLs must use HTTPS.
    severity: error
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  servers-description:
    description: Each server must have a description.
    severity: warn
    given: "$.servers[*]"
    then:
      field: description
      function: truthy

  # PATHS — NAMING CONVENTIONS
  paths-kebab-case:
    description: Path segments must use kebab-case (lowercase with hyphens, not underscores or camelCase).
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^(/[a-z0-9{}_-]+)+$"

  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash.
    severity: warn
    given: "$.paths[*]~"
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  # OPERATIONS
  operation-summary-required:
    description: Every operation must have a summary.
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: truthy

  operation-summary-title-case:
    description: Operation summaries must start with "Veeva" (company name prefix).
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Veeva "

  operation-description-required:
    description: Every operation must have a description.
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: description
      function: truthy

  operation-operationid-required:
    description: Every operation must have an operationId.
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy

  operation-operationid-camelcase:
    description: operationId must use camelCase.
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch].operationId"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]+$"

  operation-tags-required:
    description: Every operation must have at least one tag.
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy

  # TAGS
  tags-defined:
    description: Global tags array should be defined.
    severity: warn
    given: "$"
    then:
      field: tags
      function: truthy

  tag-description-required:
    description: Each tag must have a description.
    severity: warn
    given: "$.tags[*]"
    then:
      field: description
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: All parameters must have a description.
    severity: warn
    given: "$..parameters[*]"
    then:
      field: description
      function: truthy

  parameter-schema-type:
    description: All parameters must have a schema with a type.
    severity: warn
    given: "$..parameters[*].schema"
    then:
      field: type
      function: truthy

  # REQUEST BODIES
  requestbody-description-required:
    description: Request bodies should have a description.
    severity: info
    given: "$.paths[*][post,put,patch].requestBody"
    then:
      field: description
      function: truthy

  # RESPONSES
  response-success-required:
    description: Every operation must have at least one success (2xx) response.
    severity: error
    given: "$.paths[*][get,post,put,delete,patch].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["200"]
            - required: ["201"]
            - required: ["204"]

  response-description-required:
    description: All responses must have a description.
    severity: error
    given: "$.paths[*][get,post,put,delete,patch].responses[*]"
    then:
      field: description
      function: truthy

  response-401-defined:
    description: Authenticated operations should define a 401 response.
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch].responses"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ["401"]

  # SCHEMAS — PROPERTY NAMING
  schema-description-required:
    description: Top-level component schemas must have a description.
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy

  schema-properties-snake-case:
    description: Schema property names should use snake_case (Vault convention with __v/__c suffixes).
    severity: info
    given: "$.components.schemas[*].properties[*]~"
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-z0-9_]*(__v|__c)?$"

  # SECURITY
  security-schemes-defined:
    description: Security schemes must be defined in components.
    severity: error
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy

  security-global-defined:
    description: Global security must be defined.
    severity: warn
    given: "$"
    then:
      field: security
      function: truthy

  # HTTP METHOD CONVENTIONS
  get-no-request-body:
    description: GET operations must not have a request body.
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy

  delete-no-request-body:
    description: DELETE operations should not have a request body.
    severity: warn
    given: "$.paths[*].delete"
    then:
      field: requestBody
      function: falsy

  # VAULT-SPECIFIC RULES
  vault-session-auth:
    description: Vault operations should use VaultSession security scheme.
    severity: info
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ["security"]
            - {}

  vault-response-status:
    description: Vault API responses should include responseStatus in schemas.
    severity: info
    given: "$.components.schemas[*].properties"
    then:
      function: schema
      functionOptions:
        schema:
          type: object

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"