extends: "spectral:oas" rules: info-title-amtrust: description: API title must include AmTrust Financial Services severity: warn given: "$.info.title" then: function: pattern functionOptions: match: "^AmTrust" info-description-required: description: Info must have a description severity: error given: "$.info" then: field: description function: truthy servers-https-only: description: All servers must use HTTPS severity: error given: "$.servers[*].url" then: function: pattern functionOptions: match: "^https://" operation-summary-required: description: All operations must have summaries severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: summary function: truthy operation-operationid-required: description: All operations must have operationIds severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: operationId function: truthy operation-tags-required: description: All operations must have tags severity: error 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-success-required: description: All operations must have success responses severity: error given: "$.paths[*][get,post,put,patch,delete].responses" then: function: schema functionOptions: schema: anyOf: - required: ['200'] - required: ['201'] - required: ['204'] security-schemes-defined: description: Security schemes must be defined severity: error given: "$.components" then: field: securitySchemes function: truthy schema-properties-typed: description: Schema properties should have explicit types severity: warn given: "$.components.schemas[*].properties[*]" then: field: type function: truthy