# ambassador — 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) # - path-params-casing: snake @ 100% (n=37) # - query-params-casing: camel @ 50% (n=8) # - operationid-casing: camel @ 100% (n=26) # - schema-names-casing: pascal @ 100% (n=24) # - schema-properties-casing: snake @ 86% (n=140) # - security: global (root) — NOT emitting operation-security-required # - operation-documents-401: 92% adherence # - pagination params observed: ['limit'] # - merge: kept 7 existing, added 8 measured, upgraded 0 # - added: servers-https-only, path-params-casing, query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, operation-documents-401 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: error given: $.info then: field: description function: truthy operation-operationid-required: description: Every operation must have an operationId severity: error given: $.paths[*][get,post,put,patch,delete] then: field: operationId function: truthy 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-tags-required: description: Every operation must have tags severity: error given: $.paths[*][get,post,put,patch,delete] then: field: tags function: truthy response-description-required: description: Every response must have a description severity: error given: $.paths[*][get,post,put,patch,delete].responses[*] then: field: description function: truthy no-empty-descriptions: description: Descriptions must not be empty severity: error given: $..description then: function: truthy servers-https-only: description: Server URLs must use HTTPS. severity: error given: $.servers[*].url then: function: pattern functionOptions: match: ^https:// path-params-casing: description: Path parameters should be snake_case (the dominant convention in this API). severity: warn given: $.paths[*].parameters[?(@.in=='path')].name then: function: casing functionOptions: type: snake query-params-casing: description: Query parameters should be camelCase (the dominant convention in this API). severity: info 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 camelCase (the dominant convention in this API). severity: warn given: $.paths[*][get,post,put,patch,delete].operationId then: function: pattern functionOptions: match: ^[a-z][A-Za-z0-9]*$ 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: pattern functionOptions: match: ^[A-Z][A-Za-z0-9]*$ 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 security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: $.components then: field: securitySchemes function: truthy operation-documents-401: description: Operations should document a 401 response (documented on 92% of this API's operations). severity: warn given: $.paths[*][get,post,put,patch,delete].responses then: field: '401' function: truthy