# aws-app-mesh — 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: camel @ 100% (n=61) # - query-params-casing: camel @ 84% (n=50) # - operationid-casing: pascal @ 100% (n=38) # - schema-names-casing: pascal @ 100% (n=333) # - schema-properties-casing: snake @ 54% (n=476) # - security: global (root) — NOT emitting operation-security-required # - error-schema-defined: InternalServerErrorException # - pagination params observed: ['limit', 'nextToken'] # - merge: kept 19 existing, added 6 measured, upgraded 0 # - added: path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, error-schema-defined extends: - spectral:oas rules: info-title-prefix: description: API title must start with "AWS App Mesh" severity: warn given: $.info.title then: function: pattern functionOptions: match: ^AWS App Mesh info-description-required: description: Info object must have a description severity: error given: $.info then: field: description function: truthy info-version-required: description: Info object must have a version severity: error given: $.info then: field: version function: truthy openapi-version-3: description: All specs must use OpenAPI 3.x severity: error given: $ then: field: openapi function: pattern functionOptions: match: ^3\. servers-defined: description: Servers array must be defined severity: error given: $ then: field: servers function: truthy servers-https: description: All server URLs must use HTTPS severity: error given: $.servers[*].url then: function: pattern functionOptions: match: ^https:// 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 "AWS App Mesh" severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: ^AWS App Mesh operation-description-required: description: Every operation must have a description severity: error 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: OperationIds should 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: All parameters must have descriptions severity: warn given: $.paths[*][*].parameters[*] then: field: description function: truthy response-description-required: description: All responses must have descriptions severity: error given: $.paths[*][*].responses[*] then: field: description function: truthy schema-description: description: Component schemas should have descriptions severity: warn 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 method-get-no-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 severity: error given: $..description then: function: pattern functionOptions: match: .+ deprecation-documented: description: Deprecated operations should have a description severity: warn given: $.paths[*][*][?(@.deprecated == true)] then: field: description function: truthy 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 snake_case (the dominant convention in this API). severity: info given: $.components.schemas[*].properties then: field: '@key' function: casing functionOptions: type: snake error-schema-defined: description: A shared error schema (InternalServerErrorException) should be defined for error payloads. severity: warn given: $.components.schemas then: field: InternalServerErrorException function: truthy