rules: # INFO / METADATA info-title-required: description: Info title must be present and follow "Appium ..." pattern severity: error given: $.info then: field: title function: truthy info-description-required: description: Info description must be present and have minimum length severity: warn given: $.info then: field: description function: minLength functionOptions: min: 20 info-version-required: description: API version must be specified severity: error given: $.info then: field: version function: truthy info-license-required: description: License information must be present (Appium is Apache 2.0) severity: warn given: $.info then: field: license function: truthy # OPENAPI VERSION openapi-version-3: description: OpenAPI version must be 3.0.x severity: error given: $ then: field: openapi function: pattern functionOptions: match: "^3\\.0\\." # SERVERS servers-required: description: At least one server must be defined severity: error given: $ then: field: servers function: truthy servers-description-required: description: Each server must 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 (lowercase, hyphens) severity: warn given: $.paths then: field: "@key" function: pattern functionOptions: match: "^(/[a-z0-9{}/_-]+)+$" paths-no-trailing-slash: description: Paths must not end with a trailing slash severity: warn 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-appium-prefix: description: Operation summary must start with "Appium" severity: warn given: $.paths[*][get,post,put,patch,delete] then: field: summary function: pattern functionOptions: match: "^Appium " 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-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] then: field: operationId function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9]+$" 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: Every parameter must have a description severity: warn given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: description function: truthy parameter-schema-required: description: Every parameter must have a schema severity: error given: $.paths[*][get,post,put,patch,delete].parameters[*] then: field: schema 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 operation-success-response-required: description: Every operation must have a 2xx response defined 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 # SCHEMAS — PROPERTY NAMING schema-description-required: description: Top-level schemas should have a description severity: warn given: $.components.schemas[*] then: field: description function: truthy schema-title-required: description: Component schemas must have a title severity: warn given: $.components.schemas[*] then: field: title function: truthy schema-properties-snake-case: description: Schema property names should use camelCase or snake_case consistently severity: info given: $.components.schemas[*].properties then: field: "@key" function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9_-]*$" # HTTP METHOD CONVENTIONS http-get-no-request-body: description: GET operations must not have a request body severity: error given: $.paths[*].get then: field: requestBody function: falsy http-delete-no-request-body: description: DELETE operations should not have a request body severity: warn given: $.paths[*].delete then: field: requestBody function: falsy # GENERAL QUALITY no-empty-descriptions: description: Descriptions must not be empty strings severity: warn given: $..description then: function: pattern functionOptions: match: ".+" microcks-operation-extension: description: Operations should include x-microcks-operation extension for mock server compatibility severity: info given: $.paths[*][get,post,put,patch,delete] then: field: x-microcks-operation function: truthy