rules: biogen-info-title-prefix: description: API title must start with "Biogen" message: 'Info title must start with "Biogen": {{value}}' severity: error given: $.info.title then: function: pattern functionOptions: match: "^Biogen" biogen-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 biogen-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 biogen-operation-summary-prefix: description: Operation summaries must start with "Biogen" message: 'Operation summary must start with "Biogen": {{value}}' severity: error given: "$.paths[*][*].summary" then: function: pattern functionOptions: match: "^Biogen" biogen-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]*$" biogen-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 biogen-operation-description-present: description: Every operation must have a description message: Operations must include description severity: warn given: "$.paths[*][*]" then: field: description function: truthy biogen-response-success-present: description: Every operation must define a success response message: Operations must include a 200 or 201 response severity: error given: "$.paths[*][*].responses" then: function: schema functionOptions: schema: type: object anyOf: - required: ['200'] - required: ['201'] biogen-response-401-present: description: Operations should define a 401 response message: Operations should include 401 unauthorized response severity: warn given: "$.paths[*][*].responses" then: function: schema functionOptions: schema: type: object anyOf: - required: ['401'] - required: ['403'] biogen-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 biogen-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 biogen-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 biogen-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 biogen-api-key-auth: description: Biogen API uses X-API-Key header authentication message: Security scheme should use X-API-Key header severity: warn given: "$.components.securitySchemes[*]" then: function: truthy biogen-operation-security-present: description: Operations must declare security message: Operations must include security definition severity: warn given: "$.paths[*][get,post,put,patch,delete]" then: field: security function: truthy biogen-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 biogen-servers-present: description: API must define servers message: Servers array must be present and non-empty severity: error given: "$" then: field: servers function: truthy biogen-server-https: description: Server URL must use HTTPS message: 'Server URL must use HTTPS: {{value}}' severity: error given: "$.servers[*].url" then: function: pattern functionOptions: match: "^https://" biogen-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 biogen-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 biogen-unused-components: description: All components should be referenced message: Unused components should be removed severity: warn given: "$.components.schemas" then: function: truthy biogen-license-present: description: API info must include license message: Info must include license severity: warn given: "$.info" then: field: license function: truthy biogen-path-kebab-case: description: Path segments should be lowercase message: 'Path segments should use lowercase: {{value}}' severity: warn given: "$.paths" then: function: pattern functionOptions: match: "^(/[a-z0-9-/{}]*)+$"