International Trade Commission · API Governance Rules

International Trade Commission API Rules

Spectral linting rules defining API design standards and conventions for International Trade Commission.

0 Rules
View Rules File View on GitHub

Spectral Ruleset

international-trade-commission-rules.yml Raw ↑ 
aid: international-trade-commission
name: International Trade Commission Rules
description: >-
  Validation, governance, and operational rules applied to the International
  Trade Commission APIs.json index and any associated machine-readable
  artifacts.
type: government
profile:
  - apis.json
  - openapi
governance:
  source: api-evangelist
  steward: Kin Lane
  visibility: public
rules:
  - id: apisjson-required-fields
    description: APIs.json must include aid, name, description, url, created, modified, and maintainers.
    severity: error
  - id: apisjson-tags-upper-case
    description: All tags must use upper-case first letters.
    severity: warn
  - id: api-baseurl-required
    description: Each documented API should declare a baseURL when known.
    severity: warn
  - id: openapi-non-empty
    description: OpenAPI specs must reference real, validated endpoints. Stub or empty specs are not permitted.
    severity: error
  - id: artifact-location
    description: All OpenAPI specs live under openapi/{repo}-openapi.yml.
    severity: error