rules: # ── INFO / METADATA ────────────────────────────────────────────────── info-title-required: description: Info object must have a title severity: error given: $.info then: field: title function: truthy info-title-prefix: description: Title should start with "Veritas InfoScale" severity: warn given: $.info.title then: function: pattern functionOptions: match: "^Veritas InfoScale" info-description-required: description: Info object must have a description 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: Info object must have a version severity: error given: $.info then: field: version function: truthy info-contact-required: description: Info object should have contact information severity: warn given: $.info then: field: contact function: truthy # ── OPENAPI VERSION ────────────────────────────────────────────────── openapi-version: description: OpenAPI version should be 3.0.x severity: error given: $.openapi then: function: pattern functionOptions: match: "^3\\.0\\." # ── SERVERS ────────────────────────────────────────────────────────── servers-defined: 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-no-trailing-slash: description: Paths must not end with a trailing slash severity: error given: $.paths then: field: "@key" function: pattern functionOptions: notMatch: "\\/$" paths-no-query-strings: description: Paths must not contain query strings severity: error given: $.paths then: field: "@key" function: pattern functionOptions: notMatch: "\\?" paths-lowercase: description: Path segments should use lowercase severity: warn given: $.paths then: field: "@key" function: pattern functionOptions: match: "^[a-z0-9/{}_-]+$" # ── 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-prefix: description: Operation summaries should start with "Veritas InfoScale" severity: warn given: $.paths[*][get,post,put,patch,delete].summary then: function: pattern functionOptions: match: "^Veritas InfoScale" 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-camel-case: description: Operation IDs 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 ───────────────────────────────────────────────────────────── tags-defined: description: Global tags array should be defined severity: warn given: $ then: field: tags function: truthy tag-description: description: Each global tag should have a description severity: info given: $.tags[*] then: field: description function: truthy # ── PARAMETERS ────────────────────────────────────────────────────── parameter-description-required: description: Every parameter must have a description severity: error given: $..parameters[*] then: field: description function: truthy parameter-schema-required: description: Every parameter must have a schema with a type severity: error given: $..parameters[*] then: field: schema function: truthy parameter-path-required: description: Path parameters must be required severity: error given: $..parameters[?(@.in == 'path')] then: field: required function: truthy # ── REQUEST BODIES ────────────────────────────────────────────────── request-body-json: 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 define 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: ['204'] 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 response-401-defined: description: Operations should define a 401 Unauthorized response severity: info given: $.paths[*][get,post,put,patch,delete].responses then: field: '401' function: truthy # ── SCHEMAS — PROPERTY NAMING ──────────────────────────────────────── schema-type-defined: description: All schemas must define a type severity: error given: $.components.schemas[*] then: field: type function: truthy schema-properties-camel-case: description: Schema properties should use camelCase (Veritas convention) severity: info given: $.components.schemas[*].properties then: field: "@key" function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9]*$" # ── SECURITY ───────────────────────────────────────────────────────── security-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-bearer-scheme: description: Bearer token security scheme should be defined for InfoScale APIs severity: warn given: $.components.securitySchemes then: field: bearerAuth 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 must not have a request body severity: error given: $.paths[*].delete then: field: requestBody function: falsy post-request-body: 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: $..description then: function: truthy schema-description: description: Top-level schemas should have descriptions severity: info given: $.components.schemas[*] then: field: description function: truthy microcks-operation-extension: description: Operations should have x-microcks-operation for mock compatibility severity: info given: $.paths[*][get,post,put,patch,delete] then: field: x-microcks-operation function: truthy