# amazon-security-lake — 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 # - path-params-casing: camel @ 100% (n=5) # - query-params-casing: camel @ 80% (n=5) # - operationid-casing: pascal @ 100% (n=13) # - schema-names-casing: pascal @ 100% (n=8) # - schema-properties-casing: camel @ 82% (n=28) # - security: global (root) — NOT emitting operation-security-required # - pagination params observed: ['maxResults', 'nextToken'] # - merge: kept 21 existing, added 7 measured, upgraded 0 # - added: servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, no-empty-descriptions extends: - spectral:oas rules: info-title-required: description: Info title must be present severity: error given: $.info then: field: title function: truthy info-description-required: description: Info description must be present severity: warn given: $.info then: field: description function: truthy info-version-required: description: Info version must be present severity: error given: $.info then: field: version function: truthy openapi-version-3: description: Must use OpenAPI 3.x severity: error given: $ then: field: openapi function: pattern functionOptions: match: ^3\. servers-required: description: Servers must be defined severity: error given: $ then: field: servers function: truthy servers-https-only: description: Server URLs must use HTTPS severity: error given: $.servers[*] then: field: url function: pattern functionOptions: match: ^https:// paths-versioned: description: Paths should be versioned with /v1/ prefix severity: info given: $.paths then: function: pattern functionOptions: match: ^/v[0-9]/ paths-kebab-case: description: Path segments must use kebab-case severity: warn given: $.paths then: function: pattern functionOptions: match: ^(/v[0-9]/[a-z0-9-]+)*(/\{[a-z][a-zA-Z0-9]*\})*$ operation-summary-required: description: Every operation must have a summary severity: error given: $.paths[*][get,post,put,patch,delete] then: field: summary function: truthy operation-summary-prefix: description: Operation summaries must start with "Amazon Security Lake" severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: ^Amazon Security Lake operation-description-required: description: Every operation must have a description severity: warn given: $.paths[*][get,post,put,patch,delete] then: field: description function: truthy operation-id-required: description: Every operation must have an operationId severity: error given: $.paths[*][get,post,put,patch,delete] then: field: operationId function: truthy operation-id-pascal-case: description: operationId must use PascalCase severity: warn given: $.paths[*][get,post,put,patch,delete].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,patch,delete] then: field: tags function: truthy parameter-description-required: description: Every parameter must have a description severity: warn given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: description function: truthy response-success-required: description: Every operation must have a success response severity: error given: $.paths[*][get,post,put,patch,delete].responses then: function: schema functionOptions: schema: anyOf: - required: - '200' - required: - '201' - required: - '204' response-description-required: description: Every response must have a description severity: warn given: $.paths[*][get,post,put,patch,delete].responses[*] then: field: description function: truthy schema-description-recommended: description: Top-level component schemas should have descriptions severity: info given: $.components.schemas[*] then: field: description function: truthy security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: $.components then: field: securitySchemes function: truthy global-security-defined: description: Global security should be defined severity: warn given: $ then: field: security function: truthy microcks-operation-present: description: Operations should have x-microcks-operation for mock support severity: info given: $.paths[*][get,post,put,patch,delete] then: field: x-microcks-operation function: truthy 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 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 camelCase (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: 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 camelCase (the dominant convention in this API). severity: info given: $.components.schemas[*].properties then: field: '@key' function: casing functionOptions: type: camel no-empty-descriptions: description: Descriptions must not be empty strings. severity: warn given: $..description then: function: truthy