rules: # INFO / METADATA info-title-required: description: Info title must be present and non-empty. severity: error given: "$.info" then: field: title function: truthy info-description-required: description: Info description must be present with minimum length. severity: warn given: "$.info" then: field: description function: truthy info-version-required: description: Info version must be present. severity: error given: "$.info" then: field: version function: truthy # OPENAPI VERSION openapi-version-3: description: OpenAPI version must be 3.x. severity: error given: "$" then: field: openapi function: pattern functionOptions: match: "^3\\." # SERVERS servers-required: description: Servers must be defined. severity: error given: "$" then: field: servers function: truthy servers-https: description: All server URLs must use HTTPS. severity: error given: "$.servers[*]" then: field: url function: pattern functionOptions: match: "^https://" # PATHS paths-kebab-case: description: Path segments should use kebab-case. severity: warn given: "$.paths[*]~" then: function: pattern functionOptions: match: "^(/[a-z0-9{}-]+)+$" paths-no-trailing-slash: description: Paths must not have trailing slashes. severity: warn given: "$.paths[*]~" then: function: pattern functionOptions: notMatch: "/$" # OPERATIONS 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-summary-amazon-prefix: description: Operation summaries must start with 'Amazon MediaConnect'. severity: warn given: "$.paths[*][get,post,put,patch,delete].summary" then: function: pattern functionOptions: match: "^Amazon MediaConnect" operation-description-required: description: Every operation must have a description. severity: warn given: "$.paths[*][get,post,put,patch,delete]" then: field: description function: truthy 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 # PARAMETERS parameter-description-required: description: All parameters must have a description. severity: warn given: "$.paths[*][get,post,put,patch,delete].parameters[*]" then: field: description function: truthy # RESPONSES operation-success-response: description: Operations must have at least one 2xx response. severity: error given: "$.paths[*][get,post,put,patch,delete].responses" then: function: schema functionOptions: schema: minProperties: 1 response-description-required: description: All responses must have a description. severity: error given: "$.paths[*][get,post,put,patch,delete].responses[*]" then: field: description function: truthy # SCHEMAS schema-property-description: description: Top-level schema properties should have descriptions. severity: info given: "$.components.schemas[*].properties[*]" then: field: description function: truthy # SECURITY security-schemes-defined: description: Security schemes should be defined in components. severity: warn given: "$.components" then: field: securitySchemes function: truthy # HTTP METHODS get-no-request-body: description: GET operations must not have a request body. severity: error given: "$.paths[*].get" then: field: requestBody function: falsy delete-no-request-body: description: DELETE operations should not have a request body. severity: warn given: "$.paths[*].delete" then: field: requestBody function: falsy