rules: # Info rules bifrost-info-title-prefix: description: API title must start with "Bifrost" message: 'Info title must start with "Bifrost": {{value}}' severity: error given: $.info.title then: function: pattern functionOptions: match: "^Bifrost" bifrost-info-version-present: description: API info must have a version field message: Info object must include a version severity: error given: $.info then: field: version function: truthy bifrost-info-contact-present: description: API info must include contact details message: Info object must include contact severity: warn given: $.info then: field: contact function: truthy # Operation rules bifrost-operation-summary-prefix: description: Operation summaries must start with "Bifrost" message: 'Operation summary must start with "Bifrost": {{value}}' severity: error given: "$.paths[*][*].summary" then: function: pattern functionOptions: match: "^Bifrost" bifrost-operation-id-camel-case: description: Operation IDs must be camelCase message: 'OperationId must be camelCase: {{value}}' severity: warn given: "$.paths[*][*].operationId" then: function: pattern functionOptions: match: "^[a-z][a-zA-Z0-9]*$" bifrost-operation-tags-present: description: Every operation must have at least one tag message: Operations must include tags severity: warn given: "$.paths[*][*]" then: field: tags function: truthy bifrost-operation-description-present: description: Every operation must have a description message: Operations must include description severity: warn given: "$.paths[*][*]" then: field: description function: truthy # Path rules bifrost-path-kebab-case: description: Paths must use kebab-case segments message: 'Path segments must be kebab-case: {{value}}' severity: warn given: "$.paths" then: function: pattern functionOptions: match: "^(/[a-z0-9-{}]*)+$" # Request body rules bifrost-request-body-required: description: POST operations must have a request body message: POST operations must include requestBody severity: error given: "$.paths[*].post" then: field: requestBody function: truthy # Response rules bifrost-response-200-present: description: Every operation must define a 200 or 201 response message: Operations must include a 200 response severity: error given: "$.paths[*][*].responses" then: function: schema functionOptions: schema: type: object anyOf: - required: ['200'] - required: ['201'] bifrost-response-error-schema: description: Error responses must reference ErrorResponse schema message: Error responses should reference the ErrorResponse schema severity: warn given: "$.paths[*][*].responses[?(@property >= '400')].content.application/json.schema" then: function: truthy # Schema rules bifrost-schema-title-present: description: All schemas must have a title message: Schemas must include title severity: warn given: "$.components.schemas[*]" then: field: title function: truthy bifrost-schema-description-present: description: All schemas must have a description message: Schemas must include description severity: warn given: "$.components.schemas[*]" then: field: description function: truthy bifrost-schema-properties-described: description: Schema properties must have descriptions message: Schema properties must include description severity: warn given: "$.components.schemas[*].properties[*]" then: field: description function: truthy # Security rules bifrost-security-scheme-present: description: API must define at least one security scheme message: Components must include securitySchemes severity: error given: "$.components" then: field: securitySchemes function: truthy bifrost-operation-security-present: description: Operations should reference a security scheme message: Operations should include security definition severity: warn given: "$.paths[*][post,put,patch,delete]" then: field: security function: truthy # Tag rules bifrost-tags-defined: description: All tags used in operations must be defined at top level message: Tags must be defined in the global tags section severity: warn given: "$.tags" then: function: truthy bifrost-tag-description-present: description: Top-level tags must have a description message: Tags must include a description severity: warn given: "$.tags[*]" then: field: description function: truthy # Server rules bifrost-servers-present: description: API must define servers message: Servers array must be present and non-empty severity: error given: "$" then: field: servers function: truthy # Model field rules bifrost-chat-model-format: description: Chat completion model must use provider/model format message: Chat model field should use provider/model-name format severity: warn given: "$.components.schemas.ChatCompletionRequest.properties.model" then: field: description function: truthy # Examples rules bifrost-operation-examples-present: description: Responses with content should include examples message: Response content should include examples severity: warn given: "$.paths[*][*].responses[*].content[*]" then: field: examples function: truthy bifrost-microcks-operation-present: description: Every operation must include x-microcks-operation extension message: Operations must include x-microcks-operation severity: warn given: "$.paths[*][*]" then: field: x-microcks-operation function: truthy # License rules bifrost-license-present: description: API info must include license message: Info must include license severity: warn given: "$.info" then: field: license function: truthy bifrost-license-apache: description: License must be Apache 2.0 message: 'License must be Apache 2.0: {{value}}' severity: warn given: "$.info.license.name" then: function: pattern functionOptions: match: "Apache"