Vetrix Docs

Reference

Per-resource reference for the gitvetrix.com REST API. Each page covers one resource family and documents the available paths, HTTP methods, request parameters, and response shapes, along with the authentication and authorization required to call them.

Start with conventions.md — the shared rules every endpoint follows: hosts, authentication, scopes, pagination, the error envelope, and the canonical /merges paths. The per-resource pages assume those conventions and link back to them rather than repeating them.

Conventions

  • conventions.md — Shared API conventions: hosts, authentication, scopes, pagination, the error envelope, and merge-request naming.
  • ../errors.md — The error envelope, status-code conventions, and a catalog of representative messages.
  • ../rate-limits.md — How request rate limits are scoped, budgeted by user group, reported, and enforced.

Resource pages

One page per resource family. Each documents its endpoints, request and response shapes, status codes, and examples.

  • repos.md — Repositories: branches, tags, collaborators, and visibility.
  • issues.md — Issues, comments, labels, milestones, components, and versions.
  • merges.md — Merge requests, reviews, diffs, and merging.
  • registry — OCI, npm, PyPI, and Go module registry endpoints.
  • cicd.md — Pipelines, jobs, artifacts, variables, commit statuses, and deployments/environments.
  • oauth2-mcp.md — OAuth2 authorization-code flow, dynamic client registration, and the MCP endpoint.
  • admin.md — Instance administration: users, groups, settings, scope grants, and the audit log.
  • search.md — Full-text search across issues, code, and documentation.

Authoring a page

New resource pages are written from _template.md — a fixed skeleton (resource overview, auth and scopes, endpoint table, per-endpoint detail, errors, and rate limits) so every page reads the same way. Copy the template, fill it in, and add the page to the Resource pages list above.

Supplementary notes