# amazon-health-dashboard — 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: 67% of servers already https (warn) # - query-params-casing: camel @ 100% (n=14) # - operationid-casing: pascal @ 100% (n=13) # - schema-names-casing: pascal @ 56% (n=103) # - schema-properties-casing: camel @ 73% (n=146) # - security: global (root) — NOT emitting operation-security-required # - error-schema-defined: OrganizationAffectedEntitiesErrorItem # - pagination params observed: ['maxResults', 'nextToken'] # - merge: kept 7 existing, added 8 measured, upgraded 0 # - added: servers-https-only, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, error-schema-defined, no-empty-descriptions extends: - spectral:oas rules: info-title-format: severity: warn given: $.info.title then: function: pattern functionOptions: match: ^Amazon Health|^AWS Health info-description-required: severity: error given: $.info then: field: description function: truthy operation-summary-required: severity: error given: $.paths[*][get,post,put,patch,delete] then: field: summary function: truthy operation-id-required: severity: error given: $.paths[*][get,post,put,patch,delete] then: field: operationId function: truthy operation-summary-company-prefix: severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: ^Amazon Health Dashboard response-success-required: severity: error given: $.paths[*][get,post,put,patch,delete].responses then: function: schema functionOptions: schema: type: object anyOf: - required: - '200' - required: - '201' - required: - '204' microcks-operation-extension: severity: info given: $.paths[*][get,post,put,patch,delete] then: field: x-microcks-operation function: truthy servers-https-only: description: Server URLs must use HTTPS. severity: warn given: $.servers[*].url then: function: pattern functionOptions: match: ^https:// 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 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: info 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 security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: $.components then: field: securitySchemes function: truthy error-schema-defined: description: A shared error schema (OrganizationAffectedEntitiesErrorItem) should be defined for error payloads. severity: warn given: $.components.schemas then: field: OrganizationAffectedEntitiesErrorItem function: truthy no-empty-descriptions: description: Descriptions must not be empty strings. severity: warn given: $..description then: function: truthy