API Linting

Sweater Comb

Snyk's TypeScript ruleset built on Optic CI that enforces consistency standards across OpenAPI specifications. Sweater Comb codifies the Snyk API Program's design rules so a growing federation of teams ship "cohesive, consistent and unsurprising" APIs without manual review.

GitHub

SDKs

📦
GitHubRepository
https://github.com/snyk/sweater-comb

Other Resources

🔗
NPMPackage
https://www.npmjs.com/package/@snyk/sweater-comb
🔗
License
https://github.com/snyk/sweater-comb/blob/main/LICENSE
🔗
APIStandards
https://github.com/snyk/sweater-comb/blob/main/docs/standards.md

API entry from apis.yml

apis.yml Raw ↑ 
aid: linting:sweater-comb
name: Sweater Comb
description: Snyk's TypeScript ruleset built on Optic CI that enforces consistency standards across OpenAPI
  specifications. Sweater Comb codifies the Snyk API Program's design rules so a growing federation of
  teams ship "cohesive, consistent and unsurprising" APIs without manual review.
humanURL: https://github.com/snyk/sweater-comb
baseURL: https://github.com/snyk/sweater-comb
tags:
- API Governance
- OpenAPI
- Optic
- Ruleset
- Snyk
- TypeScript
properties:
- type: GitHubRepository
  url: https://github.com/snyk/sweater-comb
- type: NPMPackage
  url: https://www.npmjs.com/package/@snyk/sweater-comb
- type: License
  url: https://github.com/snyk/sweater-comb/blob/main/LICENSE
  x-license: Apache-2.0
- type: APIStandards
  url: https://github.com/snyk/sweater-comb/blob/main/docs/standards.md
x-rules-format: optic-typescript
x-rules-engine: typescript
x-integration-points:
- cli
- ci
x-supported-formats:
- openapi-3.0
- openapi-3.1