Trellix API Rules

# trellix — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 2/2 servers on trellix.com
#   - path-params-casing: camel @ 100% (n=6)
#   - query-params-casing: snake @ 94% (n=34)
#   - operationid-casing: camel @ 100% (n=21)
#   - schema-names-casing: pascal @ 100% (n=19)
#   - schema-properties-casing: snake @ 52% (n=103)
#   - security: global (root) — NOT emitting operation-security-required
#   - operation-documents-401: 100% adherence
#   - pagination params observed: ['limit', 'offset']
#   - merge: kept 9 existing, added 8 measured, upgraded 0
#   - added: servers-https-only, servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, operation-documents-401, no-empty-descriptions
extends:
  - spectral:oas
rules:
  trellix-operation-id-camel-case:
    description: Operation IDs must use camelCase
    message: Operation ID '{{value}}' must use camelCase
    severity: warn
    given: $.paths[*][*].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  trellix-summary-title-case:
    description: Operation summaries must use Title Case
    message: Summary '{{value}}' should use Title Case
    severity: warn
    given: $.paths[*][*].summary
    then:
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9 /()+&-]*$
  trellix-security-defined:
    description: All operations must define security requirements
    message: Operation must define security requirements
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: security
      function: defined
  trellix-response-200-get:
    description: All GET operations must define a 200 response
    message: GET operation must define a 200 success response
    severity: error
    given: $.paths[*].get
    then:
      field: responses.200
      function: defined
  trellix-response-401-defined:
    description: Authenticated operations should define a 401 response
    message: Operation should define 401 Unauthorized
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: responses.401
      function: defined
  trellix-tag-defined:
    description: All operations must have at least one tag
    message: Operation must include at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: defined
  trellix-oauth2-bearer:
    description: Trellix APIs use OAuth 2.0 Bearer token authentication
    message: Security scheme should use OAuth 2.0 or Bearer token
    severity: info
    given: $.components.securitySchemes
    then:
      function: defined
  trellix-path-kebab-case:
    description: API paths should use kebab-case
    message: Path should use kebab-case
    severity: warn
    given: $.paths[*]~
    then:
      function: pattern
      functionOptions:
        match: ^(/[a-z0-9][a-z0-9-]*(/[a-z0-9][a-z0-9-]*|/\{[a-zA-Z][a-zA-Z0-9]*\})*)+$
  trellix-post-request-body:
    description: POST and PUT operations should define a request body
    message: POST/PUT operation should define a requestBody
    severity: warn
    given: $.paths[*][post,put]
    then:
      field: requestBody
      function: defined
  servers-https-only:
    description: Server URLs must use HTTPS.
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-expected-domain:
    description: Server URLs should be on the trellix.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: trellix\.com
  path-params-casing:
    description: Path parameters should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*].parameters[?(@.in=='path')].name
    then:
      function: casing
      functionOptions:
        type: camel
  query-params-casing:
    description: Query parameters should be snake_case (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: snake
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  schema-properties-casing:
    description: Schema properties should be snake_case (the dominant convention in this API).
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  operation-documents-401:
    description: Operations should document a 401 response (documented on 100% of this API's operations).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings.
    severity: warn
    given: $..description
    then:
      function: truthy