Lib.rs

› Web编程
#api-client #gitea #api-version #org #open-api #describe #documentation

gitea-rs

本文档描述了 Gitea API

由 OpenAPI Generator 团队和贡献者编写。 拥有者 0xC9C3.

1 个稳定版本

1.19.0 2023年4月15日

#2407 in Web编程

MIT 许可证

2MB
31K SLoC

Rust API 客户端 for gitea-rs

本文档描述了 Gitea API。

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

  • API版本：1.19.0
  • 包版本：1.19.0
  • 构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放入名为 gitea-rs 的目录中，并将以下内容添加到 Cargo.toml 下的 [dependencies]

gitea-rs = { path = "./gitea-rs" }

API端点文档

所有URI均相对于 /api/v1

类 方法 HTTP请求 描述
ActivitypubApi activitypub_person GET /activitypub/user/{username} 返回用户的 Person 角色者
ActivitypubApi activitypub_person_inbox POST /activitypub/user/{username}/inbox 发送到收件箱
AdminApi admin_adopt_repository POST /admin/unadopted/{owner}/{repo} 将未收养的文件作为仓库收养
AdminApi admin_create_hook POST /admin/hooks 创建钩子
AdminApi admin_create_org POST /admin/users/{username}/orgs 创建组织
AdminApi admin_create_public_key POST /admin/users/{username}/keys 代表用户添加公钥
AdminApi admin_create_repo POST /admin/users/{username}/repos 代表用户创建仓库
AdminApi admin_create_user POST /admin/users 创建用户
AdminApi admin_cron_list GET /admin/cron 列出cron任务
AdminApi admin_cron_run POST /admin/cron/{task} 运行cron任务
AdminApi admin_delete_hook DELETE /amdin/hooks/{id} 删除钩子
AdminApi admin_delete_unadopted_repository DELETE /admin/unadopted/{owner}/{repo} 删除未收养的文件
AdminApi admin_delete_user DELETE /admin/users/{username} 删除用户
AdminApi admin_delete_user_public_key DELETE /admin/users/{username}/keys/{id} 删除用户的公钥
AdminApi admin_edit_hook PATCH /admin/hooks/{id} 更新钩子
AdminApi admin_edit_user PATCH /admin/users/{username} 编辑现有用户
AdminApi admin_get_all_orgs GET /admin/orgs 列出所有组织
AdminApi admin_get_all_users GET /admin/users 列出所有用户
AdminApi admin_get_hook GET /admin/hooks/{id} 获取一个钩子
AdminApi admin_list_hooks GET /admin/hooks 列出系统的webhooks
AdminApi admin_unadopted_list GET /admin/unadopted 列出未采纳的仓库
IssueApi issue_add_label POST /repos/{owner}/{repo}/issues/{index}/labels 向问题添加标签
IssueApi issue_add_subscription PUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} 订阅用户的问题
IssueApi issue_add_time POST /repos/{owner}/{repo}/issues/{index}/times 向问题添加跟踪时间
IssueApi issue_check_subscription GET /repos/{owner}/{repo}/issues/{index}/subscriptions/check 检查用户是否订阅了问题
IssueApi issue_clear_labels DELETE /repos/{owner}/{repo}/issues/{index}/labels 从问题中删除所有标签
IssueApi issue_create_comment POST /repos/{owner}/{repo}/issues/{index}/comments 向问题添加评论
IssueApi issue_create_issue POST /repos/{owner}/{repo}/issues 创建一个问题。如果使用截止日期，则只考虑日期，忽略一天中的时间。
IssueApi issue_create_issue_attachment POST /repos/{owner}/{repo}/issues/{index}/assets 创建一个问题附件
IssueApi issue_create_issue_comment_attachment POST /repos/{owner}/{repo}/issues/comments/{id}/assets 创建一个评论附件
IssueApi issue_create_label POST /repos/{owner}/{repo}/labels 创建一个标签
IssueApi issue_create_milestone POST /repos/{owner}/{repo}/milestones 创建一个里程碑
IssueApi issue_delete DELETE /repos/{owner}/{repo}/issues/{index} 删除一个问题
IssueApi issue_delete_comment DELETE /repos/{owner}/{repo}/issues/comments/{id} 删除一个评论
IssueApi issue_delete_comment_deprecated DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} 删除一个评论
IssueApi issue_delete_comment_reaction DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions 从问题的评论中移除一个反应
IssueApi issue_delete_issue_attachment DELETE /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} 删除一个问题附件
IssueApi issue_delete_issue_comment_attachment DELETE /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} 删除一个评论附件
IssueApi issue_delete_issue_reaction DELETE /repos/{owner}/{repo}/issues/{index}/reactions 从问题中移除一个反应
IssueApi issue_delete_label DELETE /repos/{owner}/{repo}/labels/{id} 删除一个标签
IssueApi issue_delete_milestone DELETE /repos/{owner}/{repo}/milestones/{id} 删除一个里程碑
IssueApi issue_delete_stop_watch DELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/delete 删除问题中现有的计时器
IssueApi issue_delete_subscription DELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} 从问题中取消用户的订阅
IssueApi issue_delete_time DELETE /repos/{owner}/{repo}/issues/{index}/times/{id} 删除特定的跟踪时间
IssueApi issue_edit_comment PATCH /repos/{owner}/{repo}/issues/comments/{id} 编辑一个评论
IssueApi issue_edit_comment_deprecated PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} 编辑一个评论
IssueApi issue_edit_issue PATCH /repos/{owner}/{repo}/issues/{index} 编辑一个问题。如果使用截止日期，则只考虑日期，忽略一天中的时间。
IssueApi issue_edit_issue_attachment PATCH /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} 编辑一个问题附件
IssueApi issue_edit_issue_comment_attachment PATCH /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} 编辑一个评论附件
IssueApi issue_edit_issue_deadline POST /repos/{owner}/{repo}/issues/{index}/deadline 设置问题截止日期。如果设置为null，则删除截止日期。如果使用截止日期，则只考虑日期，忽略一天中的时间。
IssueApi issue_edit_label PATCH /repos/{owner}/{repo}/labels/{id} 更新标签
IssueApi issue_edit_milestone PATCH /repos/{owner}/{repo}/milestones/{id} 更新里程碑
IssueApi issue_get_comment GET /repos/{owner}/{repo}/issues/comments/{id} 获取评论
IssueApi issue_get_comment_reactions GET /repos/{owner}/{repo}/issues/comments/{id}/reactions 获取一个问题评论的所有反应列表
IssueApi issue_get_comments GET /repos/{owner}/{repo}/issues/{index}/comments 列出问题上的所有评论
IssueApi issue_get_comments_and_timeline GET /repos/{owner}/{repo}/issues/{index}/timeline 列出问题上的所有评论和事件
IssueApi issue_get_issue GET /repos/{owner}/{repo}/issues/{index} 获取一个问题
IssueApi issue_get_issue_attachment GET /repos/{owner}/{repo}/issues/{index}/assets/{attachment_id} 获取问题附件
IssueApi issue_get_issue_comment_attachment GET /repos/{owner}/{repo}/issues/comments/{id}/assets/{attachment_id} 获取评论附件
IssueApi issue_get_issue_reactions GET /repos/{owner}/{repo}/issues/{index}/reactions 获取问题反应列表
IssueApi issue_get_label GET /repos/{owner}/{repo}/labels/{id} 获取单个标签
IssueApi issue_get_labels GET /repos/{owner}/{repo}/issues/{index}/labels 获取问题的标签
IssueApi issue_get_milestone GET /repos/{owner}/{repo}/milestones/{id} 获取里程碑
IssueApi issue_get_milestones_list GET /repos/{owner}/{repo}/milestones 获取所有已打开的里程碑
IssueApi issue_get_repo_comments GET /repos/{owner}/{repo}/issues/comments 列出仓库中的所有评论
IssueApi issue_list_issue_attachments GET /repos/{owner}/{repo}/issues/{index}/assets 列出问题的附件
IssueApi issue_list_issue_comment_attachments GET /repos/{owner}/{repo}/issues/comments/{id}/assets 列出评论的附件
IssueApi issue_list_issues GET /repos/{owner}/{repo}/issues 列出仓库中的问题
IssueApi issue_list_labels GET /repos/{owner}/{repo}/labels 获取仓库中的所有标签
IssueApi issue_post_comment_reaction POST /repos/{owner}/{repo}/issues/comments/{id}/reactions 为一个问题评论添加反应
IssueApi issue_post_issue_reaction POST /repos/{owner}/{repo}/issues/{index}/reactions 为一个问题添加反应
IssueApi issue_remove_label DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id} 从问题中移除标签
IssueApi issue_replace_labels PUT /repos/{owner}/{repo}/issues/{index}/labels 替换问题的标签
IssueApi issue_reset_time DELETE /repos/{owner}/{repo}/issues/{index}/times 重置问题的跟踪时间
IssueApi issue_search_issues GET /repos/issues/search 搜索用户可以访问的仓库中的问题
IssueApi issue_start_stop_watch POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start 在问题上开始计时器
IssueApi issue_stop_stop_watch POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop 停止一个问题的现有计时器
IssueApi issue_subscriptions GET /repos/{owner}/{repo}/issues/{index}/subscriptions 获取已订阅问题的人员
IssueApi issue_tracked_times GET /repos/{owner}/{repo}/issues/{index}/times 列出问题的跟踪时间
其他API get_node_info GET /nodeinfo 返回Gitea应用程序的nodeinfo
其他API get_signing_key GET /signing-key.gpg 获取默认的signing-key.gpg
其他API get_version GET /version 返回Gitea应用程序的版本
其他API render_markdown POST /markdown 将markdown文档渲染为HTML
其他API render_markdown_raw POST /markdown/raw 将原始markdown渲染为HTML
通知API notify_get_list GET /notifications 列出用户的通知线程
通知API notify_get_repo_list GET /repos/{owner}/{repo}/notifications 列出特定仓库的用户通知线程
通知API notify_get_thread GET /notifications/threads/{id} 通过ID获取通知线程
通知API notify_new_available GET /notifications/new 检查是否存在未读通知
通知API notify_read_list PUT /notifications 标记通知线程为已读、置顶或未读
通知API notify_read_repo_list PUT /repos/{owner}/{repo}/notifications 在特定仓库上标记通知线程为已读、置顶或未读
通知API notify_read_thread PATCH /notifications/threads/{id} 通过ID标记通知线程为已读
OrganizationApi create_org_repo POST /orgs/{org}/repos 在组织内创建仓库
OrganizationApi create_org_repo_deprecated POST /org/{org}/repos 在组织内创建仓库
OrganizationApi org_add_team_member PUT /teams/{id}/members/{username} 添加团队成员
OrganizationApi org_add_team_repository PUT /teams/{id}/repos/{org}/{repo} 将仓库添加到团队
OrganizationApi org_conceal_member DELETE /orgs/{org}/public_members/{username} 隐藏用户成员资格
OrganizationApi org_create POST /orgs 创建组织
OrganizationApi org_create_hook POST /orgs/{org}/hooks 创建钩子
OrganizationApi org_create_label POST /orgs/{org}/labels 为组织创建标签
OrganizationApi org_create_team POST /orgs/{org}/teams 创建团队
OrganizationApi org_delete DELETE /orgs/{org} 删除组织
OrganizationApi org_delete_hook DELETE /orgs/{org}/hooks/{id} 删除钩子
OrganizationApi org_delete_label DELETE /orgs/{org}/labels/{id} 删除一个标签
OrganizationApi org_delete_member DELETE /orgs/{org}/members/{username} 从组织中移除成员
OrganizationApi org_delete_team DELETE /teams/{id} 删除团队
OrganizationApi org_edit PATCH /orgs/{org} 编辑组织
OrganizationApi org_edit_hook PATCH /orgs/{org}/hooks/{id} 更新钩子
OrganizationApi org_edit_label PATCH /orgs/{org}/labels/{id} 更新标签
OrganizationApi org_edit_team PATCH /teams/{id} 编辑团队
OrganizationApi org_get GET /orgs/{org} 获取组织
OrganizationApi org_get_all GET /orgs 获取组织列表
OrganizationApi org_get_hook GET /orgs/{org}/hooks/{id} 获取一个钩子
OrganizationApi org_get_label GET /orgs/{org}/labels/{id} 获取单个标签
OrganizationApi org_get_team GET /teams/{id} 获取团队
OrganizationApi org_get_user_permissions GET /users/{username}/orgs/{org}/permissions 获取组织中的用户权限
OrganizationApi org_is_member GET /orgs/{org}/members/{username} 检查用户是否是组织成员
OrganizationApi org_is_public_member GET /orgs/{org}/public_members/{username} 检查用户是否是组织的公开成员
OrganizationApi org_list_current_user_orgs GET /user/orgs 列出当前用户的组织
OrganizationApi org_list_hooks GET /orgs/{org}/hooks 列出组织的webhooks
OrganizationApi org_list_labels GET /orgs/{org}/labels 列出组织的标签
OrganizationApi org_list_members GET /orgs/{org}/members 列出组织的成员
OrganizationApi org_list_public_members GET /orgs/{org}/public_members 列出组织的公开成员
OrganizationApi org_list_repos GET /orgs/{org}/repos 列出组织的仓库
OrganizationApi org_list_team_member GET /teams/{id}/members/{username} 列出特定团队的成员
OrganizationApi org_list_team_members GET /teams/{id}/members 列出团队的成员
OrganizationApi org_list_team_repo GET /teams/{id}/repos/{org}/{repo} 列出特定团队的仓库
OrganizationApi org_list_team_repos GET /teams/{id}/repos 列出团队的仓库
OrganizationApi org_list_teams GET /orgs/{org}/teams 列出组织的团队
OrganizationApi org_list_user_orgs GET /users/{username}/orgs 列出用户的组织
OrganizationApi org_publicize_member PUT /orgs/{org}/public_members/{username} 公开用户成员资格
OrganizationApi org_remove_team_member DELETE /teams/{id}/members/{username} 移除团队成员
OrganizationApi org_remove_team_repository 删除 /teams/{id}/repos/{org}/{repo} 从一个团队中删除仓库
OrganizationApi team_search GET /orgs/{org}/teams/search 在组织中搜索团队
PackageApi delete_package DELETE /packages/{owner}/{type}/{name}/{version} 删除一个包
PackageApi get_package GET /packages/{owner}/{type}/{name}/{version} 获取一个包
PackageApi list_package_files GET /packages/{owner}/{type}/{name}/{version}/files 获取一个包的所有文件
PackageApi list_packages GET /packages/{owner} 获取一个所有者下的所有包
RepositoryApi accept_repo_transfer POST /repos/{owner}/{repo}/transfer/accept 接受仓库转移
RepositoryApi create_current_user_repo POST /user/repos 创建仓库
RepositoryApi create_fork POST /repos/{owner}/{repo}/forks 仓库分叉
RepositoryApi generate_repo POST /repos/{template_owner}/{template_repo}/generate 使用模板创建仓库
RepositoryApi get_annotated_tag GET /repos/{owner}/{repo}/git/tags/{sha} 获取带注解的标签对象（非轻量级标签）
RepositoryApi get_blob GET /repos/{owner}/{repo}/git/blobs/{sha} 获取仓库的blob
RepositoryApi get_tree GET /repos/{owner}/{repo}/git/trees/{sha} 获取仓库的树
RepositoryApi list_forks GET /repos/{owner}/{repo}/forks 列出仓库的分叉
RepositoryApi reject_repo_transfer POST /repos/{owner}/{repo}/transfer/reject 拒绝仓库转移
RepositoryApi repo_add_collaborator PUT /repos/{owner}/{repo}/collaborators/{collaborator} 向仓库添加协作者
RepositoryApi repo_add_push_mirror POST /repos/{owner}/{repo}/push_mirrors 向仓库添加推送镜像
RepositoryApi repo_add_team PUT /repos/{owner}/{repo}/teams/{team} 向仓库添加团队
RepositoryApi repo_add_topic PUT /repos/{owner}/{repo}/topics/{topic} 向仓库添加主题
RepositoryApi repo_apply_diff_patch POST /repos/{owner}/{repo}/diffpatch 将diff patch应用到仓库
RepositoryApi repo_cancel_scheduled_auto_merge DELETE /repos/{owner}/{repo}/pulls/{index}/merge 取消给定pull请求的预定自动合并
RepositoryApi repo_check_collaborator GET /repos/{owner}/{repo}/collaborators/{collaborator} 检查用户是否为仓库的协作者
RepositoryApi repo_check_team GET /repos/{owner}/{repo}/teams/{team} 检查团队是否分配到仓库
RepositoryApi repo_create_branch POST /repos/{owner}/{repo}/branches 创建分支
RepositoryApi repo_create_branch_protection POST /repos/{owner}/{repo}/branch_protections 为仓库创建分支保护
RepositoryApi repo_create_file POST /repos/{owner}/{repo}/contents/{filepath} 在仓库中创建文件
RepositoryApi repo_create_hook POST /repos/{owner}/{repo}/hooks 创建钩子
RepositoryApi repo_create_key POST /repos/{owner}/{repo}/keys 向仓库添加密钥
RepositoryApi repo_create_pull_request POST /repos/{owner}/{repo}/pulls 创建pull请求
RepositoryApi repo_create_pull_review POST /repos/{owner}/{repo}/pulls/{index}/reviews 对pull请求创建评审
RepositoryApi repo_create_pull_review_requests POST /repos/{owner}/{repo}/pulls/{index}/requested_reviewers 为pull请求创建评审请求
RepositoryApi repo_create_release POST /repos/{owner}/{repo}/releases 创建发布
RepositoryApi repo_create_release_attachment POST /repos/{owner}/{repo}/releases/{id}/assets 创建发布附件
RepositoryApi repo_create_status POST /repos/{owner}/{repo}/statuses/{sha} 创建提交状态
RepositoryApi repo_create_tag POST /repos/{owner}/{repo}/tags 在仓库中创建新的git标签
RepositoryApi repo_create_wiki_page POST /repos/{owner}/{repo}/wiki/new 创建wiki页面
RepositoryApi repo_delete DELETE /repos/{owner}/{repo} 删除仓库
RepositoryApi repo_delete_branch DELETE /repos/{owner}/{repo}/branches/{branch} 从仓库中删除特定分支
RepositoryApi repo_delete_branch_protection DELETE /repos/{owner}/{repo}/branch_protections/{name} 删除仓库的特定分支保护
RepositoryApi repo_delete_collaborator DELETE /repos/{owner}/{repo}/collaborators/{collaborator} 从仓库中删除协作者
RepositoryApi repo_delete_file DELETE /repos/{owner}/{repo}/contents/{filepath} 删除仓库中的文件
RepositoryApi repo_delete_git_hook DELETE /repos/{owner}/{repo}/hooks/git/{id} 删除仓库中的Git钩子
RepositoryApi repo_delete_hook DELETE /repos/{owner}/{repo}/hooks/{id} 删除仓库中的钩子
RepositoryApi repo_delete_key DELETE /repos/{owner}/{repo}/keys/{id} 从仓库中删除密钥
RepositoryApi repo_delete_pull_review DELETE /repos/{owner}/{repo}/pulls/{index}/reviews/{id} 从拉取请求中删除特定评论
RepositoryApi repo_delete_pull_review_requests DELETE /repos/{owner}/{repo}/pulls/{index}/requested_reviewers 取消拉取请求的评论请求
RepositoryApi repo_delete_push_mirror DELETE /repos/{owner}/{repo}/push_mirrors/{name} 通过远程名称从仓库中删除推送镜像
RepositoryApi repo_delete_release DELETE /repos/{owner}/{repo}/releases/{id} 删除发布
RepositoryApi repo_delete_release_attachment DELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} 删除发布附件
RepositoryApi repo_delete_release_by_tag DELETE /repos/{owner}/{repo}/releases/tags/{tag} 通过标签名称删除发布
RepositoryApi repo_delete_tag DELETE /repos/{owner}/{repo}/tags/{tag} 通过名称删除仓库的标签
RepositoryApi repo_delete_team DELETE /repos/{owner}/{repo}/teams/{team} 从仓库中删除团队
RepositoryApi repo_delete_topic DELETE /repos/{owner}/{repo}/topics/{topic} 从仓库中删除主题
RepositoryApi repo_delete_wiki_page DELETE /repos/{owner}/{repo}/wiki/page/{pageName} 删除维基页面
RepositoryApi repo_dismiss_pull_review POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals 驳回拉取请求的评论
RepositoryApi repo_download_commit_diff_or_patch GET /repos/{owner}/{repo}/git/commits/{sha}.{diffType} 获取提交的diff或补丁
RepositoryApi repo_download_pull_diff_or_patch GET /repos/{owner}/{repo}/pulls/{index}.{diffType} 获取拉取请求的diff或补丁
RepositoryApi repo_edit PATCH /repos/{owner}/{repo} 编辑仓库属性。只有设置的字段将被更改。
RepositoryApi repo_edit_branch_protection PATCH /repos/{owner}/{repo}/branch_protections/{name} 编辑仓库的分支保护。只有设置的字段将被更改
RepositoryApi repo_edit_git_hook PATCH /repos/{owner}/{repo}/hooks/git/{id} 编辑仓库中的Git钩子
RepositoryApi repo_edit_hook PATCH /repos/{owner}/{repo}/hooks/{id} 编辑仓库中的钩子
RepositoryApi repo_edit_pull_request PATCH /repos/{owner}/{repo}/pulls/{index} 更新拉取请求。如果使用截止日期，则只考虑日期，忽略时间。
RepositoryApi repo_edit_release PATCH /repos/{owner}/{repo}/releases/{id} 更新发布
RepositoryApi repo_edit_release_attachment PATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} 编辑发布附件
RepositoryApi repo_edit_wiki_page PATCH /repos/{owner}/{repo}/wiki/page/{pageName} 编辑维基页面
RepositoryApi repo_get GET /repos/{owner}/{repo} 获取仓库
RepositoryApi repo_get_all_commits GET /repos/{owner}/{repo}/commits 获取仓库中所有提交的列表
RepositoryApi repo_get_archive GET /repos/{owner}/{repo}/archive/{archive} 获取仓库的存档
RepositoryApi repo_get_assignees GET /repos/{owner}/{repo}/assignees 返回所有具有写入访问权限并可分配给问题的用户
RepositoryApi repo_get_branch GET /repos/{owner}/{repo}/branches/{branch} 获取仓库中特定分支，包括其有效的分支保护
RepositoryApi repo_get_branch_protection GET /repos/{owner}/{repo}/branch_protections/{name} 获取仓库中特定分支的保护设置
RepositoryApi repo_get_by_id GET /repositories/{id} 通过ID获取仓库
RepositoryApi repo_get_combined_status_by_ref GET /repos/{owner}/{repo}/commits/{ref}/status 通过分支/标签/提交引用获取提交的合并状态
RepositoryApi repo_get_contents GET /repos/{owner}/{repo}/contents/{filepath} 获取仓库中条目的元数据和内容（如果是一个文件），或者如果是一个目录则获取条目列表
RepositoryApi repo_get_contents_list GET /repos/{owner}/{repo}/contents 获取根目录下所有条目的元数据
RepositoryApi repo_get_editor_config GET /repos/{owner}/{repo}/editorconfig/{filepath} 获取仓库中文件的EditorConfig定义
RepositoryApi repo_get_git_hook GET /repos/{owner}/{repo}/hooks/git/{id} 获取Git钩子
RepositoryApi repo_get_hook GET /repos/{owner}/{repo}/hooks/{id} 获取一个钩子
RepositoryApi repo_get_issue_templates GET /repos/{owner}/{repo}/issue_templates 获取仓库中可用的 issue 模板
RepositoryApi repo_get_key GET /repos/{owner}/{repo}/keys/{id} 通过ID获取仓库的密钥
RepositoryApi repo_get_languages GET /repos/{owner}/{repo}/languages 获取语言和代码的字节数
RepositoryApi repo_get_latest_release GET /repos/{owner}/{repo}/releases/latest 获取仓库中最新非预发布、非草稿版本，按 created_at 排序
RepositoryApi repo_get_note GET /repos/{owner}/{repo}/git/notes/{sha} 获取对应单个提交的笔记
RepositoryApi repo_get_pull_request GET /repos/{owner}/{repo}/pulls/{index} 获取一个拉取请求
RepositoryApi repo_get_pull_request_commits GET /repos/{owner}/{repo}/pulls/{index}/commits 获取拉取请求的提交
RepositoryApi repo_get_pull_request_files GET /repos/{owner}/{repo}/pulls/{index}/files 获取拉取请求中更改的文件
RepositoryApi repo_get_pull_review GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id} 获取特定拉取请求的审查
RepositoryApi repo_get_pull_review_comments GET /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments 获取特定拉取请求的审查
RepositoryApi repo_get_push_mirror_by_remote_name GET /repos/{owner}/{repo}/push_mirrors/{name} 通过 remoteName 获取仓库的推送镜像
RepositoryApi repo_get_raw_file GET /repos/{owner}/{repo}/raw/{filepath} 从仓库中获取文件
RepositoryApi repo_get_raw_file_or_lfs GET /repos/{owner}/{repo}/media/{filepath} 从仓库中获取文件或其LFS对象
RepositoryApi repo_get_release GET /repos/{owner}/{repo}/releases/{id} 获取一个版本
RepositoryApi repo_get_release_attachment GET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id} 获取版本附件
RepositoryApi repo_get_release_by_tag GET /repos/{owner}/{repo}/releases/tags/{tag} 通过标签名称获取版本
RepositoryApi repo_get_repo_permissions GET /repos/{owner}/{repo}/collaborators/{collaborator}/permission 获取用户的仓库权限
RepositoryApi repo_get_reviewers GET /repos/{owner}/{repo}/reviewers 返回在此仓库中可以请求进行审查的所有用户
RepositoryApi repo_get_single_commit GET /repos/{owner}/{repo}/git/commits/{sha} 从仓库中获取单个提交
RepositoryApi repo_get_tag GET /repos/{owner}/{repo}/tags/{tag} 通过标签名称获取仓库的标签
RepositoryApi repo_get_wiki_page GET /repos/{owner}/{repo}/wiki/page/{pageName} 获取wiki页面
RepositoryApi repo_get_wiki_page_revisions GET /repos/{owner}/{repo}/wiki/revisions/{pageName} 获取wiki页面的修订版本
RepositoryApi repo_get_wiki_pages GET /repos/{owner}/{repo}/wiki/pages 获取所有wiki页面
RepositoryApi repo_list_all_git_refs GET /repos/{owner}/{repo}/git/refs 获取指定引用或过滤后的仓库引用
RepositoryApi repo_list_branch_protection GET /repos/{owner}/{repo}/branch_protections 列出仓库的分支保护
RepositoryApi repo_list_branches GET /repos/{owner}/{repo}/branches 列出仓库的分支
RepositoryApi repo_list_collaborators GET /repos/{owner}/{repo}/collaborators 列出仓库的协作者
RepositoryApi repo_list_git_hooks GET /repos/{owner}/{repo}/hooks/git 列出仓库中的 Git 钩子
RepositoryApi repo_list_git_refs GET /repos/{owner}/{repo}/git/refs/{ref} 获取指定引用或过滤后的仓库引用
RepositoryApi repo_list_hooks GET /repos/{owner}/{repo}/hooks 列出仓库中的钩子
RepositoryApi repo_list_keys GET /repos/{owner}/{repo}/keys 列出仓库的密钥
RepositoryApi repo_list_pull_requests GET /repos/{owner}/{repo}/pulls 列出仓库的拉取请求
RepositoryApi repo_list_pull_reviews GET /repos/{owner}/{repo}/pulls/{index}/reviews 列出拉取请求的所有审查
RepositoryApi repo_list_push_mirrors GET /repos/{owner}/{repo}/push_mirrors 获取仓库的所有推送镜像
RepositoryApi repo_list_release_attachments GET /repos/{owner}/{repo}/releases/{id}/assets 列出版本的附件
RepositoryApi repo_list_releases GET /repos/{owner}/{repo}/releases 列出仓库的版本
RepositoryApi repo_list_stargazers GET /repos/{owner}/{repo}/stargazers 列出仓库的星标
RepositoryApi repo_list_statuses GET /repos/{owner}/{repo}/statuses/{sha} 获取提交的状态
RepositoryApi repo_list_statuses_by_ref GET /repos/{owner}/{repo}/commits/{ref}/statuses 通过分支/标签/提交引用获取提交的状态
RepositoryApi repo_list_subscribers GET /repos/{owner}/{repo}/subscribers 列出仓库的订阅者
RepositoryApi repo_list_tags GET /repos/{owner}/{repo}/tags 列出仓库的标签
RepositoryApi repo_list_teams GET /repos/{owner}/{repo}/teams 列出仓库的团队
RepositoryApi repo_list_topics GET /repos/{owner}/{repo}/topics 获取仓库的主题列表
RepositoryApi repo_merge_pull_request POST /repos/{owner}/{repo}/pulls/{index}/merge 合并拉取请求
RepositoryApi repo_migrate POST /repos/migrate 迁移远程 Git 仓库
RepositoryApi repo_mirror_sync POST /repos/{owner}/{repo}/mirror-sync 同步镜像仓库
RepositoryApi repo_pull_request_is_merged GET /repos/{owner}/{repo}/pulls/{index}/merge 检查拉取请求是否已合并
RepositoryApi repo_push_mirror_sync POST /repos/{owner}/{repo}/push_mirrors-sync 同步所有推送镜像仓库
RepositoryApi repo_search GET /repos/search 搜索仓库
RepositoryApi repo_signing_key GET /repos/{owner}/{repo}/signing-key.gpg 获取给定仓库的 signing-key.gpg
RepositoryApi repo_submit_pull_review POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id} 提交待审查的拉取请求
RepositoryApi repo_test_hook POST /repos/{owner}/{repo}/hooks/{id}/tests 测试推送 webhook
RepositoryApi repo_tracked_times GET /repos/{owner}/{repo}/times 列出仓库的跟踪时间
RepositoryApi repo_transfer POST /repos/{owner}/{repo}/transfer 转移仓库所有权
RepositoryApi repo_un_dismiss_pull_review POST /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals 取消忽略拉取请求的审查
RepositoryApi repo_update_file PUT /repos/{owner}/{repo}/contents/{filepath} 更新仓库中的文件
RepositoryApi repo_update_pull_request POST /repos/{owner}/{repo}/pulls/{index}/update 将 PR 的 baseBranch 合并到 headBranch
RepositoryApi repo_update_topics PUT /repos/{owner}/{repo}/topics 替换仓库的主题列表
RepositoryApi topic_search GET /topics/search 通过关键词搜索主题
RepositoryApi user_current_check_subscription GET /repos/{owner}/{repo}/subscription 检查当前用户是否在观看仓库
RepositoryApi user_current_delete_subscription DELETE /repos/{owner}/{repo}/subscription 取消关注一个仓库
RepositoryApi user_current_put_subscription PUT /repos/{owner}/{repo}/subscription 关注一个仓库
RepositoryApi user_tracked_times GET /repos/{owner}/{repo}/times/{user} 列出用户在一个仓库中的跟踪时间
SettingsApi get_general_api_settings GET /settings/api 获取实例的全局API设置
SettingsApi get_general_attachment_settings GET /settings/attachment 获取实例的全局附件设置
SettingsApi get_general_repository_settings GET /settings/repository 获取实例的全局仓库设置
SettingsApi get_general_ui_settings GET /settings/ui 获取实例的全局UI设置
UserApi create_current_user_repo POST /user/repos 创建仓库
UserApi get_user_settings GET /user/settings 获取用户设置
UserApi get_verification_token GET /user/gpg_key_token 获取验证令牌
UserApi update_user_settings PATCH /user/settings 更新用户设置
UserApi user_add_email POST /user/emails 添加电子邮件地址
UserApi user_check_following GET /users/{username}/following/{target} 检查一个用户是否在关注另一个用户
UserApi user_create_o_auth2_application POST /user/applications/oauth2 创建一个新的OAuth2应用程序
UserApi user_create_token POST /users/{username}/tokens 创建访问令牌
UserApi user_current_check_following GET /user/following/{username} 检查当前用户是否在关注该用户
UserApi user_current_check_starring GET /user/starred/{owner}/{repo} 检查当前用户是否在收藏该仓库
UserApi user_current_delete_follow DELETE /user/following/{username} 取消关注用户
UserApi user_current_delete_gpg_key DELETE /user/gpg_keys/{id} 移除GPG密钥
UserApi user_current_delete_key DELETE /user/keys/{id} 删除公钥
UserApi user_current_delete_star DELETE /user/starred/{owner}/{repo} 取消收藏指定的仓库
UserApi user_current_get_gpg_key GET /user/gpg_keys/{id} 获取GPG密钥
UserApi user_current_get_key GET /user/keys/{id} 获取公钥
UserApi user_current_list_followers GET /user/followers 列出当前用户的关注者
UserApi user_current_list_following GET /user/following 列出当前用户关注的用户
UserApi user_current_list_gpg_keys GET /user/gpg_keys 列出当前用户的GPG密钥
UserApi user_current_list_keys GET /user/keys 列出当前用户的公钥
UserApi user_current_list_repos GET /user/repos 列出当前用户拥有的仓库
UserApi user_current_list_starred GET /user/starred 列出当前用户收藏的仓库
UserApi user_current_list_subscriptions GET /user/subscriptions 列出当前用户关注的仓库
UserApi user_current_post_gpg_key POST /user/gpg_keys 创建GPG密钥
UserApi user_current_post_key POST /user/keys 创建公钥
UserApi user_current_put_follow PUT /user/following/{username} 关注用户
UserApi user_current_put_star PUT /user/starred/{owner}/{repo} 收藏指定的仓库
UserApi user_current_tracked_times GET /user/times 列出当前用户的跟踪时间
UserApi user_delete_access_token DELETE /users/{username}/tokens/{token} 删除访问令牌
UserApi user_delete_email DELETE /user/emails 删除电子邮件地址
UserApi user_delete_o_auth2_application DELETE /user/applications/oauth2/{id} 删除OAuth2应用程序
UserApi user_get GET /users/{username} 获取用户
UserApi user_get_current GET /user 获取当前用户
UserApi user_get_heatmap_data GET /users/{username}/heatmap 获取用户的热力图
UserApi user_get_o_auth2_application GET /user/applications/oauth2/{id} 获取OAuth2应用
UserApi user_get_oauth2_application GET /user/applications/oauth2 列出认证用户的OAuth2应用
UserApi user_get_stop_watches GET /user/stopwatches 获取所有现有计时器的列表
UserApi user_get_tokens GET /users/{username}/tokens 列出认证用户的访问令牌
UserApi user_list_emails GET /user/emails 列出认证用户的电子邮件地址
UserApi user_list_followers GET /users/{username}/followers 列出指定用户的关注者
UserApi user_list_following GET /users/{username}/following 列出指定用户关注的用户
UserApi user_list_gpg_keys GET /users/{username}/gpg_keys 列出指定用户的GPG密钥
UserApi user_list_keys GET /users/{username}/keys 列出指定用户的公钥
UserApi user_list_repos GET /users/{username}/repos 列出指定用户拥有的仓库
UserApi user_list_starred GET /users/{username}/starred 列出指定用户已星标的仓库
UserApi user_list_subscriptions GET /users/{username}/subscriptions 列出用户关注的仓库
UserApi user_list_teams GET /user/teams 列出用户所属的所有团队
UserApi user_search GET /users/search 搜索用户
UserApi user_update_o_auth2_application PATCH /user/applications/oauth2/{id} 更新OAuth2应用，这包括重新生成客户端密钥
UserApi user_verify_gpg_key POST /user/gpg_key_verify 验证GPG密钥

模型文档

要获取对生成的文档的访问权限，请使用

cargo doc --open

作者

依赖项

~4–18MB
~248K SLoC