Files
Gotcha/API_COVERAGE.md
2026-07-31 16:10:50 +02:00

2.6 KiB

Gitea API coverage

Source: the OpenAPI contract served by the configured Gitea 1.25.4 instance. It contains 299 paths, 467 operations, 243 read/query operations, and 216 schema definitions.

gotcha_gitea exposes the complete typed Gitea 1.25 client through gotcha_gitea::apis and every generated request/response model through gotcha_gitea::models. Client::configuration() supplies the selected base URL and token to those generated functions.

Domain Queries Other actions API crate CLI queries CLI writes Capabilities
activitypub 1 1 Complete 0 0 Person actors and inbox federation
admin 14 18 Complete 0 0 Users, organizations, email, hooks, cron, unadopted repositories, Actions runners/jobs/runs
issue 23 46 Complete 5 7 Issues, comments, attachments, reactions, labels, milestones, dependencies, subscriptions, time tracking, pins
miscellaneous 10 3 Complete 1 0 Version, templates, licenses, node info, signing keys, Markdown/markup rendering
notification 4 3 Complete 0 0 Notification threads, unread checks, read state
organization 33 33 Complete 0 0 Organizations, members, teams, repositories, labels, hooks, blocks, activities, Actions
package 5 3 Complete 0 0 Packages, versions, files, linking and deletion
repository 105 86 Complete 6 3 Search, repositories, branches, protections, commits, content, refs, tags, releases, pull requests, reviews, collaborators, hooks, wiki, mirrors, Actions
settings 4 0 Complete 0 0 Instance API, attachment, repository, and UI settings
user 44 31 Complete 2 0 Users, profile, following, stars, watches, keys, GPG, email, hooks, OAuth, tokens, blocks, Actions, tracked time
Total 243 224 467/467 14/243 10/224

CLI status

Typed text commands currently implemented include:

  • server versiongetVersion
  • user showuserGetCurrent
  • repo listuserCurrentListRepos
  • repo showrepoGet
  • issue list with state, kind, keyword, label, milestone, author, assignee, mention, date, and pagination filters; show/create/edit/close/reopen/delete; comments/comment
  • milestone list/show/create/edit/delete
  • pull list/show/create/edit/merge/commits/files/reviews

The remaining 229 query operations and 214 mutation operations are available to Rust callers through the typed API modules but do not yet have purpose-built CLI commands or text/input views. api request remains an explicit JSON escape hatch; it is not counted as typed CLI coverage.