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-title-circana-prefix: description: Info title should start with "Circana" severity: warn given: $.info then: field: title function: pattern functionOptions: match: "^Circana " info-description-required: description: Info description must be present and non-empty severity: error given: $.info then: field: description function: truthy info-description-min-length: description: Info description should be at least 50 characters severity: warn given: $.info.description then: function: length functionOptions: min: 50 info-version-required: description: API version must be specified severity: error given: $.info then: field: version function: truthy info-contact-required: description: Contact information should be provided severity: warn given: $.info then: field: contact 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-defined: description: Servers array must be defined severity: error given: $ then: field: servers function: truthy servers-https: description: Server URLs should 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 should use kebab-case severity: warn given: $.paths then: field: "@key" function: pattern functionOptions: match: "^(/[a-z0-9\\-{}]+)+$" paths-no-trailing-slash: description: Paths must not have trailing slashes severity: error given: $.paths then: field: "@key" 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-circana-prefix: description: Operation summaries should start with "Circana" severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: "^Circana " 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-operationid-required: description: Every operation must have an operationId severity: error given: $.paths[*][get,post,put,patch,delete] then: field: operationId function: truthy operation-operationid-camelcase: description: operationId should 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 # ─── TAGS ─────────────────────────────────────────────────────────── tag-description: description: Tags should have descriptions severity: info given: $.tags[*] then: field: description function: truthy tag-title-case: description: Tag names should use Title Case severity: warn given: $.tags[*].name then: function: pattern functionOptions: match: "^[A-Z][a-zA-Z]*(\\s[A-Za-z][a-zA-Z]*)*$" # ─── PARAMETERS ───────────────────────────────────────────────────── parameter-description-required: description: Every parameter must have a description severity: error given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: description function: truthy parameter-snake-case: description: Parameter names should use snake_case severity: warn given: $.paths[*][get,post,put,patch,delete].parameters[*].name then: function: pattern functionOptions: match: "^[a-z][a-z0-9]*(_[a-z0-9]+)*$" parameter-schema-required: description: Parameters must have a schema with type severity: error given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: schema function: truthy parameter-example-recommended: description: Parameters should include an example value severity: info given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: example function: truthy # ─── REQUEST BODIES ───────────────────────────────────────────────── request-body-json-content: description: Request bodies should use application/json content type severity: warn given: $.paths[*][post,put,patch].requestBody.content then: field: application/json function: truthy # ─── RESPONSES ────────────────────────────────────────────────────── response-success-required: description: Every operation must have a success response (2xx) severity: error given: $.paths[*][get,post,put,patch,delete].responses then: function: schema functionOptions: schema: anyOf: - required: ["200"] - required: ["201"] - required: ["202"] - required: ["204"] response-401-required: description: Operations should include a 401 Unauthorized 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[*][get,post,put,patch,delete].responses[*] then: field: description function: truthy # ─── SCHEMAS — PROPERTY NAMING ───────────────────────────────────── schema-property-snake-case: description: Schema property names should use snake_case severity: warn given: $.components.schemas[*].properties then: field: "@key" function: pattern functionOptions: match: "^[a-z][a-z0-9]*(_[a-z0-9]+)*$" schema-description-required: description: Top-level schemas should have descriptions severity: warn given: $.components.schemas[*] then: field: description function: truthy schema-type-required: description: Schema properties must define a type severity: error given: $.components.schemas[*].properties[*] then: function: schema functionOptions: schema: anyOf: - required: ["type"] - required: ["$ref"] - required: ["oneOf"] - required: ["anyOf"] - required: ["allOf"] # ─── SECURITY ─────────────────────────────────────────────────────── security-global-defined: description: Global security must be defined severity: error given: $ then: field: security function: truthy security-schemes-defined: description: Security schemes must be defined in components severity: error given: $.components then: field: securitySchemes function: truthy security-scheme-description: description: Security schemes should have descriptions severity: warn given: $.components.securitySchemes[*] 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 post-request-body-required: description: POST operations should have a request body severity: info given: $.paths[*].post then: field: requestBody function: truthy # ─── GENERAL QUALITY ──────────────────────────────────────────────── no-empty-descriptions: description: Descriptions must not be empty strings severity: error given: $.paths[*][get,post,put,patch,delete].description then: function: truthy examples-recommended: description: Response schemas should include examples severity: info given: $.paths[*][get,post,put,patch,delete].responses[*].content.application/json then: field: examples function: truthy pagination-offset-limit: description: Paginated endpoints should use offset/limit parameters severity: info given: $.paths[*].get.parameters[?(@.name=='offset' || @.name=='limit')] then: function: truthy microcks-operation-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