Module: Forgejo

Defined in:

lib/forgejo/version.rb,
lib/forgejo.rb,
lib/forgejo/api_error.rb,
lib/forgejo/api_client.rb,
lib/forgejo/models/tag.rb,
lib/forgejo/models/cron.rb,
lib/forgejo/models/hook.rb,
lib/forgejo/models/note.rb,
lib/forgejo/models/team.rb,
lib/forgejo/models/user.rb,
lib/forgejo/api/user_api.rb,
lib/forgejo/models/email.rb,
lib/forgejo/models/issue.rb,
lib/forgejo/models/label.rb,
lib/forgejo/api/admin_api.rb,
lib/forgejo/api/issue_api.rb,
lib/forgejo/configuration.rb,
lib/forgejo/models/branch.rb,
lib/forgejo/models/commit.rb,
lib/forgejo/models/secret.rb,
lib/forgejo/models/comment.rb,
lib/forgejo/models/compare.rb,
lib/forgejo/models/gpg_key.rb,
lib/forgejo/models/package.rb,
lib/forgejo/models/release.rb,
lib/forgejo/api/package_api.rb,
lib/forgejo/models/activity.rb,
lib/forgejo/models/git_hook.rb,
lib/forgejo/models/identity.rb,
lib/forgejo/models/reaction.rb,
lib/forgejo/api/settings_api.rb,
lib/forgejo/models/api_error.rb,
lib/forgejo/models/git_entry.rb,
lib/forgejo/models/milestone.rb,
lib/forgejo/models/node_info.rb,
lib/forgejo/models/reference.rb,
lib/forgejo/models/wiki_page.rb,
lib/forgejo/models/attachment.rb,
lib/forgejo/models/deploy_key.rb,
lib/forgejo/models/git_object.rb,
lib/forgejo/models/issue_meta.rb,
lib/forgejo/models/permission.rb,
lib/forgejo/models/public_key.rb,
lib/forgejo/models/quota_info.rb,
lib/forgejo/models/quota_used.rb,
lib/forgejo/models/repository.rb,
lib/forgejo/models/stop_watch.rb,
lib/forgejo/models/topic_name.rb,
lib/forgejo/models/watch_info.rb,
lib/forgejo/api/repository_api.rb,
lib/forgejo/models/action_task.rb,
lib/forgejo/models/commit_meta.rb,
lib/forgejo/models/commit_user.rb,
lib/forgejo/models/pull_review.rb,
lib/forgejo/models/push_mirror.rb,
lib/forgejo/models/quota_group.rb,
lib/forgejo/models/repo_commit.rb,
lib/forgejo/models/wiki_commit.rb,
lib/forgejo/api/activitypub_api.rb,
lib/forgejo/models/access_token.rb,
lib/forgejo/models/activity_pub.rb,
lib/forgejo/models/blocked_user.rb,
lib/forgejo/models/changed_file.rb,
lib/forgejo/models/commit_stats.rb,
lib/forgejo/models/issue_config.rb,
lib/forgejo/models/note_options.rb,
lib/forgejo/models/organization.rb,
lib/forgejo/models/package_file.rb,
lib/forgejo/models/payload_user.rb,
lib/forgejo/models/pull_request.rb,
lib/forgejo/models/tracked_time.rb,
lib/forgejo/api/notification_api.rb,
lib/forgejo/api/organization_api.rb,
lib/forgejo/models/annotated_tag.rb,
lib/forgejo/models/api_not_found.rb,
lib/forgejo/models/commit_status.rb,
lib/forgejo/models/external_wiki.rb,
lib/forgejo/models/file_response.rb,
lib/forgejo/models/gpg_key_email.rb,
lib/forgejo/models/markup_option.rb,
lib/forgejo/models/repo_transfer.rb,
lib/forgejo/models/user_settings.rb,
lib/forgejo/api/miscellaneous_api.rb,
lib/forgejo/models/files_response.rb,
lib/forgejo/models/issue_deadline.rb,
lib/forgejo/models/issue_template.rb,
lib/forgejo/models/label_template.rb,
lib/forgejo/models/payload_commit.rb,
lib/forgejo/models/pr_branch_info.rb,
lib/forgejo/models/search_results.rb,
lib/forgejo/models/server_version.rb,
lib/forgejo/models/tag_protection.rb,
lib/forgejo/models/topic_response.rb,
lib/forgejo/models/action_variable.rb,
lib/forgejo/models/add_time_option.rb,
lib/forgejo/models/combined_status.rb,
lib/forgejo/models/edit_org_option.rb,
lib/forgejo/models/markdown_option.rb,
lib/forgejo/models/node_info_usage.rb,
lib/forgejo/models/quota_rule_info.rb,
lib/forgejo/models/quota_used_size.rb,
lib/forgejo/models/repository_meta.rb,
lib/forgejo/models/edit_hook_option.rb,
lib/forgejo/models/edit_repo_option.rb,
lib/forgejo/models/edit_team_option.rb,
lib/forgejo/models/edit_user_option.rb,
lib/forgejo/models/external_tracker.rb,
lib/forgejo/models/internal_tracker.rb,
lib/forgejo/models/issue_form_field.rb,
lib/forgejo/models/timeline_comment.rb,
lib/forgejo/models/wiki_commit_list.rb,
lib/forgejo/models/branch_protection.rb,
lib/forgejo/models/contents_response.rb,
lib/forgejo/models/create_key_option.rb,
lib/forgejo/models/create_org_option.rb,
lib/forgejo/models/create_tag_option.rb,
lib/forgejo/models/edit_issue_option.rb,
lib/forgejo/models/edit_label_option.rb,
lib/forgejo/models/git_blob_response.rb,
lib/forgejo/models/git_tree_response.rb,
lib/forgejo/models/pull_request_meta.rb,
lib/forgejo/models/user_heatmap_data.rb,
lib/forgejo/models/create_fork_option.rb,
lib/forgejo/models/create_hook_option.rb,
lib/forgejo/models/create_repo_option.rb,
lib/forgejo/models/create_team_option.rb,
lib/forgejo/models/create_user_option.rb,
lib/forgejo/models/node_info_services.rb,
lib/forgejo/models/node_info_software.rb,
lib/forgejo/models/notification_count.rb,
lib/forgejo/models/quota_used_package.rb,
lib/forgejo/models/rename_user_option.rb,
lib/forgejo/models/repo_topic_options.rb,
lib/forgejo/models/api_forbidden_error.rb,
lib/forgejo/models/commit_date_options.rb,
lib/forgejo/models/create_email_option.rb,
lib/forgejo/models/create_file_options.rb,
lib/forgejo/models/create_issue_option.rb,
lib/forgejo/models/create_label_option.rb,
lib/forgejo/models/delete_email_option.rb,
lib/forgejo/models/delete_file_options.rb,
lib/forgejo/models/edit_release_option.rb,
lib/forgejo/models/file_links_response.rb,
lib/forgejo/models/general_ui_settings.rb,
lib/forgejo/models/issue_labels_option.rb,
lib/forgejo/models/notification_thread.rb,
lib/forgejo/models/o_auth2_application.rb,
lib/forgejo/models/pull_review_comment.rb,
lib/forgejo/models/quota_used_artifact.rb,
lib/forgejo/models/quota_used_size_git.rb,
lib/forgejo/models/update_file_options.rb,
lib/forgejo/models/wiki_page_meta_data.rb,
lib/forgejo/models/action_task_response.rb,
lib/forgejo/models/annotated_tag_object.rb,
lib/forgejo/models/api_validation_error.rb,
lib/forgejo/models/change_files_options.rb,
lib/forgejo/models/create_status_option.rb,
lib/forgejo/models/delete_labels_option.rb,
lib/forgejo/models/edit_deadline_option.rb,
lib/forgejo/models/edit_git_hook_option.rb,
lib/forgejo/models/edit_reaction_option.rb,
lib/forgejo/models/file_commit_response.rb,
lib/forgejo/models/file_delete_response.rb,
lib/forgejo/models/general_api_settings.rb,
lib/forgejo/models/generate_repo_option.rb,
lib/forgejo/models/migrate_repo_options.rb,
lib/forgejo/models/notification_subject.rb,
lib/forgejo/models/replace_flags_option.rb,
lib/forgejo/models/transfer_repo_option.rb,
lib/forgejo/models/change_file_operation.rb,
lib/forgejo/models/commit_affected_files.rb,
lib/forgejo/models/create_gpg_key_option.rb,
lib/forgejo/models/create_release_option.rb,
lib/forgejo/models/edit_milestone_option.rb,
lib/forgejo/models/general_repo_settings.rb,
lib/forgejo/models/license_template_info.rb,
lib/forgejo/models/node_info_usage_users.rb,
lib/forgejo/models/quota_used_attachment.rb,
lib/forgejo/models/quota_used_size_repos.rb,
lib/forgejo/models/user_settings_options.rb,
lib/forgejo/models/api_unauthorized_error.rb,
lib/forgejo/models/create_variable_option.rb,
lib/forgejo/models/new_issue_pins_allowed.rb,
lib/forgejo/models/quota_used_size_assets.rb,
lib/forgejo/models/update_variable_option.rb,
lib/forgejo/models/add_collaborator_option.rb,
lib/forgejo/models/api_repo_archived_error.rb,
lib/forgejo/models/create_milestone_option.rb,
lib/forgejo/models/edit_attachment_options.rb,
lib/forgejo/models/edit_quota_rule_options.rb,
lib/forgejo/models/gitignore_template_info.rb,
lib/forgejo/models/issue_config_validation.rb,
lib/forgejo/models/team_search200_response.rb,
lib/forgejo/models/user_search200_response.rb,
lib/forgejo/models/api_invalid_topics_error.rb,
lib/forgejo/models/create_wiki_page_options.rb,
lib/forgejo/models/dispatch_workflow_option.rb,
lib/forgejo/models/edit_pull_request_option.rb,
lib/forgejo/models/organization_permissions.rb,
lib/forgejo/models/create_branch_repo_option.rb,
lib/forgejo/models/create_push_mirror_option.rb,
lib/forgejo/models/create_quota_rule_options.rb,
lib/forgejo/models/edit_issue_comment_option.rb,
lib/forgejo/models/issue_config_contact_link.rb,
lib/forgejo/models/merge_pull_request_option.rb,
lib/forgejo/models/update_branch_repo_option.rb,
lib/forgejo/models/update_repo_avatar_option.rb,
lib/forgejo/models/update_user_avatar_option.rb,
lib/forgejo/models/create_access_token_option.rb,
lib/forgejo/models/create_pull_request_option.rb,
lib/forgejo/models/create_pull_review_comment.rb,
lib/forgejo/models/create_pull_review_options.rb,
lib/forgejo/models/create_quota_group_options.rb,
lib/forgejo/models/edit_tag_protection_option.rb,
lib/forgejo/models/submit_pull_review_options.rb,
lib/forgejo/models/tag_archive_download_count.rb,
lib/forgejo/models/create_issue_comment_option.rb,
lib/forgejo/models/dismiss_pull_review_options.rb,
lib/forgejo/models/general_attachment_settings.rb,
lib/forgejo/models/payload_commit_verification.rb,
lib/forgejo/models/pull_review_request_options.rb,
lib/forgejo/models/create_tag_protection_option.rb,
lib/forgejo/models/licenses_template_list_entry.rb,
lib/forgejo/models/repo_collaborator_permission.rb,
lib/forgejo/models/edit_branch_protection_option.rb,
lib/forgejo/models/set_user_quota_groups_options.rb,
lib/forgejo/models/create_or_update_secret_option.rb,
lib/forgejo/models/create_branch_protection_option.rb,
lib/forgejo/models/quota_used_size_assets_packages.rb,
lib/forgejo/models/create_o_auth2_application_options.rb,
lib/forgejo/models/quota_used_attachment_contained_in.rb,
lib/forgejo/models/quota_used_size_assets_attachments.rb,
lib/forgejo/models/repo_create_release_attachment_request.rb

