forgejo

Forgejo - the Ruby gem for the Forgejo API

This documentation describes the Forgejo API.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 10.0.0-121-28886cd+gitea-1.22.0
  • Package version: 0.2.1
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build forgejo.gemspec

Then either install the gem locally:

gem install ./forgejo-0.2.1.gem

(for development, run gem install --dev ./forgejo-0.2.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'forgejo', '~> 0.2.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'forgejo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'forgejo'

# Setup authorization
Forgejo.configure do |config|
  # Configure API key authorization: AuthorizationHeaderToken
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = Forgejo::ActivitypubApi.new

begin
  #Returns the instance's Actor
  result = api_instance.activitypub_instance_actor
  p result
rescue Forgejo::ApiError => e
  puts "Exception when calling ActivitypubApi->activitypub_instance_actor: #{e}"
end

Documentation for API Endpoints

All URIs are relative to /api/v1

Class Method HTTP request Description
Forgejo::ActivitypubApi activitypub_instance_actor GET /activitypub/actor Returns the instance's Actor
Forgejo::ActivitypubApi activitypub_instance_actor_inbox POST /activitypub/actor/inbox Send to the inbox
Forgejo::ActivitypubApi activitypub_person GET /activitypub/user-id/user-id Returns the Person actor for a user
Forgejo::ActivitypubApi activitypub_person_inbox POST /activitypub/user-id/user-id/inbox Send to the inbox
Forgejo::ActivitypubApi activitypub_repository GET /activitypub/repository-id/repository-id Returns the Repository actor for a repo
Forgejo::ActivitypubApi activitypub_repository_inbox POST /activitypub/repository-id/repository-id/inbox Send to the inbox
Forgejo::AdminApi admin_add_rule_to_quota_group PUT /admin/quota/groups/quotagroup/rules/quotarule Adds a rule to a quota group
Forgejo::AdminApi admin_add_user_to_quota_group PUT /admin/quota/groups/quotagroup/users/username Add a user to a quota group
Forgejo::AdminApi admin_adopt_repository POST /admin/unadopted/owner/repo Adopt unadopted files as a repository
Forgejo::AdminApi admin_create_hook POST /admin/hooks Create a hook
Forgejo::AdminApi admin_create_org POST /admin/users/username/orgs Create an organization
Forgejo::AdminApi admin_create_public_key POST /admin/users/username/keys Add a public key on behalf of a user
Forgejo::AdminApi admin_create_quota_group POST /admin/quota/groups Create a new quota group
Forgejo::AdminApi admin_create_quota_rule POST /admin/quota/rules Create a new quota rule
Forgejo::AdminApi admin_create_repo POST /admin/users/username/repos Create a repository on behalf of a user
Forgejo::AdminApi admin_create_user POST /admin/users Create a user
Forgejo::AdminApi admin_cron_list GET /admin/cron List cron tasks
Forgejo::AdminApi admin_cron_run POST /admin/cron/task Run cron task
Forgejo::AdminApi admin_d_elete_quota_rule DELETE /admin/quota/rules/quotarule Deletes a quota rule
Forgejo::AdminApi admin_delete_hook DELETE /admin/hooks/id Delete a hook
Forgejo::AdminApi admin_delete_quota_group DELETE /admin/quota/groups/quotagroup Delete a quota group
Forgejo::AdminApi admin_delete_unadopted_repository DELETE /admin/unadopted/owner/repo Delete unadopted files
Forgejo::AdminApi admin_delete_user DELETE /admin/users/username Delete a user
Forgejo::AdminApi admin_delete_user_public_key DELETE /admin/users/username/keys/id Delete a user's public key
Forgejo::AdminApi admin_edit_hook PATCH /admin/hooks/id Update a hook
Forgejo::AdminApi admin_edit_quota_rule PATCH /admin/quota/rules/quotarule Change an existing quota rule
Forgejo::AdminApi admin_edit_user PATCH /admin/users/username Edit an existing user
Forgejo::AdminApi admin_get_all_emails GET /admin/emails List all emails
Forgejo::AdminApi admin_get_all_orgs GET /admin/orgs List all organizations
Forgejo::AdminApi admin_get_hook GET /admin/hooks/id Get a hook
Forgejo::AdminApi admin_get_quota_group GET /admin/quota/groups/quotagroup Get information about the quota group
Forgejo::AdminApi admin_get_quota_rule GET /admin/quota/rules/quotarule Get information about a quota rule
Forgejo::AdminApi admin_get_runner_registration_token GET /admin/runners/registration-token Get an global actions runner registration token
Forgejo::AdminApi admin_get_user_quota GET /admin/users/username/quota Get the user's quota info
Forgejo::AdminApi admin_list_hooks GET /admin/hooks List system's webhooks
Forgejo::AdminApi admin_list_quota_groups GET /admin/quota/groups List the available quota groups
Forgejo::AdminApi admin_list_quota_rules GET /admin/quota/rules List the available quota rules
Forgejo::AdminApi admin_list_users_in_quota_group GET /admin/quota/groups/quotagroup/users List users in a quota group
Forgejo::AdminApi admin_remove_rule_from_quota_group DELETE /admin/quota/groups/quotagroup/rules/quotarule Removes a rule from a quota group
Forgejo::AdminApi admin_remove_user_from_quota_group DELETE /admin/quota/groups/quotagroup/users/username Remove a user from a quota group
Forgejo::AdminApi admin_rename_user POST /admin/users/username/rename Rename a user
Forgejo::AdminApi admin_search_emails GET /admin/emails/search Search all emails
Forgejo::AdminApi admin_search_users GET /admin/users Search users according filter conditions
Forgejo::AdminApi admin_set_user_quota_groups POST /admin/users/username/quota/groups Set the user's quota groups to a given list.
Forgejo::AdminApi admin_unadopted_list GET /admin/unadopted List unadopted repositories
Forgejo::IssueApi issue_add_label POST /repos/owner/repo/issues/index/labels Add a label to an issue
Forgejo::IssueApi issue_add_subscription PUT /repos/owner/repo/issues/index/subscriptions/user Subscribe user to issue
Forgejo::IssueApi issue_add_time POST /repos/owner/repo/issues/index/times Add tracked time to a issue
Forgejo::IssueApi issue_check_subscription GET /repos/owner/repo/issues/index/subscriptions/check Check if user is subscribed to an issue
Forgejo::IssueApi issue_clear_labels DELETE /repos/owner/repo/issues/index/labels Remove all labels from an issue
Forgejo::IssueApi issue_create_comment POST /repos/owner/repo/issues/index/comments Add a comment to an issue
Forgejo::IssueApi issue_create_issue POST /repos/owner/repo/issues Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
Forgejo::IssueApi issue_create_issue_attachment POST /repos/owner/repo/issues/index/assets Create an issue attachment
Forgejo::IssueApi issue_create_issue_blocking POST /repos/owner/repo/issues/index/blocks Block the issue given in the body by the issue in path
Forgejo::IssueApi issue_create_issue_comment_attachment POST /repos/owner/repo/issues/comments/id/assets Create a comment attachment
Forgejo::IssueApi issue_create_issue_dependencies POST /repos/owner/repo/issues/index/dependencies Make the issue in the url depend on the issue in the form.
Forgejo::IssueApi issue_create_label POST /repos/owner/repo/labels Create a label
Forgejo::IssueApi issue_create_milestone POST /repos/owner/repo/milestones Create a milestone
Forgejo::IssueApi issue_delete DELETE /repos/owner/repo/issues/index Delete an issue
Forgejo::IssueApi issue_delete_comment DELETE /repos/owner/repo/issues/comments/id Delete a comment
Forgejo::IssueApi issue_delete_comment_deprecated DELETE /repos/owner/repo/issues/index/comments/id Delete a comment
Forgejo::IssueApi issue_delete_comment_reaction DELETE /repos/owner/repo/issues/comments/id/reactions Remove a reaction from a comment of an issue
Forgejo::IssueApi issue_delete_issue_attachment DELETE /repos/owner/repo/issues/index/assets/attachment_id Delete an issue attachment
Forgejo::IssueApi issue_delete_issue_comment_attachment DELETE /repos/owner/repo/issues/comments/id/assets/attachment_id Delete a comment attachment
Forgejo::IssueApi issue_delete_issue_reaction DELETE /repos/owner/repo/issues/index/reactions Remove a reaction from an issue
Forgejo::IssueApi issue_delete_label DELETE /repos/owner/repo/labels/id Delete a label
Forgejo::IssueApi issue_delete_milestone DELETE /repos/owner/repo/milestones/id Delete a milestone
Forgejo::IssueApi issue_delete_stop_watch DELETE /repos/owner/repo/issues/index/stopwatch/delete Delete an issue's existing stopwatch.
Forgejo::IssueApi issue_delete_subscription DELETE /repos/owner/repo/issues/index/subscriptions/user Unsubscribe user from issue
Forgejo::IssueApi issue_delete_time DELETE /repos/owner/repo/issues/index/times/id Delete specific tracked time
Forgejo::IssueApi issue_edit_comment PATCH /repos/owner/repo/issues/comments/id Edit a comment
Forgejo::IssueApi issue_edit_comment_deprecated PATCH /repos/owner/repo/issues/index/comments/id Edit a comment
Forgejo::IssueApi issue_edit_issue PATCH /repos/owner/repo/issues/index Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
Forgejo::IssueApi issue_edit_issue_attachment PATCH /repos/owner/repo/issues/index/assets/attachment_id Edit an issue attachment
Forgejo::IssueApi issue_edit_issue_comment_attachment PATCH /repos/owner/repo/issues/comments/id/assets/attachment_id Edit a comment attachment
Forgejo::IssueApi issue_edit_issue_deadline POST /repos/owner/repo/issues/index/deadline Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
Forgejo::IssueApi issue_edit_label PATCH /repos/owner/repo/labels/id Update a label
Forgejo::IssueApi issue_edit_milestone PATCH /repos/owner/repo/milestones/id Update a milestone
Forgejo::IssueApi issue_get_comment GET /repos/owner/repo/issues/comments/id Get a comment
Forgejo::IssueApi issue_get_comment_reactions GET /repos/owner/repo/issues/comments/id/reactions Get a list of reactions from a comment of an issue
Forgejo::IssueApi issue_get_comments GET /repos/owner/repo/issues/index/comments List all comments on an issue
Forgejo::IssueApi issue_get_comments_and_timeline GET /repos/owner/repo/issues/index/timeline List all comments and events on an issue
Forgejo::IssueApi issue_get_issue GET /repos/owner/repo/issues/index Get an issue
Forgejo::IssueApi issue_get_issue_attachment GET /repos/owner/repo/issues/index/assets/attachment_id Get an issue attachment
Forgejo::IssueApi issue_get_issue_comment_attachment GET /repos/owner/repo/issues/comments/id/assets/attachment_id Get a comment attachment
Forgejo::IssueApi issue_get_issue_reactions GET /repos/owner/repo/issues/index/reactions Get a list reactions of an issue
Forgejo::IssueApi issue_get_label GET /repos/owner/repo/labels/id Get a single label
Forgejo::IssueApi issue_get_labels GET /repos/owner/repo/issues/index/labels Get an issue's labels
Forgejo::IssueApi issue_get_milestone GET /repos/owner/repo/milestones/id Get a milestone
Forgejo::IssueApi issue_get_milestones_list GET /repos/owner/repo/milestones Get all of a repository's opened milestones
Forgejo::IssueApi issue_get_repo_comments GET /repos/owner/repo/issues/comments List all comments in a repository
Forgejo::IssueApi issue_list_blocks GET /repos/owner/repo/issues/index/blocks List issues that are blocked by this issue
Forgejo::IssueApi issue_list_issue_attachments GET /repos/owner/repo/issues/index/assets List issue's attachments
Forgejo::IssueApi issue_list_issue_comment_attachments GET /repos/owner/repo/issues/comments/id/assets List comment's attachments
Forgejo::IssueApi issue_list_issue_dependencies GET /repos/owner/repo/issues/index/dependencies List an issue's dependencies, i.e all issues that block this issue.
Forgejo::IssueApi issue_list_issues GET /repos/owner/repo/issues List a repository's issues
Forgejo::IssueApi issue_list_labels GET /repos/owner/repo/labels Get all of a repository's labels
Forgejo::IssueApi issue_post_comment_reaction POST /repos/owner/repo/issues/comments/id/reactions Add a reaction to a comment of an issue
Forgejo::IssueApi issue_post_issue_reaction POST /repos/owner/repo/issues/index/reactions Add a reaction to an issue
Forgejo::IssueApi issue_remove_issue_blocking DELETE /repos/owner/repo/issues/index/blocks Unblock the issue given in the body by the issue in path
Forgejo::IssueApi issue_remove_issue_dependencies DELETE /repos/owner/repo/issues/index/dependencies Remove an issue dependency
Forgejo::IssueApi issue_remove_label DELETE /repos/owner/repo/issues/index/labels/id Remove a label from an issue
Forgejo::IssueApi issue_replace_labels PUT /repos/owner/repo/issues/index/labels Replace an issue's labels
Forgejo::IssueApi issue_reset_time DELETE /repos/owner/repo/issues/index/times Reset a tracked time of an issue
Forgejo::IssueApi issue_search_issues GET /repos/issues/search Search for issues across the repositories that the user has access to
Forgejo::IssueApi issue_start_stop_watch POST /repos/owner/repo/issues/index/stopwatch/start Start stopwatch on an issue.
Forgejo::IssueApi issue_stop_stop_watch POST /repos/owner/repo/issues/index/stopwatch/stop Stop an issue's existing stopwatch.
Forgejo::IssueApi issue_subscriptions GET /repos/owner/repo/issues/index/subscriptions Get users who subscribed on an issue.
Forgejo::IssueApi issue_tracked_times GET /repos/owner/repo/issues/index/times List an issue's tracked times
Forgejo::IssueApi move_issue_pin PATCH /repos/owner/repo/issues/index/pin/position Moves the Pin to the given Position
Forgejo::IssueApi pin_issue POST /repos/owner/repo/issues/index/pin Pin an Issue
Forgejo::IssueApi unpin_issue DELETE /repos/owner/repo/issues/index/pin Unpin an Issue
Forgejo::MiscellaneousApi get_gitignore_template_info GET /gitignore/templates/name Returns information about a gitignore template
Forgejo::MiscellaneousApi get_label_template_info GET /label/templates/name Returns all labels in a template
Forgejo::MiscellaneousApi get_license_template_info GET /licenses/name Returns information about a license template
Forgejo::MiscellaneousApi get_node_info GET /nodeinfo Returns the nodeinfo of the Gitea application
Forgejo::MiscellaneousApi get_signing_key GET /signing-key.gpg Get default signing-key.gpg
Forgejo::MiscellaneousApi get_version GET /version Returns the version of the Gitea application
Forgejo::MiscellaneousApi list_gitignores_templates GET /gitignore/templates Returns a list of all gitignore templates
Forgejo::MiscellaneousApi list_label_templates GET /label/templates Returns a list of all label templates
Forgejo::MiscellaneousApi list_license_templates GET /licenses Returns a list of all license templates
Forgejo::MiscellaneousApi render_markdown POST /markdown Render a markdown document as HTML
Forgejo::MiscellaneousApi render_markdown_raw POST /markdown/raw Render raw markdown as HTML
Forgejo::MiscellaneousApi render_markup POST /markup Render a markup document as HTML
Forgejo::NotificationApi notify_get_list GET /notifications List users's notification threads
Forgejo::NotificationApi notify_get_repo_list GET /repos/owner/repo/notifications List users's notification threads on a specific repo
Forgejo::NotificationApi notify_get_thread GET /notifications/threads/id Get notification thread by ID
Forgejo::NotificationApi notify_new_available GET /notifications/new Check if unread notifications exist
Forgejo::NotificationApi notify_read_list PUT /notifications Mark notification threads as read, pinned or unread
Forgejo::NotificationApi notify_read_repo_list PUT /repos/owner/repo/notifications Mark notification threads as read, pinned or unread on a specific repo
Forgejo::NotificationApi notify_read_thread PATCH /notifications/threads/id Mark notification thread as read by ID
Forgejo::OrganizationApi create_org_repo POST /orgs/org/repos Create a repository in an organization
Forgejo::OrganizationApi create_org_repo_deprecated POST /org/org/repos Create a repository in an organization
Forgejo::OrganizationApi create_org_variable POST /orgs/org/actions/variables/variablename Create an org-level variable
Forgejo::OrganizationApi delete_org_secret DELETE /orgs/org/actions/secrets/secretname Delete a secret in an organization
Forgejo::OrganizationApi delete_org_variable DELETE /orgs/org/actions/variables/variablename Delete an org-level variable
Forgejo::OrganizationApi get_org_variable GET /orgs/org/actions/variables/variablename Get an org-level variable
Forgejo::OrganizationApi get_org_variables_list GET /orgs/org/actions/variables Get an org-level variables list
Forgejo::OrganizationApi org_add_team_member PUT /teams/id/members/username Add a team member
Forgejo::OrganizationApi org_add_team_repository PUT /teams/id/repos/org/repo Add a repository to a team
Forgejo::OrganizationApi org_block_user PUT /orgs/org/block/username Blocks a user from the organization
Forgejo::OrganizationApi org_check_quota GET /orgs/org/quota/check Check if the organization is over quota for a given subject
Forgejo::OrganizationApi org_conceal_member DELETE /orgs/org/public_members/username Conceal a user's membership
Forgejo::OrganizationApi org_create POST /orgs Create an organization
Forgejo::OrganizationApi org_create_hook POST /orgs/org/hooks Create a hook
Forgejo::OrganizationApi org_create_label POST /orgs/org/labels Create a label for an organization
Forgejo::OrganizationApi org_create_team POST /orgs/org/teams Create a team
Forgejo::OrganizationApi org_delete DELETE /orgs/org Delete an organization
Forgejo::OrganizationApi org_delete_avatar DELETE /orgs/org/avatar Delete Avatar
Forgejo::OrganizationApi org_delete_hook DELETE /orgs/org/hooks/id Delete a hook
Forgejo::OrganizationApi org_delete_label DELETE /orgs/org/labels/id Delete a label
Forgejo::OrganizationApi org_delete_member DELETE /orgs/org/members/username Remove a member from an organization
Forgejo::OrganizationApi org_delete_team DELETE /teams/id Delete a team
Forgejo::OrganizationApi org_edit PATCH /orgs/org Edit an organization
Forgejo::OrganizationApi org_edit_hook PATCH /orgs/org/hooks/id Update a hook
Forgejo::OrganizationApi org_edit_label PATCH /orgs/org/labels/id Update a label
Forgejo::OrganizationApi org_edit_team PATCH /teams/id Edit a team
Forgejo::OrganizationApi org_get GET /orgs/org Get an organization
Forgejo::OrganizationApi org_get_all GET /orgs Get list of organizations
Forgejo::OrganizationApi org_get_hook GET /orgs/org/hooks/id Get a hook
Forgejo::OrganizationApi org_get_label GET /orgs/org/labels/id Get a single label
Forgejo::OrganizationApi org_get_quota GET /orgs/org/quota Get quota information for an organization
Forgejo::OrganizationApi org_get_runner_registration_token GET /orgs/org/actions/runners/registration-token Get an organization's actions runner registration token
Forgejo::OrganizationApi org_get_team GET /teams/id Get a team
Forgejo::OrganizationApi org_get_user_permissions GET /users/username/orgs/org/permissions Get user permissions in organization
Forgejo::OrganizationApi org_is_member GET /orgs/org/members/username Check if a user is a member of an organization
Forgejo::OrganizationApi org_is_public_member GET /orgs/org/public_members/username Check if a user is a public member of an organization
Forgejo::OrganizationApi org_list_actions_secrets GET /orgs/org/actions/secrets List an organization's actions secrets
Forgejo::OrganizationApi org_list_activity_feeds GET /orgs/org/activities/feeds List an organization's activity feeds
Forgejo::OrganizationApi org_list_blocked_users GET /orgs/org/list_blocked List the organization's blocked users
Forgejo::OrganizationApi org_list_current_user_orgs GET /user/orgs List the current user's organizations
Forgejo::OrganizationApi org_list_hooks GET /orgs/org/hooks List an organization's webhooks
Forgejo::OrganizationApi org_list_labels GET /orgs/org/labels List an organization's labels
Forgejo::OrganizationApi org_list_members GET /orgs/org/members List an organization's members
Forgejo::OrganizationApi org_list_public_members GET /orgs/org/public_members List an organization's public members
Forgejo::OrganizationApi org_list_quota_artifacts GET /orgs/org/quota/artifacts List the artifacts affecting the organization's quota
Forgejo::OrganizationApi org_list_quota_attachments GET /orgs/org/quota/attachments List the attachments affecting the organization's quota
Forgejo::OrganizationApi org_list_quota_packages GET /orgs/org/quota/packages List the packages affecting the organization's quota
Forgejo::OrganizationApi org_list_repos GET /orgs/org/repos List an organization's repos
Forgejo::OrganizationApi org_list_team_activity_feeds GET /teams/id/activities/feeds List a team's activity feeds
Forgejo::OrganizationApi org_list_team_member GET /teams/id/members/username List a particular member of team
Forgejo::OrganizationApi org_list_team_members GET /teams/id/members List a team's members
Forgejo::OrganizationApi org_list_team_repo GET /teams/id/repos/org/repo List a particular repo of team
Forgejo::OrganizationApi org_list_team_repos GET /teams/id/repos List a team's repos
Forgejo::OrganizationApi org_list_teams GET /orgs/org/teams List an organization's teams
Forgejo::OrganizationApi org_list_user_orgs GET /users/username/orgs List a user's organizations
Forgejo::OrganizationApi org_publicize_member PUT /orgs/org/public_members/username Publicize a user's membership
Forgejo::OrganizationApi org_remove_team_member DELETE /teams/id/members/username Remove a team member
Forgejo::OrganizationApi org_remove_team_repository DELETE /teams/id/repos/org/repo Remove a repository from a team
Forgejo::OrganizationApi org_unblock_user PUT /orgs/org/unblock/username Unblock a user from the organization
Forgejo::OrganizationApi org_update_avatar POST /orgs/org/avatar Update Avatar
Forgejo::OrganizationApi team_search GET /orgs/org/teams/search Search for teams within an organization
Forgejo::OrganizationApi update_org_secret PUT /orgs/org/actions/secrets/secretname Create or Update a secret value in an organization
Forgejo::OrganizationApi update_org_variable PUT /orgs/org/actions/variables/variablename Update an org-level variable
Forgejo::PackageApi delete_package DELETE /packages/owner/type/name/version Delete a package
Forgejo::PackageApi get_package GET /packages/owner/type/name/version Gets a package
Forgejo::PackageApi list_package_files GET /packages/owner/type/name/version/files Gets all files of a package
Forgejo::PackageApi list_packages GET /packages/owner Gets all packages of an owner
Forgejo::RepositoryApi accept_repo_transfer POST /repos/owner/repo/transfer/accept Accept a repo transfer
Forgejo::RepositoryApi create_current_user_repo POST /user/repos Create a repository
Forgejo::RepositoryApi create_fork POST /repos/owner/repo/forks Fork a repository
Forgejo::RepositoryApi create_repo_variable POST /repos/owner/repo/actions/variables/variablename Create a repo-level variable
Forgejo::RepositoryApi delete_repo_secret DELETE /repos/owner/repo/actions/secrets/secretname Delete a secret in a repository
Forgejo::RepositoryApi delete_repo_variable DELETE /repos/owner/repo/actions/variables/variablename Delete a repo-level variable
Forgejo::RepositoryApi dispatch_workflow POST /repos/owner/repo/actions/workflows/workflowname/dispatches Dispatches a workflow
Forgejo::RepositoryApi generate_repo POST /repos/template_owner/template_repo/generate Create a repository using a template
Forgejo::RepositoryApi get_annotated_tag GET /repos/owner/repo/git/tags/sha Gets the tag object of an annotated tag (not lightweight tags)
Forgejo::RepositoryApi get_blob GET /repos/owner/repo/git/blobs/sha Gets the blob of a repository.
Forgejo::RepositoryApi get_repo_variable GET /repos/owner/repo/actions/variables/variablename Get a repo-level variable
Forgejo::RepositoryApi get_repo_variables_list GET /repos/owner/repo/actions/variables Get repo-level variables list
Forgejo::RepositoryApi get_tree GET /repos/owner/repo/git/trees/sha Gets the tree of a repository.
Forgejo::RepositoryApi list_action_tasks GET /repos/owner/repo/actions/tasks List a repository's action tasks
Forgejo::RepositoryApi list_forks GET /repos/owner/repo/forks List a repository's forks
Forgejo::RepositoryApi reject_repo_transfer POST /repos/owner/repo/transfer/reject Reject a repo transfer
Forgejo::RepositoryApi repo_add_collaborator PUT /repos/owner/repo/collaborators/collaborator Add a collaborator to a repository
Forgejo::RepositoryApi repo_add_flag PUT /repos/owner/repo/flags/flag Add a flag to a repository
Forgejo::RepositoryApi repo_add_push_mirror POST /repos/owner/repo/push_mirrors add a push mirror to the repository
Forgejo::RepositoryApi repo_add_team PUT /repos/owner/repo/teams/team Add a team to a repository
Forgejo::RepositoryApi repo_add_topic PUT /repos/owner/repo/topics/topic Add a topic to a repository
Forgejo::RepositoryApi repo_apply_diff_patch POST /repos/owner/repo/diffpatch Apply diff patch to repository
Forgejo::RepositoryApi repo_cancel_scheduled_auto_merge DELETE /repos/owner/repo/pulls/index/merge Cancel the scheduled auto merge for the given pull request
Forgejo::RepositoryApi repo_change_files POST /repos/owner/repo/contents Modify multiple files in a repository
Forgejo::RepositoryApi repo_check_collaborator GET /repos/owner/repo/collaborators/collaborator Check if a user is a collaborator of a repository
Forgejo::RepositoryApi repo_check_flag GET /repos/owner/repo/flags/flag Check if a repository has a given flag
Forgejo::RepositoryApi repo_check_team GET /repos/owner/repo/teams/team Check if a team is assigned to a repository
Forgejo::RepositoryApi repo_compare_diff GET /repos/owner/repo/compare/basehead Get commit comparison information
Forgejo::RepositoryApi repo_create_branch POST /repos/owner/repo/branches Create a branch
Forgejo::RepositoryApi repo_create_branch_protection POST /repos/owner/repo/branch_protections Create a branch protections for a repository
Forgejo::RepositoryApi repo_create_file POST /repos/owner/repo/contents/filepath Create a file in a repository
Forgejo::RepositoryApi repo_create_hook POST /repos/owner/repo/hooks Create a hook
Forgejo::RepositoryApi repo_create_key POST /repos/owner/repo/keys Add a key to a repository
Forgejo::RepositoryApi repo_create_pull_request POST /repos/owner/repo/pulls Create a pull request
Forgejo::RepositoryApi repo_create_pull_review POST /repos/owner/repo/pulls/index/reviews Create a review to an pull request
Forgejo::RepositoryApi repo_create_pull_review_comment POST /repos/owner/repo/pulls/index/reviews/id/comments Add a new comment to a pull request review
Forgejo::RepositoryApi repo_create_pull_review_requests POST /repos/owner/repo/pulls/index/requested_reviewers create review requests for a pull request
Forgejo::RepositoryApi repo_create_release POST /repos/owner/repo/releases Create a release
Forgejo::RepositoryApi repo_create_release_attachment POST /repos/owner/repo/releases/id/assets Create a release attachment
Forgejo::RepositoryApi repo_create_status POST /repos/owner/repo/statuses/sha Create a commit status
Forgejo::RepositoryApi repo_create_tag POST /repos/owner/repo/tags Create a new git tag in a repository
Forgejo::RepositoryApi repo_create_tag_protection POST /repos/owner/repo/tag_protections Create a tag protections for a repository
Forgejo::RepositoryApi repo_create_wiki_page POST /repos/owner/repo/wiki/new Create a wiki page
Forgejo::RepositoryApi repo_delete DELETE /repos/owner/repo Delete a repository
Forgejo::RepositoryApi repo_delete_all_flags DELETE /repos/owner/repo/flags Remove all flags from a repository
Forgejo::RepositoryApi repo_delete_avatar DELETE /repos/owner/repo/avatar Delete avatar
Forgejo::RepositoryApi repo_delete_branch DELETE /repos/owner/repo/branches/branch Delete a specific branch from a repository
Forgejo::RepositoryApi repo_delete_branch_protection DELETE /repos/owner/repo/branch_protections/name Delete a specific branch protection for the repository
Forgejo::RepositoryApi repo_delete_collaborator DELETE /repos/owner/repo/collaborators/collaborator Delete a collaborator from a repository
Forgejo::RepositoryApi repo_delete_file DELETE /repos/owner/repo/contents/filepath Delete a file in a repository
Forgejo::RepositoryApi repo_delete_flag DELETE /repos/owner/repo/flags/flag Remove a flag from a repository
Forgejo::RepositoryApi repo_delete_git_hook DELETE /repos/owner/repo/hooks/git/id Delete a Git hook in a repository
Forgejo::RepositoryApi repo_delete_hook DELETE /repos/owner/repo/hooks/id Delete a hook in a repository
Forgejo::RepositoryApi repo_delete_key DELETE /repos/owner/repo/keys/id Delete a key from a repository
Forgejo::RepositoryApi repo_delete_pull_review DELETE /repos/owner/repo/pulls/index/reviews/id Delete a specific review from a pull request
Forgejo::RepositoryApi repo_delete_pull_review_comment DELETE /repos/owner/repo/pulls/index/reviews/id/comments/comment Delete a pull review comment
Forgejo::RepositoryApi repo_delete_pull_review_requests DELETE /repos/owner/repo/pulls/index/requested_reviewers cancel review requests for a pull request
Forgejo::RepositoryApi repo_delete_push_mirror DELETE /repos/owner/repo/push_mirrors/name deletes a push mirror from a repository by remoteName
Forgejo::RepositoryApi repo_delete_release DELETE /repos/owner/repo/releases/id Delete a release
Forgejo::RepositoryApi repo_delete_release_attachment DELETE /repos/owner/repo/releases/id/assets/attachment_id Delete a release attachment
Forgejo::RepositoryApi repo_delete_release_by_tag DELETE /repos/owner/repo/releases/tags/tag Delete a release by tag name
Forgejo::RepositoryApi repo_delete_tag DELETE /repos/owner/repo/tags/tag Delete a repository's tag by name
Forgejo::RepositoryApi repo_delete_tag_protection DELETE /repos/owner/repo/tag_protections/id Delete a specific tag protection for the repository
Forgejo::RepositoryApi repo_delete_team DELETE /repos/owner/repo/teams/team Delete a team from a repository
Forgejo::RepositoryApi repo_delete_topic DELETE /repos/owner/repo/topics/topic Delete a topic from a repository
Forgejo::RepositoryApi repo_delete_wiki_page DELETE /repos/owner/repo/wiki/page/pageName Delete a wiki page
Forgejo::RepositoryApi repo_dismiss_pull_review POST /repos/owner/repo/pulls/index/reviews/id/dismissals Dismiss a review for a pull request
Forgejo::RepositoryApi repo_download_commit_diff_or_patch GET /repos/owner/repo/git/commits/sha.diffType Get a commit's diff or patch
Forgejo::RepositoryApi repo_download_pull_diff_or_patch GET /repos/owner/repo/pulls/index.diffType Get a pull request diff or patch
Forgejo::RepositoryApi repo_edit PATCH /repos/owner/repo Edit a repository's properties. Only fields that are set will be changed.
Forgejo::RepositoryApi repo_edit_branch_protection PATCH /repos/owner/repo/branch_protections/name Edit a branch protections for a repository. Only fields that are set will be changed
Forgejo::RepositoryApi repo_edit_git_hook PATCH /repos/owner/repo/hooks/git/id Edit a Git hook in a repository
Forgejo::RepositoryApi repo_edit_hook PATCH /repos/owner/repo/hooks/id Edit a hook in a repository
Forgejo::RepositoryApi repo_edit_pull_request PATCH /repos/owner/repo/pulls/index Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.
Forgejo::RepositoryApi repo_edit_release PATCH /repos/owner/repo/releases/id Update a release
Forgejo::RepositoryApi repo_edit_release_attachment PATCH /repos/owner/repo/releases/id/assets/attachment_id Edit a release attachment
Forgejo::RepositoryApi repo_edit_tag_protection PATCH /repos/owner/repo/tag_protections/id Edit a tag protections for a repository. Only fields that are set will be changed
Forgejo::RepositoryApi repo_edit_wiki_page PATCH /repos/owner/repo/wiki/page/pageName Edit a wiki page
Forgejo::RepositoryApi repo_get GET /repos/owner/repo Get a repository
Forgejo::RepositoryApi repo_get_all_commits GET /repos/owner/repo/commits Get a list of all commits from a repository
Forgejo::RepositoryApi repo_get_archive GET /repos/owner/repo/archive/archive Get an archive of a repository
Forgejo::RepositoryApi repo_get_assignees GET /repos/owner/repo/assignees Return all users that have write access and can be assigned to issues
Forgejo::RepositoryApi repo_get_branch GET /repos/owner/repo/branches/branch Retrieve a specific branch from a repository, including its effective branch protection
Forgejo::RepositoryApi repo_get_branch_protection GET /repos/owner/repo/branch_protections/name Get a specific branch protection for the repository
Forgejo::RepositoryApi repo_get_by_id GET /repositories/id Get a repository by id
Forgejo::RepositoryApi repo_get_combined_status_by_ref GET /repos/owner/repo/commits/ref/status Get a commit's combined status, by branch/tag/commit reference
Forgejo::RepositoryApi repo_get_commit_pull_request GET /repos/owner/repo/commits/sha/pull Get the pull request of the commit
Forgejo::RepositoryApi repo_get_contents GET /repos/owner/repo/contents/filepath Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir
Forgejo::RepositoryApi repo_get_contents_list GET /repos/owner/repo/contents Gets the metadata of all the entries of the root dir
Forgejo::RepositoryApi repo_get_editor_config GET /repos/owner/repo/editorconfig/filepath Get the EditorConfig definitions of a file in a repository
Forgejo::RepositoryApi repo_get_git_hook GET /repos/owner/repo/hooks/git/id Get a Git hook
Forgejo::RepositoryApi repo_get_hook GET /repos/owner/repo/hooks/id Get a hook
Forgejo::RepositoryApi repo_get_issue_config GET /repos/owner/repo/issue_config Returns the issue config for a repo
Forgejo::RepositoryApi repo_get_issue_templates GET /repos/owner/repo/issue_templates Get available issue templates for a repository
Forgejo::RepositoryApi repo_get_key GET /repos/owner/repo/keys/id Get a repository's key by id
Forgejo::RepositoryApi repo_get_languages GET /repos/owner/repo/languages Get languages and number of bytes of code written
Forgejo::RepositoryApi repo_get_latest_release GET /repos/owner/repo/releases/latest Gets the most recent non-prerelease, non-draft release of a repository, sorted by created_at
Forgejo::RepositoryApi repo_get_note GET /repos/owner/repo/git/notes/sha Get a note corresponding to a single commit from a repository
Forgejo::RepositoryApi repo_get_pull_request GET /repos/owner/repo/pulls/index Get a pull request
Forgejo::RepositoryApi repo_get_pull_request_by_base_head GET /repos/owner/repo/pulls/base/head Get a pull request by base and head
Forgejo::RepositoryApi repo_get_pull_request_commits GET /repos/owner/repo/pulls/index/commits Get commits for a pull request
Forgejo::RepositoryApi repo_get_pull_request_files GET /repos/owner/repo/pulls/index/files Get changed files for a pull request
Forgejo::RepositoryApi repo_get_pull_review GET /repos/owner/repo/pulls/index/reviews/id Get a specific review for a pull request
Forgejo::RepositoryApi repo_get_pull_review_comment GET /repos/owner/repo/pulls/index/reviews/id/comments/comment Get a pull review comment
Forgejo::RepositoryApi repo_get_pull_review_comments GET /repos/owner/repo/pulls/index/reviews/id/comments Get a specific review for a pull request
Forgejo::RepositoryApi repo_get_push_mirror_by_remote_name GET /repos/owner/repo/push_mirrors/name Get push mirror of the repository by remoteName
Forgejo::RepositoryApi repo_get_raw_file GET /repos/owner/repo/raw/filepath Get a file from a repository
Forgejo::RepositoryApi repo_get_raw_file_or_lfs GET /repos/owner/repo/media/filepath Get a file or it's LFS object from a repository
Forgejo::RepositoryApi repo_get_release GET /repos/owner/repo/releases/id Get a release
Forgejo::RepositoryApi repo_get_release_attachment GET /repos/owner/repo/releases/id/assets/attachment_id Get a release attachment
Forgejo::RepositoryApi repo_get_release_by_tag GET /repos/owner/repo/releases/tags/tag Get a release by tag name
Forgejo::RepositoryApi repo_get_repo_permissions GET /repos/owner/repo/collaborators/collaborator/permission Get repository permissions for a user
Forgejo::RepositoryApi repo_get_reviewers GET /repos/owner/repo/reviewers Return all users that can be requested to review in this repo
Forgejo::RepositoryApi repo_get_runner_registration_token GET /repos/owner/repo/actions/runners/registration-token Get a repository's actions runner registration token
Forgejo::RepositoryApi repo_get_single_commit GET /repos/owner/repo/git/commits/sha Get a single commit from a repository
Forgejo::RepositoryApi repo_get_tag GET /repos/owner/repo/tags/tag Get the tag of a repository by tag name
Forgejo::RepositoryApi repo_get_tag_protection GET /repos/owner/repo/tag_protections/id Get a specific tag protection for the repository
Forgejo::RepositoryApi repo_get_wiki_page GET /repos/owner/repo/wiki/page/pageName Get a wiki page
Forgejo::RepositoryApi repo_get_wiki_page_revisions GET /repos/owner/repo/wiki/revisions/pageName Get revisions of a wiki page
Forgejo::RepositoryApi repo_get_wiki_pages GET /repos/owner/repo/wiki/pages Get all wiki pages
Forgejo::RepositoryApi repo_list_actions_secrets GET /repos/owner/repo/actions/secrets List an repo's actions secrets
Forgejo::RepositoryApi repo_list_activity_feeds GET /repos/owner/repo/activities/feeds List a repository's activity feeds
Forgejo::RepositoryApi repo_list_all_git_refs GET /repos/owner/repo/git/refs Get specified ref or filtered repository's refs
Forgejo::RepositoryApi repo_list_branch_protection GET /repos/owner/repo/branch_protections List branch protections for a repository
Forgejo::RepositoryApi repo_list_branches GET /repos/owner/repo/branches List a repository's branches
Forgejo::RepositoryApi repo_list_collaborators GET /repos/owner/repo/collaborators List a repository's collaborators
Forgejo::RepositoryApi repo_list_flags GET /repos/owner/repo/flags List a repository's flags
Forgejo::RepositoryApi repo_list_git_hooks GET /repos/owner/repo/hooks/git List the Git hooks in a repository
Forgejo::RepositoryApi repo_list_git_refs GET /repos/owner/repo/git/refs/ref Get specified ref or filtered repository's refs
Forgejo::RepositoryApi repo_list_hooks GET /repos/owner/repo/hooks List the hooks in a repository
Forgejo::RepositoryApi repo_list_keys GET /repos/owner/repo/keys List a repository's keys
Forgejo::RepositoryApi repo_list_pinned_issues GET /repos/owner/repo/issues/pinned List a repo's pinned issues
Forgejo::RepositoryApi repo_list_pinned_pull_requests GET /repos/owner/repo/pulls/pinned List a repo's pinned pull requests
Forgejo::RepositoryApi repo_list_pull_requests GET /repos/owner/repo/pulls List a repo's pull requests
Forgejo::RepositoryApi repo_list_pull_reviews GET /repos/owner/repo/pulls/index/reviews List all reviews for a pull request
Forgejo::RepositoryApi repo_list_push_mirrors GET /repos/owner/repo/push_mirrors Get all push mirrors of the repository
Forgejo::RepositoryApi repo_list_release_attachments GET /repos/owner/repo/releases/id/assets List release's attachments
Forgejo::RepositoryApi repo_list_releases GET /repos/owner/repo/releases List a repo's releases
Forgejo::RepositoryApi repo_list_stargazers GET /repos/owner/repo/stargazers List a repo's stargazers
Forgejo::RepositoryApi repo_list_statuses GET /repos/owner/repo/statuses/sha Get a commit's statuses
Forgejo::RepositoryApi repo_list_statuses_by_ref GET /repos/owner/repo/commits/ref/statuses Get a commit's statuses, by branch/tag/commit reference
Forgejo::RepositoryApi repo_list_subscribers GET /repos/owner/repo/subscribers List a repo's watchers
Forgejo::RepositoryApi repo_list_tag_protection GET /repos/owner/repo/tag_protections List tag protections for a repository
Forgejo::RepositoryApi repo_list_tags GET /repos/owner/repo/tags List a repository's tags
Forgejo::RepositoryApi repo_list_teams GET /repos/owner/repo/teams List a repository's teams
Forgejo::RepositoryApi repo_list_topics GET /repos/owner/repo/topics Get list of topics that a repository has
Forgejo::RepositoryApi repo_merge_pull_request POST /repos/owner/repo/pulls/index/merge Merge a pull request
Forgejo::RepositoryApi repo_migrate POST /repos/migrate Migrate a remote git repository
Forgejo::RepositoryApi repo_mirror_sync POST /repos/owner/repo/mirror-sync Sync a mirrored repository
Forgejo::RepositoryApi repo_new_pin_allowed GET /repos/owner/repo/new_pin_allowed Returns if new Issue Pins are allowed
Forgejo::RepositoryApi repo_pull_request_is_merged GET /repos/owner/repo/pulls/index/merge Check if a pull request has been merged
Forgejo::RepositoryApi repo_push_mirror_sync POST /repos/owner/repo/push_mirrors-sync Sync all push mirrored repository
Forgejo::RepositoryApi repo_remove_note DELETE /repos/owner/repo/git/notes/sha Removes a note corresponding to a single commit from a repository
Forgejo::RepositoryApi repo_replace_all_flags PUT /repos/owner/repo/flags Replace all flags of a repository
Forgejo::RepositoryApi repo_search GET /repos/search Search for repositories
Forgejo::RepositoryApi repo_set_note POST /repos/owner/repo/git/notes/sha Set a note corresponding to a single commit from a repository
Forgejo::RepositoryApi repo_signing_key GET /repos/owner/repo/signing-key.gpg Get signing-key.gpg for given repository
Forgejo::RepositoryApi repo_submit_pull_review POST /repos/owner/repo/pulls/index/reviews/id Submit a pending review to an pull request
Forgejo::RepositoryApi repo_test_hook POST /repos/owner/repo/hooks/id/tests Test a push webhook
Forgejo::RepositoryApi repo_tracked_times GET /repos/owner/repo/times List a repo's tracked times
Forgejo::RepositoryApi repo_transfer POST /repos/owner/repo/transfer Transfer a repo ownership
Forgejo::RepositoryApi repo_un_dismiss_pull_review POST /repos/owner/repo/pulls/index/reviews/id/undismissals Cancel to dismiss a review for a pull request
Forgejo::RepositoryApi repo_update_avatar POST /repos/owner/repo/avatar Update avatar
Forgejo::RepositoryApi repo_update_branch PATCH /repos/owner/repo/branches/branch Update a branch
Forgejo::RepositoryApi repo_update_file PUT /repos/owner/repo/contents/filepath Update a file in a repository
Forgejo::RepositoryApi repo_update_pull_request POST /repos/owner/repo/pulls/index/update Merge PR's baseBranch into headBranch
Forgejo::RepositoryApi repo_update_topics PUT /repos/owner/repo/topics Replace list of topics for a repository
Forgejo::RepositoryApi repo_validate_issue_config GET /repos/owner/repo/issue_config/validate Returns the validation information for a issue config
Forgejo::RepositoryApi topic_search GET /topics/search search topics via keyword
Forgejo::RepositoryApi update_repo_secret PUT /repos/owner/repo/actions/secrets/secretname Create or Update a secret value in a repository
Forgejo::RepositoryApi update_repo_variable PUT /repos/owner/repo/actions/variables/variablename Update a repo-level variable
Forgejo::RepositoryApi user_current_check_subscription GET /repos/owner/repo/subscription Check if the current user is watching a repo
Forgejo::RepositoryApi user_current_delete_subscription DELETE /repos/owner/repo/subscription Unwatch a repo
Forgejo::RepositoryApi user_current_put_subscription PUT /repos/owner/repo/subscription Watch a repo
Forgejo::RepositoryApi user_tracked_times GET /repos/owner/repo/times/user List a user's tracked times in a repo
Forgejo::SettingsApi get_general_api_settings GET /settings/api Get instance's global settings for api
Forgejo::SettingsApi get_general_attachment_settings GET /settings/attachment Get instance's global settings for Attachment
Forgejo::SettingsApi get_general_repository_settings GET /settings/repository Get instance's global settings for repositories
Forgejo::SettingsApi get_general_ui_settings GET /settings/ui Get instance's global settings for ui
Forgejo::UserApi create_current_user_repo POST /user/repos Create a repository
Forgejo::UserApi create_user_variable POST /user/actions/variables/variablename Create a user-level variable
Forgejo::UserApi delete_user_secret DELETE /user/actions/secrets/secretname Delete a secret in a user scope
Forgejo::UserApi delete_user_variable DELETE /user/actions/variables/variablename Delete a user-level variable which is created by current doer
Forgejo::UserApi get_user_settings GET /user/settings Get user settings
Forgejo::UserApi get_user_variable GET /user/actions/variables/variablename Get a user-level variable which is created by current doer
Forgejo::UserApi get_user_variables_list GET /user/actions/variables Get the user-level list of variables which is created by current doer
Forgejo::UserApi get_verification_token GET /user/gpg_key_token Get a Token to verify
Forgejo::UserApi update_user_secret PUT /user/actions/secrets/secretname Create or Update a secret value in a user scope
Forgejo::UserApi update_user_settings PATCH /user/settings Update user settings
Forgejo::UserApi update_user_variable PUT /user/actions/variables/variablename Update a user-level variable which is created by current doer
Forgejo::UserApi user_add_email POST /user/emails Add email addresses
Forgejo::UserApi user_block_user PUT /user/block/username Blocks a user from the doer.
Forgejo::UserApi user_check_following GET /users/username/following/target Check if one user is following another user
Forgejo::UserApi user_check_quota GET /user/quota/check Check if the authenticated user is over quota for a given subject
Forgejo::UserApi user_create_hook POST /user/hooks Create a hook
Forgejo::UserApi user_create_o_auth2_application POST /user/applications/oauth2 creates a new OAuth2 application
Forgejo::UserApi user_create_token POST /users/username/tokens Create an access token
Forgejo::UserApi user_current_check_following GET /user/following/username Check whether a user is followed by the authenticated user
Forgejo::UserApi user_current_check_starring GET /user/starred/owner/repo Whether the authenticated is starring the repo
Forgejo::UserApi user_current_delete_follow DELETE /user/following/username Unfollow a user
Forgejo::UserApi user_current_delete_gpg_key DELETE /user/gpg_keys/id Remove a GPG key
Forgejo::UserApi user_current_delete_key DELETE /user/keys/id Delete a public key
Forgejo::UserApi user_current_delete_star DELETE /user/starred/owner/repo Unstar the given repo
Forgejo::UserApi user_current_get_gpg_key GET /user/gpg_keys/id Get a GPG key
Forgejo::UserApi user_current_get_key GET /user/keys/id Get a public key
Forgejo::UserApi user_current_list_followers GET /user/followers List the authenticated user's followers
Forgejo::UserApi user_current_list_following GET /user/following List the users that the authenticated user is following
Forgejo::UserApi user_current_list_gpg_keys GET /user/gpg_keys List the authenticated user's GPG keys
Forgejo::UserApi user_current_list_keys GET /user/keys List the authenticated user's public keys
Forgejo::UserApi user_current_list_repos GET /user/repos List the repos that the authenticated user owns
Forgejo::UserApi user_current_list_starred GET /user/starred The repos that the authenticated user has starred
Forgejo::UserApi user_current_list_subscriptions GET /user/subscriptions List repositories watched by the authenticated user
Forgejo::UserApi user_current_post_gpg_key POST /user/gpg_keys Create a GPG key
Forgejo::UserApi user_current_post_key POST /user/keys Create a public key
Forgejo::UserApi user_current_put_follow PUT /user/following/username Follow a user
Forgejo::UserApi user_current_put_star PUT /user/starred/owner/repo Star the given repo
Forgejo::UserApi user_current_tracked_times GET /user/times List the current user's tracked times
Forgejo::UserApi user_delete_access_token DELETE /users/username/tokens/token delete an access token
Forgejo::UserApi user_delete_avatar DELETE /user/avatar Delete Avatar
Forgejo::UserApi user_delete_email DELETE /user/emails Delete email addresses
Forgejo::UserApi user_delete_hook DELETE /user/hooks/id Delete a hook
Forgejo::UserApi user_delete_o_auth2_application DELETE /user/applications/oauth2/id delete an OAuth2 Application
Forgejo::UserApi user_edit_hook PATCH /user/hooks/id Update a hook
Forgejo::UserApi user_get GET /users/username Get a user
Forgejo::UserApi user_get_current GET /user Get the authenticated user
Forgejo::UserApi user_get_heatmap_data GET /users/username/heatmap Get a user's heatmap
Forgejo::UserApi user_get_hook GET /user/hooks/id Get a hook
Forgejo::UserApi user_get_o_auth2_application GET /user/applications/oauth2/id get an OAuth2 Application
Forgejo::UserApi user_get_o_auth2_applications GET /user/applications/oauth2 List the authenticated user's oauth2 applications
Forgejo::UserApi user_get_quota GET /user/quota Get quota information for the authenticated user
Forgejo::UserApi user_get_runner_registration_token GET /user/actions/runners/registration-token Get an user's actions runner registration token
Forgejo::UserApi user_get_stop_watches GET /user/stopwatches Get list of all existing stopwatches
Forgejo::UserApi user_get_tokens GET /users/username/tokens List the authenticated user's access tokens
Forgejo::UserApi user_list_activity_feeds GET /users/username/activities/feeds List a user's activity feeds
Forgejo::UserApi user_list_blocked_users GET /user/list_blocked List the authenticated user's blocked users
Forgejo::UserApi user_list_emails GET /user/emails List the authenticated user's email addresses
Forgejo::UserApi user_list_followers GET /users/username/followers List the given user's followers
Forgejo::UserApi user_list_following GET /users/username/following List the users that the given user is following
Forgejo::UserApi user_list_gpg_keys GET /users/username/gpg_keys List the given user's GPG keys
Forgejo::UserApi user_list_hooks GET /user/hooks List the authenticated user's webhooks
Forgejo::UserApi user_list_keys GET /users/username/keys List the given user's public keys
Forgejo::UserApi user_list_quota_artifacts GET /user/quota/artifacts List the artifacts affecting the authenticated user's quota
Forgejo::UserApi user_list_quota_attachments GET /user/quota/attachments List the attachments affecting the authenticated user's quota
Forgejo::UserApi user_list_quota_packages GET /user/quota/packages List the packages affecting the authenticated user's quota
Forgejo::UserApi user_list_repos GET /users/username/repos List the repos owned by the given user
Forgejo::UserApi user_list_starred GET /users/username/starred The repos that the given user has starred
Forgejo::UserApi user_list_subscriptions GET /users/username/subscriptions List the repositories watched by a user
Forgejo::UserApi user_list_teams GET /user/teams List all the teams a user belongs to
Forgejo::UserApi user_search GET /users/search Search for users
Forgejo::UserApi user_unblock_user PUT /user/unblock/username Unblocks a user from the doer.
Forgejo::UserApi user_update_avatar POST /user/avatar Update Avatar
Forgejo::UserApi user_update_o_auth2_application PATCH /user/applications/oauth2/id update an OAuth2 Application, this includes regenerating the client secret
Forgejo::UserApi user_verify_gpg_key POST /user/gpg_key_verify Verify a GPG key

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

AuthorizationHeaderToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header