# amazon-lakeformation — 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=7) # - schema-properties-casing: pascal @ 100% (n=11) # - security: global (root) — NOT emitting operation-security-required # - operation-documents-400: 100% adherence # - operation-documents-403: 100% adherence # - operation-documents-500: 100% adherence # - merge: kept 16 existing, added 7 measured, upgraded 0 # - added: servers-expected-domain, operationid-casing, schema-properties-casing, operation-documents-400, operation-documents-403, operation-documents-500, no-empty-descriptions extends: - spectral:oas rules: info-title-format: description: API title must start with "AWS Lake Formation" severity: warn given: $.info.title then: function: pattern functionOptions: match: ^AWS Lake Formation info-description-required: description: API must have a description severity: error given: $.info then: field: description function: truthy info-version-required: description: API must have a version severity: error given: $.info then: field: version function: truthy openapi-version: 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: description: Server URLs must use HTTPS severity: error given: $.servers[*].url then: function: pattern functionOptions: match: ^https:// operation-summary-required: description: All operations must have a summary severity: error given: $.paths[*][get,post,put,delete,patch] then: field: summary function: truthy operation-summary-prefix: description: Summaries must start with "AWS Lake Formation" severity: warn given: $.paths[*][get,post,put,delete,patch].summary then: function: pattern functionOptions: match: ^AWS Lake Formation operation-description-required: description: All operations must have a description severity: error given: $.paths[*][get,post,put,delete,patch] then: field: description function: truthy operation-operationid-required: description: All operations must have an operationId severity: error given: $.paths[*][get,post,put,delete,patch] then: field: operationId function: truthy operation-tags-required: description: All operations must have tags severity: warn given: $.paths[*][get,post,put,delete,patch] then: field: tags function: truthy parameter-description-required: description: All parameters must have descriptions severity: warn given: $.paths[*][*].parameters[*] then: field: description function: truthy security-schemes-required: description: Security schemes must be defined severity: error given: $.components then: field: securitySchemes function: truthy security-global-required: description: Global security must be defined severity: warn given: $ then: field: security function: truthy paths-kebab-case: description: Path segments should use kebab-case severity: warn given: $.paths then: function: pattern functionOptions: match: ^(/[a-zA-Z0-9{}/-]+)+$ schema-description-required: description: Schema components should have descriptions severity: warn given: $.components.schemas[*] then: field: description 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 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-properties-casing: description: Schema properties should be PascalCase (the dominant convention in this API). severity: warn given: $.components.schemas[*].properties then: field: '@key' function: casing functionOptions: type: pascal operation-documents-400: description: Operations should document a 400 response (documented on 100% of this API's operations). severity: warn given: $.paths[*][get,post,put,patch,delete].responses then: field: '400' function: truthy operation-documents-403: description: Operations should document a 403 response (documented on 100% of this API's operations). severity: warn given: $.paths[*][get,post,put,patch,delete].responses then: field: '403' function: truthy operation-documents-500: description: Operations should document a 500 response (documented on 100% of this API's operations). severity: warn given: $.paths[*][get,post,put,patch,delete].responses then: field: '500' function: truthy no-empty-descriptions: description: Descriptions must not be empty strings. severity: warn given: $..description then: function: truthy