Apache CloudStack API Rules

# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# apache-cloudstack — 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:
#   - query-params-casing: snake @ 100% (n=33)
#   - operationid-casing: camel @ 100% (n=8)
#   - schema-names-casing: pascal @ 100% (n=10)
#   - schema-properties-casing: snake @ 100% (n=34)
#   - operation-security-required: 8/8 ops declare per-op security
#   - operation-documents-401: 100% adherence
#   - merge: kept 12 existing, added 7 measured, upgraded 0
#   - added: query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, operation-documents-401, no-empty-descriptions
extends:
  - spectral:oas
rules:
  cloudstack-api-info-title:
    description: API info must have a title
    message: API info.title is required
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  cloudstack-api-info-description:
    description: API info must have a description
    message: API info.description is required
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  cloudstack-api-info-version:
    description: API info must have a version
    message: API info.version is required
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  cloudstack-api-operation-id:
    description: All operations must have an operationId
    message: Operation must have an operationId
    severity: error
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: operationId
      function: truthy
  cloudstack-api-operation-summary:
    description: All operations must have a summary
    message: Operation must have a summary
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: summary
      function: truthy
  cloudstack-api-operation-tags:
    description: All operations must have at least one tag
    message: Operation must have at least one tag
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: tags
      function: truthy
  cloudstack-api-response-200:
    description: GET operations should have a 200 response
    message: GET operations should define a 200 response
    severity: warn
    given: $.paths[*][get]
    then:
      field: responses.200
      function: truthy
  cloudstack-api-schema-title:
    description: All component schemas must have a title
    message: Schema must have a title
    severity: warn
    given: $.components.schemas[*]
    then:
      field: title
      function: truthy
  cloudstack-api-schema-description:
    description: All component schemas must have a description
    message: Schema must have a description
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  cloudstack-api-summary-prefix:
    description: Operation summaries should start with Apache CloudStack
    message: Operation summary should begin with "Apache CloudStack"
    severity: warn
    given: $.paths[*][get,put,post,delete,patch].summary
    then:
      function: pattern
      functionOptions:
        match: ^Apache CloudStack
  cloudstack-api-apikey-security:
    description: All operations should use apiKeyAuth security
    message: Operation should declare apiKeyAuth security
    severity: warn
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: security
      function: truthy
  cloudstack-api-microcks-operation:
    description: All operations should have x-microcks-operation extension
    message: Operation should include x-microcks-operation for mock support
    severity: info
    given: $.paths[*][get,put,post,delete,patch]
    then:
      field: x-microcks-operation
      function: truthy
  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
  operationid-casing:
    description: Operation IDs should be camelCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  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: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: snake
  security-schemes-defined:
    description: Security schemes should be defined in components.
    severity: warn
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  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