PandaDoc API Style Guide Linting Rules

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.

Installation

npm install --save-dev @pandadoc/api-style-guide

Usage

Extend your .spectral.yaml to use the linting rules:

extends:
  - "@pandadoc/api-style-guide"

Run Spectral to lint your OpenAPI definition:

npx spectral lint openapi.yaml

What is Included?

• 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

Example .spectral.yaml

extends:
  - "@pandadoc/api-style-guide"

rules:
  # You can override or add custom rules here

About PandaDoc API Guidelines vs Style Guide

• 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