Add: Use AI to write custom OpenAPI lint rules - #369
Conversation
There was a problem hiding this comment.
marketing-site AI Review: 🟢 Completed
Redocly Agent has reviewed your changes and found 1 potential issue(s).
Note
Low Risk
This PR strictly contains documentation changes, adding a new article and its corresponding sidebar entry. There are no runtime code or behavior changes, meaning there is zero operational risk.
Overview
Adds a new guide, ai-write-custom-openapi-lint-rules.md, detailing how to use AI to draft custom OpenAPI lint rules for Redocly CLI. The article covers generating both YAML-based configurable rules and JavaScript-based custom rule plugins, providing examples, prompt templates, and best practices for testing new rules before enforcing them. Additionally, it updates learn/ai-for-docs/sidebars.yaml to include the new page in the navigation structure.
| message: Error response schemas must list "code" as a required field so clients can branch on it | ||
| severity: error | ||
| assertions: | ||
| contains: |
Summary
learn/ai-for-docs/ai-write-custom-openapi-lint-rules.mdfrom the Calendar draft.learn/ai-for-docs/sidebars.yamlwith the new page entry.Test plan
npm start