Vetrix Docs

API Documentation

Reference material for the gitvetrix.com HTTP API, registry endpoints, and machine-readable specifications. Use this repository to look up endpoint behavior, error semantics, and request limits when integrating with a Vetrix server.

Sections

  • reference/README.md — Per-resource endpoint reference: paths, methods, parameters, and response shapes for the REST API.
  • openapi/README.md — Machine-readable OpenAPI specifications and the artifacts generated from them.
  • registry/README.md — Endpoint reference for the OCI, npm, PyPI, and Go module registries served by the platform.
  • errors.md — The common error envelope and the meaning of each error code.
  • rate-limits.md — How request rate limits are scoped, reported, and enforced.

Contributing — operator-manual guardrail

These pages are an operator manual. Before opening a pull request, run the manual doc-lint. The command below works from any directory inside a clone:

bash "$(git rev-parse --show-toplevel)/llm-documentation/api-docs/doc-lint.sh"

The script switches to the repository root itself and scans every tracked Markdown and YAML file, so a single run covers all five documentation sets. Each set holds an identical copy of the script; running any one of them lints the whole tree, so this is not a per-set lint.

The script fails — listing file:line — when an operator-manual rule is violated. The Docs Reviewer enforces the same rules:

  • Use gitvetrix.com as the only product host (the .test dev host is fine).
  • Refer to the platform as Vetrix; do not use the legacy product name.
  • Keep tracker IDs out of the prose.
  • Link to other pages with relative .md paths. A markdown link whose target is an absolute git-host URL (https://www.gitvetrix.com/... or https://gitvetrix.com/...) fails the lint, because it sends the reader out of the manual and into the repository file browser; this is checked case-insensitively across inline links, reference-style link definitions, bare autolinks (a URL wrapped only in < >, no square brackets), and angle-bracket-wrapped destinations, including a userinfo-prefixed form (e.g. https://user:token@ in front of the host). Bare-text host mentions, curl examples and code blocks are unaffected.
  • Write in present-tense operator-manual tone, without decision or history narration.

doc-lint.sh must pass before review.