Overview

#Forgejo API

#This documentation describes the Forgejo API.

The version of the OpenAPI document: 10.0.0-121-28886cd+gitea-1.22.0

Generated by: openapi-generator.tech Generator version: 7.12.0

Defined Under Namespace

Classes: APIError, APIForbiddenError, APIInvalidTopicsError, APINotFound, APIRepoArchivedError, APIUnauthorizedError, APIValidationError, AccessToken, ActionTask, ActionTaskResponse, ActionVariable, Activity, ActivityPub, ActivitypubApi, AddCollaboratorOption, AddTimeOption, AdminApi, AnnotatedTag, AnnotatedTagObject, ApiClient, ApiError, Attachment, BlockedUser, Branch, BranchProtection, ChangeFileOperation, ChangeFilesOptions, ChangedFile, CombinedStatus, Comment, Commit, CommitAffectedFiles, CommitDateOptions, CommitMeta, CommitStats, CommitStatus, CommitUser, Compare, Configuration, ContentsResponse, CreateAccessTokenOption, CreateBranchProtectionOption, CreateBranchRepoOption, CreateEmailOption, CreateFileOptions, CreateForkOption, CreateGPGKeyOption, CreateHookOption, CreateIssueCommentOption, CreateIssueOption, CreateKeyOption, CreateLabelOption, CreateMilestoneOption, CreateOAuth2ApplicationOptions, CreateOrUpdateSecretOption, CreateOrgOption, CreatePullRequestOption, CreatePullReviewComment, CreatePullReviewOptions, CreatePushMirrorOption, CreateQuotaGroupOptions, CreateQuotaRuleOptions, CreateReleaseOption, CreateRepoOption, CreateStatusOption, CreateTagOption, CreateTagProtectionOption, CreateTeamOption, CreateUserOption, CreateVariableOption, CreateWikiPageOptions, Cron, DeleteEmailOption, DeleteFileOptions, DeleteLabelsOption, DeployKey, DismissPullReviewOptions, DispatchWorkflowOption, EditAttachmentOptions, EditBranchProtectionOption, EditDeadlineOption, EditGitHookOption, EditHookOption, EditIssueCommentOption, EditIssueOption, EditLabelOption, EditMilestoneOption, EditOrgOption, EditPullRequestOption, EditQuotaRuleOptions, EditReactionOption, EditReleaseOption, EditRepoOption, EditTagProtectionOption, EditTeamOption, EditUserOption, Email, ExternalTracker, ExternalWiki, FileCommitResponse, FileDeleteResponse, FileLinksResponse, FileResponse, FilesResponse, GPGKey, GPGKeyEmail, GeneralAPISettings, GeneralAttachmentSettings, GeneralRepoSettings, GeneralUISettings, GenerateRepoOption, GitBlobResponse, GitEntry, GitHook, GitObject, GitTreeResponse, GitignoreTemplateInfo, Hook, Identity, InternalTracker, Issue, IssueApi, IssueConfig, IssueConfigContactLink, IssueConfigValidation, IssueDeadline, IssueFormField, IssueLabelsOption, IssueMeta, IssueTemplate, Label, LabelTemplate, LicenseTemplateInfo, LicensesTemplateListEntry, MarkdownOption, MarkupOption, MergePullRequestOption, MigrateRepoOptions, Milestone, MiscellaneousApi, NewIssuePinsAllowed, NodeInfo, NodeInfoServices, NodeInfoSoftware, NodeInfoUsage, NodeInfoUsageUsers, Note, NoteOptions, NotificationApi, NotificationCount, NotificationSubject, NotificationThread, OAuth2Application, Organization, OrganizationApi, OrganizationPermissions, PRBranchInfo, Package, PackageApi, PackageFile, PayloadCommit, PayloadCommitVerification, PayloadUser, Permission, PublicKey, PullRequest, PullRequestMeta, PullReview, PullReviewComment, PullReviewRequestOptions, PushMirror, QuotaGroup, QuotaInfo, QuotaRuleInfo, QuotaUsed, QuotaUsedArtifact, QuotaUsedAttachment, QuotaUsedAttachmentContainedIn, QuotaUsedPackage, QuotaUsedSize, QuotaUsedSizeAssets, QuotaUsedSizeAssetsAttachments, QuotaUsedSizeAssetsPackages, QuotaUsedSizeGit, QuotaUsedSizeRepos, Reaction, Reference, Release, RenameUserOption, ReplaceFlagsOption, RepoCollaboratorPermission, RepoCommit, RepoCreateReleaseAttachmentRequest, RepoTopicOptions, RepoTransfer, Repository, RepositoryApi, RepositoryMeta, SearchResults, Secret, ServerVersion, SetUserQuotaGroupsOptions, SettingsApi, StopWatch, SubmitPullReviewOptions, Tag, TagArchiveDownloadCount, TagProtection, Team, TeamSearch200Response, TimelineComment, TopicName, TopicResponse, TrackedTime, TransferRepoOption, UpdateBranchRepoOption, UpdateFileOptions, UpdateRepoAvatarOption, UpdateUserAvatarOption, UpdateVariableOption, User, UserApi, UserHeatmapData, UserSearch200Response, UserSettings, UserSettingsOptions, WatchInfo, WikiCommit, WikiCommitList, WikiPage, WikiPageMetaData

Constant Summary

VERSION =

'0.2.1'

Class Method Summary

• .configure ⇒ Object

  Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Forgejo.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/forgejo.rb', line 259

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end