# amazon-devops-guru — 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: 50% of servers already https (warn) # - path-params-casing: pascal @ 100% (n=7) # - query-params-casing: pascal @ 100% (n=24) # - operationid-casing: pascal @ 100% (n=31) # - schema-names-casing: pascal @ 100% (n=321) # - schema-properties-casing: pascal @ 100% (n=426) # - security: global (root) — NOT emitting operation-security-required # - merge: kept 17 existing, added 6 measured, upgraded 0 # - added: path-params-casing, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined extends: - spectral:oas rules: info-title-prefix: description: API title should include "DevOps Guru" severity: warn given: $.info.title then: function: pattern functionOptions: match: DevOps Guru 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-3: description: Must use OpenAPI 3.x severity: error given: $ then: field: openapi function: pattern functionOptions: match: ^3\. servers-defined: description: At least one server must be defined severity: error given: $ then: field: servers function: truthy servers-https-only: description: All 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-description-required: description: All operations must have a description severity: warn given: $.paths[*][get,post,put,delete,patch] then: field: description function: truthy operation-id-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 at least one tag severity: warn given: $.paths[*][get,post,put,delete,patch] then: field: tags function: truthy parameter-description-required: description: All parameters must have a description severity: warn given: $.paths[*][get,post,put,delete,patch].parameters[*] then: field: description function: truthy response-success-required: description: Operations must have at least one 2xx response severity: error given: $.paths[*][get,post,put,delete,patch].responses then: function: schema functionOptions: schema: type: object anyOf: - required: - '200' - required: - '202' - required: - '204' response-description-required: description: All responses must have a description severity: error given: $.paths[*][get,post,put,delete,patch].responses[*] then: field: description function: truthy schema-description-required: description: Top-level schemas should have descriptions severity: info given: $.components.schemas[*] then: field: description function: truthy get-no-request-body: description: GET operations must not have a request body severity: error given: $.paths[*].get then: field: requestBody function: falsy no-empty-descriptions: description: Descriptions must not be empty strings severity: error given: $..description then: function: truthy external-docs-encouraged: description: API should reference external documentation severity: info given: $ then: field: externalDocs function: truthy path-params-casing: description: Path parameters should be PascalCase (the dominant convention in this API). severity: warn given: $.paths[*].parameters[?(@.in=='path')].name then: function: casing functionOptions: type: pascal query-params-casing: description: Query parameters should be PascalCase (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: pascal 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: casing functionOptions: type: pascal security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: $.components then: field: securitySchemes function: truthy