Spectral rules for PandaDoc API Guidelines
npm install @pandadoc/api-style-guide
Enforce PandaDoc OpenAPI Style Guide with linting rules. This package provides ready-to-use rules for validating your OpenAPI 3.x definitions against PandaDoc's API standards. We use Spectral as the tool for linting OpenAPI files.
``sh`
npm install --save-dev @pandadoc/api-style-guide
Extend your .spectral.yaml to use the linting rules:
`yaml`
extends:
- "@pandadoc/api-style-guide"
Run Spectral to lint your OpenAPI definition:
`sh`
npx spectral lint openapi.yaml
- Enforce PandaDoc API Style Guide for OpenAPI 3.x
- Linting rules for error response schemas, operationId naming, parameter documentation, security definitions, and more
- Automatic linting via Spectral
`yaml
extends:
- "@pandadoc/api-style-guide"
rules:
# You can override or add custom rules here
``
- API Guidelines: High-level design principles and best practices
- Style Guide: Specific, enforceable rules for OpenAPI specs
- Linting Rules: Automated checks for style guide compliance using Spectral