# aws-x-ray — 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: 1/1 servers on amazonaws.com # - operationid-casing: pascal @ 100% (n=22) # - schema-names-casing: pascal @ 100% (n=19) # - schema-properties-casing: pascal @ 100% (n=117) # - security: global (root) — NOT emitting operation-security-required # - merge: kept 5 existing, added 7 measured, upgraded 0 # - added: servers-https-only, servers-expected-domain, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, no-empty-descriptions extends: - spectral:oas rules: xray-operation-summary: description: All operations must have a summary starting with "AWS X-Ray" severity: warn given: $.paths[*][get,post,put,delete,patch] then: field: summary function: pattern functionOptions: match: ^AWS X-Ray xray-operation-id: description: All operations must have an operationId severity: error given: $.paths[*][get,post,put,delete,patch] then: field: operationId function: truthy xray-info-title: description: Info object must have a title severity: error given: $.info then: field: title function: truthy xray-response-description: description: All responses must have a description severity: error given: $.paths[*][*].responses[*] then: field: description function: truthy xray-microcks-annotation: description: Operations should have x-microcks-operation annotation severity: info given: $.paths[*][get,post,put,delete,patch] then: field: x-microcks-operation function: truthy 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 amazonaws.com domain. severity: warn given: $.servers[*].url then: function: pattern functionOptions: match: amazonaws\.com operationid-casing: description: Operation IDs should be PascalCase (the dominant convention in this API). severity: warn given: $.paths[*][get,post,put,patch,delete].operationId then: function: casing functionOptions: type: pascal 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 PascalCase (the dominant convention in this API). severity: warn given: $.components.schemas[*].properties then: field: '@key' function: pattern functionOptions: match: ^[A-Z][A-Za-z0-9]*$ security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: $.components then: field: securitySchemes function: truthy no-empty-descriptions: description: Descriptions must not be empty strings. severity: warn given: $..description then: function: truthy