rules: # INFO / METADATA info-title-webflow-prefix: description: API title must start with "Webflow" to match provider naming convention. message: "{{property}} title should start with 'Webflow'" severity: warn given: "$.info" then: field: title function: pattern functionOptions: match: "^Webflow" info-description-required: description: API must have a non-empty description. message: "{{property}} description is required" severity: warn given: "$.info" then: field: description function: truthy info-version-required: description: API info must include a version. message: "{{property}} must have a version" severity: error given: "$.info" then: field: version function: truthy # OPENAPI VERSION openapi-version-3: description: Webflow API specs must use OpenAPI 3.x. message: "{{property}} must be OpenAPI 3.x" severity: error given: "$" then: field: openapi function: pattern functionOptions: match: "^3\\." # SERVERS servers-defined: description: At least one server must be defined. message: "{{property}} servers must be defined" severity: warn given: "$" then: field: servers function: truthy servers-https: description: Server URLs must use HTTPS. message: "{{value}} must use HTTPS" severity: error given: "$.servers[*]" then: field: url function: pattern functionOptions: match: "^https://" servers-webflow-domain: description: Webflow API servers must use the api.webflow.com domain. message: "{{value}} should use api.webflow.com" severity: info given: "$.servers[*]" then: field: url function: pattern functionOptions: match: "api\\.webflow\\.com" # PATHS — NAMING CONVENTIONS paths-no-trailing-slash: description: Paths must not end with a trailing slash. message: "{{property}} must not end with a slash" severity: warn given: "$.paths[*]~" then: function: pattern functionOptions: notMatch: "/$" paths-snake-case-segments: description: Webflow path segments use snake_case (underscores). message: "{{property}} path segments should use snake_case" severity: info given: "$.paths[*]~" then: function: pattern functionOptions: notMatch: "[A-Z]" # OPERATIONS operation-summary-required: description: Every operation must have a summary. message: "{{property}} must have a summary" severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: summary function: truthy operation-summary-title-case: description: Operation summaries must start with an uppercase letter. message: "{{property}} summary must start with uppercase" severity: warn given: "$.paths[*][get,post,put,patch,delete].summary" then: function: pattern functionOptions: match: "^[A-Z]" operation-id-required: description: Every operation must have an operationId. message: "{{property}} must have an operationId" severity: error given: "$.paths[*][get,post,put,patch,delete]" then: field: operationId function: truthy operation-id-kebab-case: description: Operation IDs in Webflow APIs use kebab-case. message: "{{value}} operationId should use kebab-case" severity: info given: "$.paths[*][get,post,put,patch,delete].operationId" then: function: pattern functionOptions: notMatch: "_" operation-tags-required: description: Every operation must have at least one tag. message: "{{property}} 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. message: "{{property}} parameter must have a description" severity: warn given: "$.paths[*][get,post,put,patch,delete].parameters[*]" then: field: description function: truthy # REQUEST BODIES request-body-content-type: description: Request bodies must define application/json content type. message: "{{property}} request body should define application/json" severity: warn given: "$.paths[*][post,put,patch].requestBody.content" then: field: application/json function: truthy # RESPONSES response-success-required: description: Every operation must define at least one 2xx response. message: "{{property}} must have a success response" severity: error given: "$.paths[*][get,post,put,patch,delete].responses" then: function: schema functionOptions: schema: oneOf: - required: ["200"] - required: ["201"] - required: ["204"] response-description-required: description: Every response must have a description. message: "{{property}} must have a description" severity: warn given: "$.paths[*][get,post,put,patch,delete].responses[*]" then: field: description function: truthy response-error-401: description: Operations should define 401 Unauthorized response. message: "{{property}} should include 401 Unauthorized" severity: info given: "$.paths[*][get,post,put,patch,delete].responses" then: field: "401" function: truthy # SCHEMAS — PROPERTY NAMING schema-camelcase-properties: description: Webflow API schema properties use camelCase naming. message: "{{property}} should use camelCase" severity: info given: "$.components.schemas[*].properties[*]~" then: function: pattern functionOptions: notMatch: "_" schema-description-recommended: description: Component schemas should have descriptions. message: "{{property}} should have a description" severity: info given: "$.components.schemas[*]" then: field: description function: truthy # SECURITY security-schemes-defined: description: Security schemes must be defined. message: "{{property}} must define security schemes" severity: warn given: "$.components" then: field: securitySchemes function: truthy security-oauth2-or-apikey: description: Webflow uses OAuth 2.0 and API key authentication. message: "{{property}} must use OAuth2 or ApiKey scheme" severity: info given: "$.components.securitySchemes[*].type" then: function: enumeration functionOptions: values: - oauth2 - apiKey - http # HTTP METHOD CONVENTIONS get-no-request-body: description: GET operations must not have a request body. message: "{{property}} GET must not have requestBody" severity: error given: "$.paths[*].get" then: field: requestBody function: falsy delete-returns-204: description: DELETE operations should return 204 No Content. message: "{{property}} DELETE should return 204" severity: info given: "$.paths[*].delete.responses" then: field: "204" function: truthy # GENERAL QUALITY no-empty-descriptions: description: Descriptions must not be empty strings. message: "{{property}} description must not be empty" severity: error given: "$..description" then: function: truthy