rules: # INFO / METADATA info-title-required: description: API title must be present. severity: error given: $.info then: field: title function: truthy info-title-prefix: description: API title must start with "Amadeus". severity: warn given: $.info.title then: function: pattern functionOptions: match: "^Amadeus" info-description-required: description: API must have a description. severity: error given: $.info then: field: description function: truthy info-version-required: description: API version must be present. severity: error given: $.info then: field: version function: truthy # OPENAPI VERSION openapi-version-3: description: APIs must use OpenAPI 3.x. severity: error given: $ then: field: openapi function: pattern functionOptions: match: "^3\\." # SERVERS servers-required: description: At least one server must be defined. severity: error given: $ then: field: servers function: truthy servers-https: description: Server URLs must use HTTPS. severity: error given: $.servers[*].url then: function: pattern functionOptions: match: "^https://" servers-description: description: Each server should have a description. severity: warn given: $.servers[*] then: field: description function: truthy # PATHS — NAMING CONVENTIONS paths-kebab-case: description: Path segments must 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: error given: $.paths then: function: pattern functionOptions: notMatch: "/$" # OPERATIONS 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-amadeus-prefix: description: Operation summaries must start with "Amadeus". severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: "^Amadeus " 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-camel-case: description: operationId must use camelCase. 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: error given: $.paths[*][get,post,put,patch,delete] then: field: tags function: truthy operation-microcks-extension: description: Operations should include x-microcks-operation for mock compatibility. severity: info given: $.paths[*][get,post,put,patch,delete] then: field: x-microcks-operation function: truthy # PARAMETERS parameter-description-required: description: Every parameter must have a description. severity: error given: $.paths[*][*].parameters[*] then: field: description function: truthy parameter-schema-required: description: Every parameter must have a schema. severity: error given: $.paths[*][*].parameters[*] then: field: schema function: truthy parameter-snake-case: description: Parameter names should use snake_case or camelCase. severity: info given: $.paths[*][*].parameters[*].name then: function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9_]*$" # RESPONSES response-success-required: description: Every operation must define at least one 2xx response. severity: error given: $.paths[*][get,post,put,patch,delete].responses then: function: schema functionOptions: schema: type: object minProperties: 1 response-400-recommended: description: Operations should define a 400 error response. severity: info given: $.paths[*][get,post,put,patch,delete].responses then: field: '400' function: truthy response-401-recommended: description: Operations should define a 401 error response. severity: warn given: $.paths[*][get,post,put,patch,delete].responses then: field: '401' function: truthy response-description-required: description: Every response must have a description. severity: error given: $.paths[*][*].responses[*] then: field: description function: truthy # SCHEMAS schema-description-recommended: description: Top-level schemas should have descriptions. severity: warn given: $.components.schemas[*] then: field: description function: truthy schema-property-type-required: description: Schema properties should define a type. severity: warn given: $.components.schemas[*].properties[*] then: field: type function: truthy # SECURITY security-schemes-defined: description: Security schemes must be defined in components. severity: error given: $.components then: field: securitySchemes function: truthy security-bearer-described: description: BearerAuth security scheme should have a description. severity: warn given: $.components.securitySchemes.BearerAuth then: field: description function: truthy # HTTP METHOD CONVENTIONS 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 # CONTENT TYPE response-json-content: description: Responses should use application/vnd.amadeus+json or application/json content type. severity: info given: $.paths[*][*].responses[*].content then: function: schema functionOptions: schema: type: object minProperties: 1