Spectral linting rules defining API design standards and conventions for Internet Engineering Task Force.
0 Rules
Authorship not recorded
No authorship marker is recorded for this file. It is not presented as the provider's; it was most likely written by an API Evangelist pass before outputs were stamped.
x-aid: internet-engineering-task-force
x-name: Internet Engineering Task Force Rules
description: >-
Validation, governance, and operational rules applied to the IETF APIs.json
index and any associated machine-readable artifacts.
x-type: standard
x-profile:
- apis.json
x-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
- id: datatracker-readonly
description: Datatracker public endpoints are read-only. Consumers should expect JSON or XML responses and respect rate limits.
severity: info
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.