forgejo 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +9 -0
- data/LICENSE~ +9 -0
- data/Makefile +23 -0
- data/Makefile~ +2 -0
- data/README.md +717 -0
- data/Rakefile +10 -0
- data/docs/APIError.md +20 -0
- data/docs/AccessToken.md +26 -0
- data/docs/ActionTask.md +42 -0
- data/docs/ActionTaskResponse.md +20 -0
- data/docs/ActionVariable.md +24 -0
- data/docs/Activity.md +42 -0
- data/docs/ActivityPub.md +18 -0
- data/docs/ActivitypubApi.md +289 -0
- data/docs/AddCollaboratorOption.md +18 -0
- data/docs/AddTimeOption.md +22 -0
- data/docs/AdminApi.md +1672 -0
- data/docs/AnnotatedTag.md +32 -0
- data/docs/AnnotatedTagObject.md +22 -0
- data/docs/Attachment.md +30 -0
- data/docs/BlockedUser.md +20 -0
- data/docs/Branch.md +34 -0
- data/docs/BranchProtection.md +70 -0
- data/docs/ChangeFileOperation.md +26 -0
- data/docs/ChangeFilesOptions.md +32 -0
- data/docs/ChangedFile.md +34 -0
- data/docs/CombinedStatus.md +30 -0
- data/docs/Comment.md +38 -0
- data/docs/Commit.md +36 -0
- data/docs/CommitAffectedFiles.md +20 -0
- data/docs/CommitDateOptions.md +20 -0
- data/docs/CommitMeta.md +22 -0
- data/docs/CommitStats.md +22 -0
- data/docs/CommitStatus.md +34 -0
- data/docs/CommitUser.md +22 -0
- data/docs/Compare.md +20 -0
- data/docs/ContentsResponse.md +46 -0
- data/docs/CreateAccessTokenOption.md +20 -0
- data/docs/CreateBranchProtectionOption.md +66 -0
- data/docs/CreateBranchRepoOption.md +22 -0
- data/docs/CreateEmailOption.md +18 -0
- data/docs/CreateFileOptions.md +32 -0
- data/docs/CreateForkOption.md +20 -0
- data/docs/CreateGPGKeyOption.md +20 -0
- data/docs/CreateHookOption.md +28 -0
- data/docs/CreateIssueCommentOption.md +20 -0
- data/docs/CreateIssueOption.md +34 -0
- data/docs/CreateKeyOption.md +22 -0
- data/docs/CreateLabelOption.md +26 -0
- data/docs/CreateMilestoneOption.md +24 -0
- data/docs/CreateOAuth2ApplicationOptions.md +22 -0
- data/docs/CreateOrUpdateSecretOption.md +18 -0
- data/docs/CreateOrgOption.md +32 -0
- data/docs/CreatePullRequestOption.md +34 -0
- data/docs/CreatePullReviewComment.md +24 -0
- data/docs/CreatePullReviewOptions.md +24 -0
- data/docs/CreatePushMirrorOption.md +26 -0
- data/docs/CreateReleaseOption.md +30 -0
- data/docs/CreateRepoOption.md +40 -0
- data/docs/CreateStatusOption.md +24 -0
- data/docs/CreateTagOption.md +22 -0
- data/docs/CreateTagProtectionOption.md +22 -0
- data/docs/CreateTeamOption.md +30 -0
- data/docs/CreateUserOption.md +38 -0
- data/docs/CreateVariableOption.md +18 -0
- data/docs/CreateWikiPageOptions.md +22 -0
- data/docs/Cron.md +26 -0
- data/docs/DeleteEmailOption.md +18 -0
- data/docs/DeleteFileOptions.md +32 -0
- data/docs/DeleteLabelsOption.md +18 -0
- data/docs/DeployKey.md +34 -0
- data/docs/DismissPullReviewOptions.md +20 -0
- data/docs/DispatchWorkflowOption.md +20 -0
- data/docs/EditAttachmentOptions.md +18 -0
- data/docs/EditBranchProtectionOption.md +62 -0
- data/docs/EditDeadlineOption.md +18 -0
- data/docs/EditGitHookOption.md +18 -0
- data/docs/EditHookOption.md +26 -0
- data/docs/EditIssueCommentOption.md +20 -0
- data/docs/EditIssueOption.md +36 -0
- data/docs/EditLabelOption.md +26 -0
- data/docs/EditMilestoneOption.md +24 -0
- data/docs/EditOrgOption.md +30 -0
- data/docs/EditPullRequestOption.md +38 -0
- data/docs/EditReactionOption.md +18 -0
- data/docs/EditReleaseOption.md +30 -0
- data/docs/EditRepoOption.md +82 -0
- data/docs/EditTagProtectionOption.md +22 -0
- data/docs/EditTeamOption.md +30 -0
- data/docs/EditUserOption.md +54 -0
- data/docs/Email.md +26 -0
- data/docs/ExternalTracker.md +24 -0
- data/docs/ExternalWiki.md +18 -0
- data/docs/FileCommitResponse.md +34 -0
- data/docs/FileDeleteResponse.md +22 -0
- data/docs/FileLinksResponse.md +22 -0
- data/docs/FileResponse.md +22 -0
- data/docs/FilesResponse.md +22 -0
- data/docs/GPGKey.md +42 -0
- data/docs/GPGKeyEmail.md +20 -0
- data/docs/GeneralAPISettings.md +24 -0
- data/docs/GeneralAttachmentSettings.md +24 -0
- data/docs/GeneralRepoSettings.md +30 -0
- data/docs/GeneralUISettings.md +22 -0
- data/docs/GenerateRepoOption.md +40 -0
- data/docs/GitBlobResponse.md +26 -0
- data/docs/GitEntry.md +28 -0
- data/docs/GitHook.md +22 -0
- data/docs/GitObject.md +22 -0
- data/docs/GitTreeResponse.md +28 -0
- data/docs/GitignoreTemplateInfo.md +20 -0
- data/docs/Hook.md +40 -0
- data/docs/Identity.md +20 -0
- data/docs/InternalTracker.md +22 -0
- data/docs/Issue.md +66 -0
- data/docs/IssueApi.md +5206 -0
- data/docs/IssueConfig.md +20 -0
- data/docs/IssueConfigContactLink.md +22 -0
- data/docs/IssueConfigValidation.md +20 -0
- data/docs/IssueDeadline.md +18 -0
- data/docs/IssueFormField.md +26 -0
- data/docs/IssueLabelsOption.md +20 -0
- data/docs/IssueMeta.md +22 -0
- data/docs/IssueTemplate.md +32 -0
- data/docs/Label.md +30 -0
- data/docs/LabelTemplate.md +24 -0
- data/docs/LicenseTemplateInfo.md +26 -0
- data/docs/LicensesTemplateListEntry.md +22 -0
- data/docs/MarkdownOption.md +24 -0
- data/docs/MarkupOption.md +26 -0
- data/docs/MergePullRequestOption.md +32 -0
- data/docs/MigrateRepoOptions.md +56 -0
- data/docs/Milestone.md +36 -0
- data/docs/MiscellaneousApi.md +833 -0
- data/docs/NewIssuePinsAllowed.md +20 -0
- data/docs/NodeInfo.md +30 -0
- data/docs/NodeInfoServices.md +20 -0
- data/docs/NodeInfoSoftware.md +24 -0
- data/docs/NodeInfoUsage.md +22 -0
- data/docs/NodeInfoUsageUsers.md +22 -0
- data/docs/Note.md +20 -0
- data/docs/NotificationApi.md +550 -0
- data/docs/NotificationCount.md +18 -0
- data/docs/NotificationSubject.md +30 -0
- data/docs/NotificationThread.md +30 -0
- data/docs/OAuth2Application.md +30 -0
- data/docs/Organization.md +38 -0
- data/docs/OrganizationApi.md +4259 -0
- data/docs/OrganizationPermissions.md +26 -0
- data/docs/PRBranchInfo.md +26 -0
- data/docs/Package.md +34 -0
- data/docs/PackageApi.md +314 -0
- data/docs/PackageFile.md +30 -0
- data/docs/PayloadCommit.md +36 -0
- data/docs/PayloadCommitVerification.md +26 -0
- data/docs/PayloadUser.md +22 -0
- data/docs/Permission.md +22 -0
- data/docs/PublicKey.md +34 -0
- data/docs/PullRequest.md +88 -0
- data/docs/PullRequestMeta.md +24 -0
- data/docs/PullReview.md +44 -0
- data/docs/PullReviewComment.md +46 -0
- data/docs/PullReviewRequestOptions.md +20 -0
- data/docs/PushMirror.md +32 -0
- data/docs/Reaction.md +22 -0
- data/docs/Reference.md +22 -0
- data/docs/Release.md +52 -0
- data/docs/RenameUserOption.md +18 -0
- data/docs/ReplaceFlagsOption.md +18 -0
- data/docs/RepoCollaboratorPermission.md +22 -0
- data/docs/RepoCommit.md +28 -0
- data/docs/RepoCreateReleaseAttachmentRequest.md +18 -0
- data/docs/RepoTopicOptions.md +18 -0
- data/docs/RepoTransfer.md +22 -0
- data/docs/Repository.md +140 -0
- data/docs/RepositoryApi.md +13022 -0
- data/docs/RepositoryMeta.md +24 -0
- data/docs/SearchResults.md +20 -0
- data/docs/Secret.md +20 -0
- data/docs/ServerVersion.md +18 -0
- data/docs/SettingsApi.md +275 -0
- data/docs/StopWatch.md +30 -0
- data/docs/SubmitPullReviewOptions.md +20 -0
- data/docs/Tag.md +30 -0
- data/docs/TagArchiveDownloadCount.md +20 -0
- data/docs/TagProtection.md +28 -0
- data/docs/Team.md +34 -0
- data/docs/TeamSearch200Response.md +20 -0
- data/docs/TimelineComment.md +74 -0
- data/docs/TopicName.md +18 -0
- data/docs/TopicResponse.md +26 -0
- data/docs/TrackedTime.md +30 -0
- data/docs/TransferRepoOption.md +20 -0
- data/docs/UpdateFileOptions.md +36 -0
- data/docs/UpdateRepoAvatarOption.md +18 -0
- data/docs/UpdateUserAvatarOption.md +18 -0
- data/docs/UpdateVariableOption.md +20 -0
- data/docs/User.md +62 -0
- data/docs/UserApi.md +4969 -0
- data/docs/UserHeatmapData.md +20 -0
- data/docs/UserSearch200Response.md +20 -0
- data/docs/UserSettings.md +38 -0
- data/docs/UserSettingsOptions.md +38 -0
- data/docs/WatchInfo.md +28 -0
- data/docs/WikiCommit.md +24 -0
- data/docs/WikiCommitList.md +20 -0
- data/docs/WikiPage.md +32 -0
- data/docs/WikiPageMetaData.md +24 -0
- data/forgejo.gemspec +49 -0
- data/git_push.sh +57 -0
- data/lib/forgejo/api/activitypub_api.rb +269 -0
- data/lib/forgejo/api/admin_api.rb +1496 -0
- data/lib/forgejo/api/issue_api.rb +5282 -0
- data/lib/forgejo/api/miscellaneous_api.rb +725 -0
- data/lib/forgejo/api/notification_api.rb +520 -0
- data/lib/forgejo/api/organization_api.rb +3898 -0
- data/lib/forgejo/api/package_api.rb +334 -0
- data/lib/forgejo/api/repository_api.rb +12849 -0
- data/lib/forgejo/api/settings_api.rb +242 -0
- data/lib/forgejo/api/user_api.rb +4314 -0
- data/lib/forgejo/api_client.rb +437 -0
- data/lib/forgejo/api_error.rb +58 -0
- data/lib/forgejo/configuration.rb +392 -0
- data/lib/forgejo/models/access_token.rb +252 -0
- data/lib/forgejo/models/action_task.rb +323 -0
- data/lib/forgejo/models/action_task_response.rb +226 -0
- data/lib/forgejo/models/action_variable.rb +246 -0
- data/lib/forgejo/models/activity.rb +357 -0
- data/lib/forgejo/models/activity_pub.rb +215 -0
- data/lib/forgejo/models/add_collaborator_option.rb +215 -0
- data/lib/forgejo/models/add_time_option.rb +242 -0
- data/lib/forgejo/models/annotated_tag.rb +278 -0
- data/lib/forgejo/models/annotated_tag_object.rb +233 -0
- data/lib/forgejo/models/api_error.rb +224 -0
- data/lib/forgejo/models/attachment.rb +269 -0
- data/lib/forgejo/models/blocked_user.rb +223 -0
- data/lib/forgejo/models/branch.rb +289 -0
- data/lib/forgejo/models/branch_protection.rb +464 -0
- data/lib/forgejo/models/change_file_operation.rb +304 -0
- data/lib/forgejo/models/change_files_options.rb +292 -0
- data/lib/forgejo/models/changed_file.rb +287 -0
- data/lib/forgejo/models/combined_status.rb +272 -0
- data/lib/forgejo/models/comment.rb +307 -0
- data/lib/forgejo/models/commit.rb +299 -0
- data/lib/forgejo/models/commit_affected_files.rb +224 -0
- data/lib/forgejo/models/commit_date_options.rb +224 -0
- data/lib/forgejo/models/commit_meta.rb +232 -0
- data/lib/forgejo/models/commit_stats.rb +233 -0
- data/lib/forgejo/models/commit_status.rb +288 -0
- data/lib/forgejo/models/commit_user.rb +232 -0
- data/lib/forgejo/models/compare.rb +225 -0
- data/lib/forgejo/models/contents_response.rb +346 -0
- data/lib/forgejo/models/create_access_token_option.rb +233 -0
- data/lib/forgejo/models/create_branch_protection_option.rb +446 -0
- data/lib/forgejo/models/create_branch_repo_option.rb +243 -0
- data/lib/forgejo/models/create_email_option.rb +218 -0
- data/lib/forgejo/models/create_file_options.rb +290 -0
- data/lib/forgejo/models/create_fork_option.rb +226 -0
- data/lib/forgejo/models/create_gpg_key_option.rb +232 -0
- data/lib/forgejo/models/create_hook_option.rb +315 -0
- data/lib/forgejo/models/create_issue_comment_option.rb +231 -0
- data/lib/forgejo/models/create_issue_option.rb +301 -0
- data/lib/forgejo/models/create_key_option.rb +250 -0
- data/lib/forgejo/models/create_label_option.rb +265 -0
- data/lib/forgejo/models/create_milestone_option.rb +276 -0
- data/lib/forgejo/models/create_o_auth2_application_options.rb +235 -0
- data/lib/forgejo/models/create_or_update_secret_option.rb +223 -0
- data/lib/forgejo/models/create_org_option.rb +320 -0
- data/lib/forgejo/models/create_pull_request_option.rb +291 -0
- data/lib/forgejo/models/create_pull_review_comment.rb +245 -0
- data/lib/forgejo/models/create_pull_review_options.rb +245 -0
- data/lib/forgejo/models/create_push_mirror_option.rb +250 -0
- data/lib/forgejo/models/create_release_option.rb +276 -0
- data/lib/forgejo/models/create_repo_option.rb +379 -0
- data/lib/forgejo/models/create_status_option.rb +243 -0
- data/lib/forgejo/models/create_tag_option.rb +240 -0
- data/lib/forgejo/models/create_tag_protection_option.rb +237 -0
- data/lib/forgejo/models/create_team_option.rb +314 -0
- data/lib/forgejo/models/create_user_option.rb +320 -0
- data/lib/forgejo/models/create_variable_option.rb +223 -0
- data/lib/forgejo/models/create_wiki_page_options.rb +236 -0
- data/lib/forgejo/models/cron.rb +251 -0
- data/lib/forgejo/models/delete_email_option.rb +218 -0
- data/lib/forgejo/models/delete_file_options.rb +290 -0
- data/lib/forgejo/models/delete_labels_option.rb +215 -0
- data/lib/forgejo/models/deploy_key.rb +287 -0
- data/lib/forgejo/models/dismiss_pull_review_options.rb +224 -0
- data/lib/forgejo/models/dispatch_workflow_option.rb +235 -0
- data/lib/forgejo/models/edit_attachment_options.rb +215 -0
- data/lib/forgejo/models/edit_branch_protection_option.rb +427 -0
- data/lib/forgejo/models/edit_deadline_option.rb +222 -0
- data/lib/forgejo/models/edit_git_hook_option.rb +215 -0
- data/lib/forgejo/models/edit_hook_option.rb +255 -0
- data/lib/forgejo/models/edit_issue_comment_option.rb +231 -0
- data/lib/forgejo/models/edit_issue_option.rb +299 -0
- data/lib/forgejo/models/edit_label_option.rb +251 -0
- data/lib/forgejo/models/edit_milestone_option.rb +242 -0
- data/lib/forgejo/models/edit_org_option.rb +304 -0
- data/lib/forgejo/models/edit_pull_request_option.rb +309 -0
- data/lib/forgejo/models/edit_reaction_option.rb +215 -0
- data/lib/forgejo/models/edit_release_option.rb +269 -0
- data/lib/forgejo/models/edit_repo_option.rb +533 -0
- data/lib/forgejo/models/edit_tag_protection_option.rb +237 -0
- data/lib/forgejo/models/edit_team_option.rb +314 -0
- data/lib/forgejo/models/edit_user_option.rb +377 -0
- data/lib/forgejo/models/email.rb +251 -0
- data/lib/forgejo/models/external_tracker.rb +246 -0
- data/lib/forgejo/models/external_wiki.rb +216 -0
- data/lib/forgejo/models/file_commit_response.rb +288 -0
- data/lib/forgejo/models/file_delete_response.rb +233 -0
- data/lib/forgejo/models/file_links_response.rb +233 -0
- data/lib/forgejo/models/file_response.rb +233 -0
- data/lib/forgejo/models/files_response.rb +235 -0
- data/lib/forgejo/models/general_api_settings.rb +242 -0
- data/lib/forgejo/models/general_attachment_settings.rb +242 -0
- data/lib/forgejo/models/general_repo_settings.rb +269 -0
- data/lib/forgejo/models/general_ui_settings.rb +237 -0
- data/lib/forgejo/models/generate_repo_option.rb +340 -0
- data/lib/forgejo/models/git_blob_response.rb +251 -0
- data/lib/forgejo/models/git_entry.rb +260 -0
- data/lib/forgejo/models/git_hook.rb +233 -0
- data/lib/forgejo/models/git_object.rb +232 -0
- data/lib/forgejo/models/git_tree_response.rb +262 -0
- data/lib/forgejo/models/gitignore_template_info.rb +224 -0
- data/lib/forgejo/models/gpg_key.rb +327 -0
- data/lib/forgejo/models/gpg_key_email.rb +224 -0
- data/lib/forgejo/models/hook.rb +319 -0
- data/lib/forgejo/models/identity.rb +224 -0
- data/lib/forgejo/models/internal_tracker.rb +236 -0
- data/lib/forgejo/models/issue.rb +438 -0
- data/lib/forgejo/models/issue_config.rb +225 -0
- data/lib/forgejo/models/issue_config_contact_link.rb +232 -0
- data/lib/forgejo/models/issue_config_validation.rb +223 -0
- data/lib/forgejo/models/issue_deadline.rb +215 -0
- data/lib/forgejo/models/issue_form_field.rb +257 -0
- data/lib/forgejo/models/issue_labels_option.rb +227 -0
- data/lib/forgejo/models/issue_meta.rb +233 -0
- data/lib/forgejo/models/issue_template.rb +282 -0
- data/lib/forgejo/models/label.rb +269 -0
- data/lib/forgejo/models/label_template.rb +242 -0
- data/lib/forgejo/models/license_template_info.rb +251 -0
- data/lib/forgejo/models/licenses_template_list_entry.rb +233 -0
- data/lib/forgejo/models/markdown_option.rb +246 -0
- data/lib/forgejo/models/markup_option.rb +256 -0
- data/lib/forgejo/models/merge_pull_request_option.rb +319 -0
- data/lib/forgejo/models/migrate_repo_options.rb +436 -0
- data/lib/forgejo/models/milestone.rb +297 -0
- data/lib/forgejo/models/new_issue_pins_allowed.rb +224 -0
- data/lib/forgejo/models/node_info.rb +271 -0
- data/lib/forgejo/models/node_info_services.rb +228 -0
- data/lib/forgejo/models/node_info_software.rb +242 -0
- data/lib/forgejo/models/node_info_usage.rb +233 -0
- data/lib/forgejo/models/node_info_usage_users.rb +233 -0
- data/lib/forgejo/models/note.rb +224 -0
- data/lib/forgejo/models/notification_count.rb +215 -0
- data/lib/forgejo/models/notification_subject.rb +271 -0
- data/lib/forgejo/models/notification_thread.rb +269 -0
- data/lib/forgejo/models/o_auth2_application.rb +270 -0
- data/lib/forgejo/models/organization.rb +306 -0
- data/lib/forgejo/models/organization_permissions.rb +251 -0
- data/lib/forgejo/models/package.rb +287 -0
- data/lib/forgejo/models/package_file.rb +269 -0
- data/lib/forgejo/models/payload_commit.rb +303 -0
- data/lib/forgejo/models/payload_commit_verification.rb +251 -0
- data/lib/forgejo/models/payload_user.rb +234 -0
- data/lib/forgejo/models/permission.rb +233 -0
- data/lib/forgejo/models/pr_branch_info.rb +251 -0
- data/lib/forgejo/models/public_key.rb +287 -0
- data/lib/forgejo/models/pull_request.rb +538 -0
- data/lib/forgejo/models/pull_request_meta.rb +242 -0
- data/lib/forgejo/models/pull_review.rb +333 -0
- data/lib/forgejo/models/pull_review_comment.rb +341 -0
- data/lib/forgejo/models/pull_review_request_options.rb +228 -0
- data/lib/forgejo/models/push_mirror.rb +278 -0
- data/lib/forgejo/models/reaction.rb +233 -0
- data/lib/forgejo/models/reference.rb +232 -0
- data/lib/forgejo/models/release.rb +370 -0
- data/lib/forgejo/models/rename_user_option.rb +223 -0
- data/lib/forgejo/models/replace_flags_option.rb +217 -0
- data/lib/forgejo/models/repo_collaborator_permission.rb +233 -0
- data/lib/forgejo/models/repo_commit.rb +259 -0
- data/lib/forgejo/models/repo_create_release_attachment_request.rb +215 -0
- data/lib/forgejo/models/repo_topic_options.rb +218 -0
- data/lib/forgejo/models/repo_transfer.rb +235 -0
- data/lib/forgejo/models/repository.rb +801 -0
- data/lib/forgejo/models/repository_meta.rb +242 -0
- data/lib/forgejo/models/search_results.rb +226 -0
- data/lib/forgejo/models/secret.rb +225 -0
- data/lib/forgejo/models/server_version.rb +215 -0
- data/lib/forgejo/models/stop_watch.rb +269 -0
- data/lib/forgejo/models/submit_pull_review_options.rb +225 -0
- data/lib/forgejo/models/tag.rb +269 -0
- data/lib/forgejo/models/tag_archive_download_count.rb +224 -0
- data/lib/forgejo/models/tag_protection.rb +264 -0
- data/lib/forgejo/models/team.rb +325 -0
- data/lib/forgejo/models/team_search200_response.rb +225 -0
- data/lib/forgejo/models/timeline_comment.rb +469 -0
- data/lib/forgejo/models/topic_name.rb +217 -0
- data/lib/forgejo/models/topic_response.rb +251 -0
- data/lib/forgejo/models/tracked_time.rb +272 -0
- data/lib/forgejo/models/transfer_repo_option.rb +234 -0
- data/lib/forgejo/models/update_file_options.rb +317 -0
- data/lib/forgejo/models/update_repo_avatar_option.rb +216 -0
- data/lib/forgejo/models/update_user_avatar_option.rb +216 -0
- data/lib/forgejo/models/update_variable_option.rb +233 -0
- data/lib/forgejo/models/user.rb +433 -0
- data/lib/forgejo/models/user_heatmap_data.rb +225 -0
- data/lib/forgejo/models/user_search200_response.rb +225 -0
- data/lib/forgejo/models/user_settings.rb +306 -0
- data/lib/forgejo/models/user_settings_options.rb +306 -0
- data/lib/forgejo/models/watch_info.rb +260 -0
- data/lib/forgejo/models/wiki_commit.rb +242 -0
- data/lib/forgejo/models/wiki_commit_list.rb +226 -0
- data/lib/forgejo/models/wiki_page.rb +279 -0
- data/lib/forgejo/models/wiki_page_meta_data.rb +242 -0
- data/lib/forgejo/version.rb +15 -0
- data/lib/forgejo.rb +241 -0
- data/manifest.scm +2 -0
- data/patch +7 -0
- data/patch~ +1 -0
- data/smoke +16 -0
- data/smoke~ +1 -0
- data/spec/api/activitypub_api_spec.rb +80 -0
- data/spec/api/admin_api_spec.rb +308 -0
- data/spec/api/issue_api_spec.rb +998 -0
- data/spec/api/miscellaneous_api_spec.rb +161 -0
- data/spec/api/notification_api_spec.rb +134 -0
- data/spec/api/organization_api_spec.rb +752 -0
- data/spec/api/package_api_spec.rb +92 -0
- data/spec/api/repository_api_spec.rb +2366 -0
- data/spec/api/settings_api_spec.rb +75 -0
- data/spec/api/user_api_spec.rb +839 -0
- data/spec/models/access_token_spec.rb +60 -0
- data/spec/models/action_task_response_spec.rb +42 -0
- data/spec/models/action_task_spec.rb +108 -0
- data/spec/models/action_variable_spec.rb +54 -0
- data/spec/models/activity_pub_spec.rb +36 -0
- data/spec/models/activity_spec.rb +112 -0
- data/spec/models/add_collaborator_option_spec.rb +36 -0
- data/spec/models/add_time_option_spec.rb +48 -0
- data/spec/models/annotated_tag_object_spec.rb +48 -0
- data/spec/models/annotated_tag_spec.rb +78 -0
- data/spec/models/api_error_spec.rb +42 -0
- data/spec/models/attachment_spec.rb +72 -0
- data/spec/models/blocked_user_spec.rb +42 -0
- data/spec/models/branch_protection_spec.rb +192 -0
- data/spec/models/branch_spec.rb +84 -0
- data/spec/models/change_file_operation_spec.rb +64 -0
- data/spec/models/change_files_options_spec.rb +78 -0
- data/spec/models/changed_file_spec.rb +84 -0
- data/spec/models/combined_status_spec.rb +72 -0
- data/spec/models/comment_spec.rb +96 -0
- data/spec/models/commit_affected_files_spec.rb +42 -0
- data/spec/models/commit_date_options_spec.rb +42 -0
- data/spec/models/commit_meta_spec.rb +48 -0
- data/spec/models/commit_spec.rb +90 -0
- data/spec/models/commit_stats_spec.rb +48 -0
- data/spec/models/commit_status_spec.rb +84 -0
- data/spec/models/commit_user_spec.rb +48 -0
- data/spec/models/compare_spec.rb +42 -0
- data/spec/models/contents_response_spec.rb +120 -0
- data/spec/models/create_access_token_option_spec.rb +42 -0
- data/spec/models/create_branch_protection_option_spec.rb +180 -0
- data/spec/models/create_branch_repo_option_spec.rb +48 -0
- data/spec/models/create_email_option_spec.rb +36 -0
- data/spec/models/create_file_options_spec.rb +78 -0
- data/spec/models/create_fork_option_spec.rb +42 -0
- data/spec/models/create_gpg_key_option_spec.rb +42 -0
- data/spec/models/create_hook_option_spec.rb +70 -0
- data/spec/models/create_issue_comment_option_spec.rb +42 -0
- data/spec/models/create_issue_option_spec.rb +84 -0
- data/spec/models/create_key_option_spec.rb +48 -0
- data/spec/models/create_label_option_spec.rb +60 -0
- data/spec/models/create_milestone_option_spec.rb +58 -0
- data/spec/models/create_o_auth2_application_options_spec.rb +48 -0
- data/spec/models/create_or_update_secret_option_spec.rb +36 -0
- data/spec/models/create_org_option_spec.rb +82 -0
- data/spec/models/create_pull_request_option_spec.rb +84 -0
- data/spec/models/create_pull_review_comment_spec.rb +54 -0
- data/spec/models/create_pull_review_options_spec.rb +54 -0
- data/spec/models/create_push_mirror_option_spec.rb +60 -0
- data/spec/models/create_release_option_spec.rb +72 -0
- data/spec/models/create_repo_option_spec.rb +110 -0
- data/spec/models/create_status_option_spec.rb +54 -0
- data/spec/models/create_tag_option_spec.rb +48 -0
- data/spec/models/create_tag_protection_option_spec.rb +48 -0
- data/spec/models/create_team_option_spec.rb +76 -0
- data/spec/models/create_user_option_spec.rb +96 -0
- data/spec/models/create_variable_option_spec.rb +36 -0
- data/spec/models/create_wiki_page_options_spec.rb +48 -0
- data/spec/models/cron_spec.rb +60 -0
- data/spec/models/delete_email_option_spec.rb +36 -0
- data/spec/models/delete_file_options_spec.rb +78 -0
- data/spec/models/delete_labels_option_spec.rb +36 -0
- data/spec/models/deploy_key_spec.rb +84 -0
- data/spec/models/dismiss_pull_review_options_spec.rb +42 -0
- data/spec/models/dispatch_workflow_option_spec.rb +42 -0
- data/spec/models/edit_attachment_options_spec.rb +36 -0
- data/spec/models/edit_branch_protection_option_spec.rb +168 -0
- data/spec/models/edit_deadline_option_spec.rb +36 -0
- data/spec/models/edit_git_hook_option_spec.rb +36 -0
- data/spec/models/edit_hook_option_spec.rb +60 -0
- data/spec/models/edit_issue_comment_option_spec.rb +42 -0
- data/spec/models/edit_issue_option_spec.rb +90 -0
- data/spec/models/edit_label_option_spec.rb +60 -0
- data/spec/models/edit_milestone_option_spec.rb +54 -0
- data/spec/models/edit_org_option_spec.rb +76 -0
- data/spec/models/edit_pull_request_option_spec.rb +96 -0
- data/spec/models/edit_reaction_option_spec.rb +36 -0
- data/spec/models/edit_release_option_spec.rb +72 -0
- data/spec/models/edit_repo_option_spec.rb +228 -0
- data/spec/models/edit_tag_protection_option_spec.rb +48 -0
- data/spec/models/edit_team_option_spec.rb +76 -0
- data/spec/models/edit_user_option_spec.rb +144 -0
- data/spec/models/email_spec.rb +60 -0
- data/spec/models/external_tracker_spec.rb +54 -0
- data/spec/models/external_wiki_spec.rb +36 -0
- data/spec/models/file_commit_response_spec.rb +84 -0
- data/spec/models/file_delete_response_spec.rb +48 -0
- data/spec/models/file_links_response_spec.rb +48 -0
- data/spec/models/file_response_spec.rb +48 -0
- data/spec/models/files_response_spec.rb +48 -0
- data/spec/models/general_api_settings_spec.rb +54 -0
- data/spec/models/general_attachment_settings_spec.rb +54 -0
- data/spec/models/general_repo_settings_spec.rb +72 -0
- data/spec/models/general_ui_settings_spec.rb +48 -0
- data/spec/models/generate_repo_option_spec.rb +102 -0
- data/spec/models/git_blob_response_spec.rb +60 -0
- data/spec/models/git_entry_spec.rb +66 -0
- data/spec/models/git_hook_spec.rb +48 -0
- data/spec/models/git_object_spec.rb +48 -0
- data/spec/models/git_tree_response_spec.rb +66 -0
- data/spec/models/gitignore_template_info_spec.rb +42 -0
- data/spec/models/gpg_key_email_spec.rb +42 -0
- data/spec/models/gpg_key_spec.rb +108 -0
- data/spec/models/hook_spec.rb +102 -0
- data/spec/models/identity_spec.rb +42 -0
- data/spec/models/internal_tracker_spec.rb +48 -0
- data/spec/models/issue_config_contact_link_spec.rb +48 -0
- data/spec/models/issue_config_spec.rb +42 -0
- data/spec/models/issue_config_validation_spec.rb +42 -0
- data/spec/models/issue_deadline_spec.rb +36 -0
- data/spec/models/issue_form_field_spec.rb +60 -0
- data/spec/models/issue_labels_option_spec.rb +42 -0
- data/spec/models/issue_meta_spec.rb +48 -0
- data/spec/models/issue_spec.rb +180 -0
- data/spec/models/issue_template_spec.rb +78 -0
- data/spec/models/label_spec.rb +72 -0
- data/spec/models/label_template_spec.rb +54 -0
- data/spec/models/license_template_info_spec.rb +60 -0
- data/spec/models/licenses_template_list_entry_spec.rb +48 -0
- data/spec/models/markdown_option_spec.rb +54 -0
- data/spec/models/markup_option_spec.rb +60 -0
- data/spec/models/merge_pull_request_option_spec.rb +82 -0
- data/spec/models/migrate_repo_options_spec.rb +154 -0
- data/spec/models/milestone_spec.rb +90 -0
- data/spec/models/new_issue_pins_allowed_spec.rb +42 -0
- data/spec/models/node_info_services_spec.rb +42 -0
- data/spec/models/node_info_software_spec.rb +54 -0
- data/spec/models/node_info_spec.rb +72 -0
- data/spec/models/node_info_usage_spec.rb +48 -0
- data/spec/models/node_info_usage_users_spec.rb +48 -0
- data/spec/models/note_spec.rb +42 -0
- data/spec/models/notification_count_spec.rb +36 -0
- data/spec/models/notification_subject_spec.rb +72 -0
- data/spec/models/notification_thread_spec.rb +72 -0
- data/spec/models/o_auth2_application_spec.rb +72 -0
- data/spec/models/organization_permissions_spec.rb +60 -0
- data/spec/models/organization_spec.rb +96 -0
- data/spec/models/package_file_spec.rb +72 -0
- data/spec/models/package_spec.rb +84 -0
- data/spec/models/payload_commit_spec.rb +90 -0
- data/spec/models/payload_commit_verification_spec.rb +60 -0
- data/spec/models/payload_user_spec.rb +48 -0
- data/spec/models/permission_spec.rb +48 -0
- data/spec/models/pr_branch_info_spec.rb +60 -0
- data/spec/models/public_key_spec.rb +84 -0
- data/spec/models/pull_request_meta_spec.rb +54 -0
- data/spec/models/pull_request_spec.rb +246 -0
- data/spec/models/pull_review_comment_spec.rb +120 -0
- data/spec/models/pull_review_request_options_spec.rb +42 -0
- data/spec/models/pull_review_spec.rb +114 -0
- data/spec/models/push_mirror_spec.rb +78 -0
- data/spec/models/reaction_spec.rb +48 -0
- data/spec/models/reference_spec.rb +48 -0
- data/spec/models/release_spec.rb +138 -0
- data/spec/models/rename_user_option_spec.rb +36 -0
- data/spec/models/replace_flags_option_spec.rb +36 -0
- data/spec/models/repo_collaborator_permission_spec.rb +48 -0
- data/spec/models/repo_commit_spec.rb +66 -0
- data/spec/models/repo_create_release_attachment_request_spec.rb +36 -0
- data/spec/models/repo_topic_options_spec.rb +36 -0
- data/spec/models/repo_transfer_spec.rb +48 -0
- data/spec/models/repository_meta_spec.rb +54 -0
- data/spec/models/repository_spec.rb +406 -0
- data/spec/models/search_results_spec.rb +42 -0
- data/spec/models/secret_spec.rb +42 -0
- data/spec/models/server_version_spec.rb +36 -0
- data/spec/models/stop_watch_spec.rb +72 -0
- data/spec/models/submit_pull_review_options_spec.rb +42 -0
- data/spec/models/tag_archive_download_count_spec.rb +42 -0
- data/spec/models/tag_protection_spec.rb +66 -0
- data/spec/models/tag_spec.rb +72 -0
- data/spec/models/team_search200_response_spec.rb +42 -0
- data/spec/models/team_spec.rb +88 -0
- data/spec/models/timeline_comment_spec.rb +204 -0
- data/spec/models/topic_name_spec.rb +36 -0
- data/spec/models/topic_response_spec.rb +60 -0
- data/spec/models/tracked_time_spec.rb +72 -0
- data/spec/models/transfer_repo_option_spec.rb +42 -0
- data/spec/models/update_file_options_spec.rb +90 -0
- data/spec/models/update_repo_avatar_option_spec.rb +36 -0
- data/spec/models/update_user_avatar_option_spec.rb +36 -0
- data/spec/models/update_variable_option_spec.rb +42 -0
- data/spec/models/user_heatmap_data_spec.rb +42 -0
- data/spec/models/user_search200_response_spec.rb +42 -0
- data/spec/models/user_settings_options_spec.rb +96 -0
- data/spec/models/user_settings_spec.rb +96 -0
- data/spec/models/user_spec.rb +168 -0
- data/spec/models/watch_info_spec.rb +66 -0
- data/spec/models/wiki_commit_list_spec.rb +42 -0
- data/spec/models/wiki_commit_spec.rb +54 -0
- data/spec/models/wiki_page_meta_data_spec.rb +54 -0
- data/spec/models/wiki_page_spec.rb +78 -0
- data/spec/spec_helper.rb +111 -0
- data/swagger.v1.json +26802 -0
- data/swagger.v1.patched.json +1 -0
- metadata +949 -0
data/docs/UserApi.md
ADDED
@@ -0,0 +1,4969 @@
|
|
1
|
+
# Forgejo::UserApi
|
2
|
+
|
3
|
+
All URIs are relative to */api/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_current_user_repo_0**](UserApi.md#create_current_user_repo_0) | **POST** /user/repos | Create a repository |
|
8
|
+
| [**create_user_variable**](UserApi.md#create_user_variable) | **POST** /user/actions/variables/{variablename} | Create a user-level variable |
|
9
|
+
| [**delete_user_secret**](UserApi.md#delete_user_secret) | **DELETE** /user/actions/secrets/{secretname} | Delete a secret in a user scope |
|
10
|
+
| [**delete_user_variable**](UserApi.md#delete_user_variable) | **DELETE** /user/actions/variables/{variablename} | Delete a user-level variable which is created by current doer |
|
11
|
+
| [**get_user_settings**](UserApi.md#get_user_settings) | **GET** /user/settings | Get user settings |
|
12
|
+
| [**get_user_variable**](UserApi.md#get_user_variable) | **GET** /user/actions/variables/{variablename} | Get a user-level variable which is created by current doer |
|
13
|
+
| [**get_user_variables_list**](UserApi.md#get_user_variables_list) | **GET** /user/actions/variables | Get the user-level list of variables which is created by current doer |
|
14
|
+
| [**get_verification_token**](UserApi.md#get_verification_token) | **GET** /user/gpg_key_token | Get a Token to verify |
|
15
|
+
| [**update_user_secret**](UserApi.md#update_user_secret) | **PUT** /user/actions/secrets/{secretname} | Create or Update a secret value in a user scope |
|
16
|
+
| [**update_user_settings**](UserApi.md#update_user_settings) | **PATCH** /user/settings | Update user settings |
|
17
|
+
| [**update_user_variable**](UserApi.md#update_user_variable) | **PUT** /user/actions/variables/{variablename} | Update a user-level variable which is created by current doer |
|
18
|
+
| [**user_add_email**](UserApi.md#user_add_email) | **POST** /user/emails | Add email addresses |
|
19
|
+
| [**user_block_user**](UserApi.md#user_block_user) | **PUT** /user/block/{username} | Blocks a user from the doer. |
|
20
|
+
| [**user_check_following**](UserApi.md#user_check_following) | **GET** /users/{username}/following/{target} | Check if one user is following another user |
|
21
|
+
| [**user_create_hook**](UserApi.md#user_create_hook) | **POST** /user/hooks | Create a hook |
|
22
|
+
| [**user_create_o_auth2_application**](UserApi.md#user_create_o_auth2_application) | **POST** /user/applications/oauth2 | creates a new OAuth2 application |
|
23
|
+
| [**user_create_token**](UserApi.md#user_create_token) | **POST** /users/{username}/tokens | Create an access token |
|
24
|
+
| [**user_current_check_following**](UserApi.md#user_current_check_following) | **GET** /user/following/{username} | Check whether a user is followed by the authenticated user |
|
25
|
+
| [**user_current_check_starring**](UserApi.md#user_current_check_starring) | **GET** /user/starred/{owner}/{repo} | Whether the authenticated is starring the repo |
|
26
|
+
| [**user_current_delete_follow**](UserApi.md#user_current_delete_follow) | **DELETE** /user/following/{username} | Unfollow a user |
|
27
|
+
| [**user_current_delete_gpg_key**](UserApi.md#user_current_delete_gpg_key) | **DELETE** /user/gpg_keys/{id} | Remove a GPG key |
|
28
|
+
| [**user_current_delete_key**](UserApi.md#user_current_delete_key) | **DELETE** /user/keys/{id} | Delete a public key |
|
29
|
+
| [**user_current_delete_star**](UserApi.md#user_current_delete_star) | **DELETE** /user/starred/{owner}/{repo} | Unstar the given repo |
|
30
|
+
| [**user_current_get_gpg_key**](UserApi.md#user_current_get_gpg_key) | **GET** /user/gpg_keys/{id} | Get a GPG key |
|
31
|
+
| [**user_current_get_key**](UserApi.md#user_current_get_key) | **GET** /user/keys/{id} | Get a public key |
|
32
|
+
| [**user_current_list_followers**](UserApi.md#user_current_list_followers) | **GET** /user/followers | List the authenticated user's followers |
|
33
|
+
| [**user_current_list_following**](UserApi.md#user_current_list_following) | **GET** /user/following | List the users that the authenticated user is following |
|
34
|
+
| [**user_current_list_gpg_keys**](UserApi.md#user_current_list_gpg_keys) | **GET** /user/gpg_keys | List the authenticated user's GPG keys |
|
35
|
+
| [**user_current_list_keys**](UserApi.md#user_current_list_keys) | **GET** /user/keys | List the authenticated user's public keys |
|
36
|
+
| [**user_current_list_repos**](UserApi.md#user_current_list_repos) | **GET** /user/repos | List the repos that the authenticated user owns |
|
37
|
+
| [**user_current_list_starred**](UserApi.md#user_current_list_starred) | **GET** /user/starred | The repos that the authenticated user has starred |
|
38
|
+
| [**user_current_list_subscriptions**](UserApi.md#user_current_list_subscriptions) | **GET** /user/subscriptions | List repositories watched by the authenticated user |
|
39
|
+
| [**user_current_post_gpg_key**](UserApi.md#user_current_post_gpg_key) | **POST** /user/gpg_keys | Create a GPG key |
|
40
|
+
| [**user_current_post_key**](UserApi.md#user_current_post_key) | **POST** /user/keys | Create a public key |
|
41
|
+
| [**user_current_put_follow**](UserApi.md#user_current_put_follow) | **PUT** /user/following/{username} | Follow a user |
|
42
|
+
| [**user_current_put_star**](UserApi.md#user_current_put_star) | **PUT** /user/starred/{owner}/{repo} | Star the given repo |
|
43
|
+
| [**user_current_tracked_times**](UserApi.md#user_current_tracked_times) | **GET** /user/times | List the current user's tracked times |
|
44
|
+
| [**user_delete_access_token**](UserApi.md#user_delete_access_token) | **DELETE** /users/{username}/tokens/{token} | delete an access token |
|
45
|
+
| [**user_delete_avatar**](UserApi.md#user_delete_avatar) | **DELETE** /user/avatar | Delete Avatar |
|
46
|
+
| [**user_delete_email**](UserApi.md#user_delete_email) | **DELETE** /user/emails | Delete email addresses |
|
47
|
+
| [**user_delete_hook**](UserApi.md#user_delete_hook) | **DELETE** /user/hooks/{id} | Delete a hook |
|
48
|
+
| [**user_delete_o_auth2_application**](UserApi.md#user_delete_o_auth2_application) | **DELETE** /user/applications/oauth2/{id} | delete an OAuth2 Application |
|
49
|
+
| [**user_edit_hook**](UserApi.md#user_edit_hook) | **PATCH** /user/hooks/{id} | Update a hook |
|
50
|
+
| [**user_get**](UserApi.md#user_get) | **GET** /users/{username} | Get a user |
|
51
|
+
| [**user_get_current**](UserApi.md#user_get_current) | **GET** /user | Get the authenticated user |
|
52
|
+
| [**user_get_heatmap_data**](UserApi.md#user_get_heatmap_data) | **GET** /users/{username}/heatmap | Get a user's heatmap |
|
53
|
+
| [**user_get_hook**](UserApi.md#user_get_hook) | **GET** /user/hooks/{id} | Get a hook |
|
54
|
+
| [**user_get_o_auth2_application**](UserApi.md#user_get_o_auth2_application) | **GET** /user/applications/oauth2/{id} | get an OAuth2 Application |
|
55
|
+
| [**user_get_o_auth2_applications**](UserApi.md#user_get_o_auth2_applications) | **GET** /user/applications/oauth2 | List the authenticated user's oauth2 applications |
|
56
|
+
| [**user_get_runner_registration_token**](UserApi.md#user_get_runner_registration_token) | **GET** /user/actions/runners/registration-token | Get an user's actions runner registration token |
|
57
|
+
| [**user_get_stop_watches**](UserApi.md#user_get_stop_watches) | **GET** /user/stopwatches | Get list of all existing stopwatches |
|
58
|
+
| [**user_get_tokens**](UserApi.md#user_get_tokens) | **GET** /users/{username}/tokens | List the authenticated user's access tokens |
|
59
|
+
| [**user_list_activity_feeds**](UserApi.md#user_list_activity_feeds) | **GET** /users/{username}/activities/feeds | List a user's activity feeds |
|
60
|
+
| [**user_list_blocked_users**](UserApi.md#user_list_blocked_users) | **GET** /user/list_blocked | List the authenticated user's blocked users |
|
61
|
+
| [**user_list_emails**](UserApi.md#user_list_emails) | **GET** /user/emails | List the authenticated user's email addresses |
|
62
|
+
| [**user_list_followers**](UserApi.md#user_list_followers) | **GET** /users/{username}/followers | List the given user's followers |
|
63
|
+
| [**user_list_following**](UserApi.md#user_list_following) | **GET** /users/{username}/following | List the users that the given user is following |
|
64
|
+
| [**user_list_gpg_keys**](UserApi.md#user_list_gpg_keys) | **GET** /users/{username}/gpg_keys | List the given user's GPG keys |
|
65
|
+
| [**user_list_hooks**](UserApi.md#user_list_hooks) | **GET** /user/hooks | List the authenticated user's webhooks |
|
66
|
+
| [**user_list_keys**](UserApi.md#user_list_keys) | **GET** /users/{username}/keys | List the given user's public keys |
|
67
|
+
| [**user_list_repos**](UserApi.md#user_list_repos) | **GET** /users/{username}/repos | List the repos owned by the given user |
|
68
|
+
| [**user_list_starred**](UserApi.md#user_list_starred) | **GET** /users/{username}/starred | The repos that the given user has starred |
|
69
|
+
| [**user_list_subscriptions**](UserApi.md#user_list_subscriptions) | **GET** /users/{username}/subscriptions | List the repositories watched by a user |
|
70
|
+
| [**user_list_teams**](UserApi.md#user_list_teams) | **GET** /user/teams | List all the teams a user belongs to |
|
71
|
+
| [**user_search**](UserApi.md#user_search) | **GET** /users/search | Search for users |
|
72
|
+
| [**user_unblock_user**](UserApi.md#user_unblock_user) | **PUT** /user/unblock/{username} | Unblocks a user from the doer. |
|
73
|
+
| [**user_update_avatar**](UserApi.md#user_update_avatar) | **POST** /user/avatar | Update Avatar |
|
74
|
+
| [**user_update_o_auth2_application**](UserApi.md#user_update_o_auth2_application) | **PATCH** /user/applications/oauth2/{id} | update an OAuth2 Application, this includes regenerating the client secret |
|
75
|
+
| [**user_verify_gpg_key**](UserApi.md#user_verify_gpg_key) | **POST** /user/gpg_key_verify | Verify a GPG key |
|
76
|
+
|
77
|
+
|
78
|
+
## create_current_user_repo_0
|
79
|
+
|
80
|
+
> <Repository> create_current_user_repo_0(opts)
|
81
|
+
|
82
|
+
Create a repository
|
83
|
+
|
84
|
+
### Examples
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
require 'time'
|
88
|
+
require 'forgejo'
|
89
|
+
# setup authorization
|
90
|
+
Forgejo.configure do |config|
|
91
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
92
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
93
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
94
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
95
|
+
end
|
96
|
+
|
97
|
+
api_instance = Forgejo::UserApi.new
|
98
|
+
opts = {
|
99
|
+
body: Forgejo::CreateRepoOption.new({name: 'name_example'}) # CreateRepoOption |
|
100
|
+
}
|
101
|
+
|
102
|
+
begin
|
103
|
+
# Create a repository
|
104
|
+
result = api_instance.create_current_user_repo_0(opts)
|
105
|
+
p result
|
106
|
+
rescue Forgejo::ApiError => e
|
107
|
+
puts "Error when calling UserApi->create_current_user_repo_0: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
#### Using the create_current_user_repo_0_with_http_info variant
|
112
|
+
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
114
|
+
|
115
|
+
> <Array(<Repository>, Integer, Hash)> create_current_user_repo_0_with_http_info(opts)
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
begin
|
119
|
+
# Create a repository
|
120
|
+
data, status_code, headers = api_instance.create_current_user_repo_0_with_http_info(opts)
|
121
|
+
p status_code # => 2xx
|
122
|
+
p headers # => { ... }
|
123
|
+
p data # => <Repository>
|
124
|
+
rescue Forgejo::ApiError => e
|
125
|
+
puts "Error when calling UserApi->create_current_user_repo_0_with_http_info: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **body** | [**CreateRepoOption**](CreateRepoOption.md) | | [optional] |
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**Repository**](Repository.md)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: application/json
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
148
|
+
|
149
|
+
## create_user_variable
|
150
|
+
|
151
|
+
> create_user_variable(variablename, opts)
|
152
|
+
|
153
|
+
Create a user-level variable
|
154
|
+
|
155
|
+
### Examples
|
156
|
+
|
157
|
+
```ruby
|
158
|
+
require 'time'
|
159
|
+
require 'forgejo'
|
160
|
+
# setup authorization
|
161
|
+
Forgejo.configure do |config|
|
162
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
163
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
164
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
165
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = Forgejo::UserApi.new
|
169
|
+
variablename = 'variablename_example' # String | name of the variable
|
170
|
+
opts = {
|
171
|
+
body: Forgejo::CreateVariableOption.new({value: 'value_example'}) # CreateVariableOption |
|
172
|
+
}
|
173
|
+
|
174
|
+
begin
|
175
|
+
# Create a user-level variable
|
176
|
+
api_instance.create_user_variable(variablename, opts)
|
177
|
+
rescue Forgejo::ApiError => e
|
178
|
+
puts "Error when calling UserApi->create_user_variable: #{e}"
|
179
|
+
end
|
180
|
+
```
|
181
|
+
|
182
|
+
#### Using the create_user_variable_with_http_info variant
|
183
|
+
|
184
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
185
|
+
|
186
|
+
> <Array(nil, Integer, Hash)> create_user_variable_with_http_info(variablename, opts)
|
187
|
+
|
188
|
+
```ruby
|
189
|
+
begin
|
190
|
+
# Create a user-level variable
|
191
|
+
data, status_code, headers = api_instance.create_user_variable_with_http_info(variablename, opts)
|
192
|
+
p status_code # => 2xx
|
193
|
+
p headers # => { ... }
|
194
|
+
p data # => nil
|
195
|
+
rescue Forgejo::ApiError => e
|
196
|
+
puts "Error when calling UserApi->create_user_variable_with_http_info: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
### Parameters
|
201
|
+
|
202
|
+
| Name | Type | Description | Notes |
|
203
|
+
| ---- | ---- | ----------- | ----- |
|
204
|
+
| **variablename** | **String** | name of the variable | |
|
205
|
+
| **body** | [**CreateVariableOption**](CreateVariableOption.md) | | [optional] |
|
206
|
+
|
207
|
+
### Return type
|
208
|
+
|
209
|
+
nil (empty response body)
|
210
|
+
|
211
|
+
### Authorization
|
212
|
+
|
213
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
214
|
+
|
215
|
+
### HTTP request headers
|
216
|
+
|
217
|
+
- **Content-Type**: application/json
|
218
|
+
- **Accept**: Not defined
|
219
|
+
|
220
|
+
|
221
|
+
## delete_user_secret
|
222
|
+
|
223
|
+
> delete_user_secret(secretname)
|
224
|
+
|
225
|
+
Delete a secret in a user scope
|
226
|
+
|
227
|
+
### Examples
|
228
|
+
|
229
|
+
```ruby
|
230
|
+
require 'time'
|
231
|
+
require 'forgejo'
|
232
|
+
# setup authorization
|
233
|
+
Forgejo.configure do |config|
|
234
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
235
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
236
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
237
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
238
|
+
end
|
239
|
+
|
240
|
+
api_instance = Forgejo::UserApi.new
|
241
|
+
secretname = 'secretname_example' # String | name of the secret
|
242
|
+
|
243
|
+
begin
|
244
|
+
# Delete a secret in a user scope
|
245
|
+
api_instance.delete_user_secret(secretname)
|
246
|
+
rescue Forgejo::ApiError => e
|
247
|
+
puts "Error when calling UserApi->delete_user_secret: #{e}"
|
248
|
+
end
|
249
|
+
```
|
250
|
+
|
251
|
+
#### Using the delete_user_secret_with_http_info variant
|
252
|
+
|
253
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
254
|
+
|
255
|
+
> <Array(nil, Integer, Hash)> delete_user_secret_with_http_info(secretname)
|
256
|
+
|
257
|
+
```ruby
|
258
|
+
begin
|
259
|
+
# Delete a secret in a user scope
|
260
|
+
data, status_code, headers = api_instance.delete_user_secret_with_http_info(secretname)
|
261
|
+
p status_code # => 2xx
|
262
|
+
p headers # => { ... }
|
263
|
+
p data # => nil
|
264
|
+
rescue Forgejo::ApiError => e
|
265
|
+
puts "Error when calling UserApi->delete_user_secret_with_http_info: #{e}"
|
266
|
+
end
|
267
|
+
```
|
268
|
+
|
269
|
+
### Parameters
|
270
|
+
|
271
|
+
| Name | Type | Description | Notes |
|
272
|
+
| ---- | ---- | ----------- | ----- |
|
273
|
+
| **secretname** | **String** | name of the secret | |
|
274
|
+
|
275
|
+
### Return type
|
276
|
+
|
277
|
+
nil (empty response body)
|
278
|
+
|
279
|
+
### Authorization
|
280
|
+
|
281
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
282
|
+
|
283
|
+
### HTTP request headers
|
284
|
+
|
285
|
+
- **Content-Type**: Not defined
|
286
|
+
- **Accept**: Not defined
|
287
|
+
|
288
|
+
|
289
|
+
## delete_user_variable
|
290
|
+
|
291
|
+
> delete_user_variable(variablename)
|
292
|
+
|
293
|
+
Delete a user-level variable which is created by current doer
|
294
|
+
|
295
|
+
### Examples
|
296
|
+
|
297
|
+
```ruby
|
298
|
+
require 'time'
|
299
|
+
require 'forgejo'
|
300
|
+
# setup authorization
|
301
|
+
Forgejo.configure do |config|
|
302
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
303
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
304
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
305
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
306
|
+
end
|
307
|
+
|
308
|
+
api_instance = Forgejo::UserApi.new
|
309
|
+
variablename = 'variablename_example' # String | name of the variable
|
310
|
+
|
311
|
+
begin
|
312
|
+
# Delete a user-level variable which is created by current doer
|
313
|
+
api_instance.delete_user_variable(variablename)
|
314
|
+
rescue Forgejo::ApiError => e
|
315
|
+
puts "Error when calling UserApi->delete_user_variable: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
#### Using the delete_user_variable_with_http_info variant
|
320
|
+
|
321
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
322
|
+
|
323
|
+
> <Array(nil, Integer, Hash)> delete_user_variable_with_http_info(variablename)
|
324
|
+
|
325
|
+
```ruby
|
326
|
+
begin
|
327
|
+
# Delete a user-level variable which is created by current doer
|
328
|
+
data, status_code, headers = api_instance.delete_user_variable_with_http_info(variablename)
|
329
|
+
p status_code # => 2xx
|
330
|
+
p headers # => { ... }
|
331
|
+
p data # => nil
|
332
|
+
rescue Forgejo::ApiError => e
|
333
|
+
puts "Error when calling UserApi->delete_user_variable_with_http_info: #{e}"
|
334
|
+
end
|
335
|
+
```
|
336
|
+
|
337
|
+
### Parameters
|
338
|
+
|
339
|
+
| Name | Type | Description | Notes |
|
340
|
+
| ---- | ---- | ----------- | ----- |
|
341
|
+
| **variablename** | **String** | name of the variable | |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
nil (empty response body)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: Not defined
|
355
|
+
|
356
|
+
|
357
|
+
## get_user_settings
|
358
|
+
|
359
|
+
> <UserSettings> get_user_settings
|
360
|
+
|
361
|
+
Get user settings
|
362
|
+
|
363
|
+
### Examples
|
364
|
+
|
365
|
+
```ruby
|
366
|
+
require 'time'
|
367
|
+
require 'forgejo'
|
368
|
+
# setup authorization
|
369
|
+
Forgejo.configure do |config|
|
370
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
371
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
373
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
374
|
+
end
|
375
|
+
|
376
|
+
api_instance = Forgejo::UserApi.new
|
377
|
+
|
378
|
+
begin
|
379
|
+
# Get user settings
|
380
|
+
result = api_instance.get_user_settings
|
381
|
+
p result
|
382
|
+
rescue Forgejo::ApiError => e
|
383
|
+
puts "Error when calling UserApi->get_user_settings: #{e}"
|
384
|
+
end
|
385
|
+
```
|
386
|
+
|
387
|
+
#### Using the get_user_settings_with_http_info variant
|
388
|
+
|
389
|
+
This returns an Array which contains the response data, status code and headers.
|
390
|
+
|
391
|
+
> <Array(<UserSettings>, Integer, Hash)> get_user_settings_with_http_info
|
392
|
+
|
393
|
+
```ruby
|
394
|
+
begin
|
395
|
+
# Get user settings
|
396
|
+
data, status_code, headers = api_instance.get_user_settings_with_http_info
|
397
|
+
p status_code # => 2xx
|
398
|
+
p headers # => { ... }
|
399
|
+
p data # => <UserSettings>
|
400
|
+
rescue Forgejo::ApiError => e
|
401
|
+
puts "Error when calling UserApi->get_user_settings_with_http_info: #{e}"
|
402
|
+
end
|
403
|
+
```
|
404
|
+
|
405
|
+
### Parameters
|
406
|
+
|
407
|
+
This endpoint does not need any parameter.
|
408
|
+
|
409
|
+
### Return type
|
410
|
+
|
411
|
+
[**UserSettings**](UserSettings.md)
|
412
|
+
|
413
|
+
### Authorization
|
414
|
+
|
415
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
416
|
+
|
417
|
+
### HTTP request headers
|
418
|
+
|
419
|
+
- **Content-Type**: Not defined
|
420
|
+
- **Accept**: application/json
|
421
|
+
|
422
|
+
|
423
|
+
## get_user_variable
|
424
|
+
|
425
|
+
> <ActionVariable> get_user_variable(variablename)
|
426
|
+
|
427
|
+
Get a user-level variable which is created by current doer
|
428
|
+
|
429
|
+
### Examples
|
430
|
+
|
431
|
+
```ruby
|
432
|
+
require 'time'
|
433
|
+
require 'forgejo'
|
434
|
+
# setup authorization
|
435
|
+
Forgejo.configure do |config|
|
436
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
437
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
438
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
439
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
440
|
+
end
|
441
|
+
|
442
|
+
api_instance = Forgejo::UserApi.new
|
443
|
+
variablename = 'variablename_example' # String | name of the variable
|
444
|
+
|
445
|
+
begin
|
446
|
+
# Get a user-level variable which is created by current doer
|
447
|
+
result = api_instance.get_user_variable(variablename)
|
448
|
+
p result
|
449
|
+
rescue Forgejo::ApiError => e
|
450
|
+
puts "Error when calling UserApi->get_user_variable: #{e}"
|
451
|
+
end
|
452
|
+
```
|
453
|
+
|
454
|
+
#### Using the get_user_variable_with_http_info variant
|
455
|
+
|
456
|
+
This returns an Array which contains the response data, status code and headers.
|
457
|
+
|
458
|
+
> <Array(<ActionVariable>, Integer, Hash)> get_user_variable_with_http_info(variablename)
|
459
|
+
|
460
|
+
```ruby
|
461
|
+
begin
|
462
|
+
# Get a user-level variable which is created by current doer
|
463
|
+
data, status_code, headers = api_instance.get_user_variable_with_http_info(variablename)
|
464
|
+
p status_code # => 2xx
|
465
|
+
p headers # => { ... }
|
466
|
+
p data # => <ActionVariable>
|
467
|
+
rescue Forgejo::ApiError => e
|
468
|
+
puts "Error when calling UserApi->get_user_variable_with_http_info: #{e}"
|
469
|
+
end
|
470
|
+
```
|
471
|
+
|
472
|
+
### Parameters
|
473
|
+
|
474
|
+
| Name | Type | Description | Notes |
|
475
|
+
| ---- | ---- | ----------- | ----- |
|
476
|
+
| **variablename** | **String** | name of the variable | |
|
477
|
+
|
478
|
+
### Return type
|
479
|
+
|
480
|
+
[**ActionVariable**](ActionVariable.md)
|
481
|
+
|
482
|
+
### Authorization
|
483
|
+
|
484
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
485
|
+
|
486
|
+
### HTTP request headers
|
487
|
+
|
488
|
+
- **Content-Type**: Not defined
|
489
|
+
- **Accept**: application/json
|
490
|
+
|
491
|
+
|
492
|
+
## get_user_variables_list
|
493
|
+
|
494
|
+
> <Array<ActionVariable>> get_user_variables_list(opts)
|
495
|
+
|
496
|
+
Get the user-level list of variables which is created by current doer
|
497
|
+
|
498
|
+
### Examples
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
require 'time'
|
502
|
+
require 'forgejo'
|
503
|
+
# setup authorization
|
504
|
+
Forgejo.configure do |config|
|
505
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
506
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
507
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
508
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
509
|
+
end
|
510
|
+
|
511
|
+
api_instance = Forgejo::UserApi.new
|
512
|
+
opts = {
|
513
|
+
page: 56, # Integer | page number of results to return (1-based)
|
514
|
+
limit: 56 # Integer | page size of results
|
515
|
+
}
|
516
|
+
|
517
|
+
begin
|
518
|
+
# Get the user-level list of variables which is created by current doer
|
519
|
+
result = api_instance.get_user_variables_list(opts)
|
520
|
+
p result
|
521
|
+
rescue Forgejo::ApiError => e
|
522
|
+
puts "Error when calling UserApi->get_user_variables_list: #{e}"
|
523
|
+
end
|
524
|
+
```
|
525
|
+
|
526
|
+
#### Using the get_user_variables_list_with_http_info variant
|
527
|
+
|
528
|
+
This returns an Array which contains the response data, status code and headers.
|
529
|
+
|
530
|
+
> <Array(<Array<ActionVariable>>, Integer, Hash)> get_user_variables_list_with_http_info(opts)
|
531
|
+
|
532
|
+
```ruby
|
533
|
+
begin
|
534
|
+
# Get the user-level list of variables which is created by current doer
|
535
|
+
data, status_code, headers = api_instance.get_user_variables_list_with_http_info(opts)
|
536
|
+
p status_code # => 2xx
|
537
|
+
p headers # => { ... }
|
538
|
+
p data # => <Array<ActionVariable>>
|
539
|
+
rescue Forgejo::ApiError => e
|
540
|
+
puts "Error when calling UserApi->get_user_variables_list_with_http_info: #{e}"
|
541
|
+
end
|
542
|
+
```
|
543
|
+
|
544
|
+
### Parameters
|
545
|
+
|
546
|
+
| Name | Type | Description | Notes |
|
547
|
+
| ---- | ---- | ----------- | ----- |
|
548
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
549
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
550
|
+
|
551
|
+
### Return type
|
552
|
+
|
553
|
+
[**Array<ActionVariable>**](ActionVariable.md)
|
554
|
+
|
555
|
+
### Authorization
|
556
|
+
|
557
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
558
|
+
|
559
|
+
### HTTP request headers
|
560
|
+
|
561
|
+
- **Content-Type**: Not defined
|
562
|
+
- **Accept**: application/json
|
563
|
+
|
564
|
+
|
565
|
+
## get_verification_token
|
566
|
+
|
567
|
+
> String get_verification_token
|
568
|
+
|
569
|
+
Get a Token to verify
|
570
|
+
|
571
|
+
### Examples
|
572
|
+
|
573
|
+
```ruby
|
574
|
+
require 'time'
|
575
|
+
require 'forgejo'
|
576
|
+
# setup authorization
|
577
|
+
Forgejo.configure do |config|
|
578
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
579
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
580
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
581
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
582
|
+
end
|
583
|
+
|
584
|
+
api_instance = Forgejo::UserApi.new
|
585
|
+
|
586
|
+
begin
|
587
|
+
# Get a Token to verify
|
588
|
+
result = api_instance.get_verification_token
|
589
|
+
p result
|
590
|
+
rescue Forgejo::ApiError => e
|
591
|
+
puts "Error when calling UserApi->get_verification_token: #{e}"
|
592
|
+
end
|
593
|
+
```
|
594
|
+
|
595
|
+
#### Using the get_verification_token_with_http_info variant
|
596
|
+
|
597
|
+
This returns an Array which contains the response data, status code and headers.
|
598
|
+
|
599
|
+
> <Array(String, Integer, Hash)> get_verification_token_with_http_info
|
600
|
+
|
601
|
+
```ruby
|
602
|
+
begin
|
603
|
+
# Get a Token to verify
|
604
|
+
data, status_code, headers = api_instance.get_verification_token_with_http_info
|
605
|
+
p status_code # => 2xx
|
606
|
+
p headers # => { ... }
|
607
|
+
p data # => String
|
608
|
+
rescue Forgejo::ApiError => e
|
609
|
+
puts "Error when calling UserApi->get_verification_token_with_http_info: #{e}"
|
610
|
+
end
|
611
|
+
```
|
612
|
+
|
613
|
+
### Parameters
|
614
|
+
|
615
|
+
This endpoint does not need any parameter.
|
616
|
+
|
617
|
+
### Return type
|
618
|
+
|
619
|
+
**String**
|
620
|
+
|
621
|
+
### Authorization
|
622
|
+
|
623
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
624
|
+
|
625
|
+
### HTTP request headers
|
626
|
+
|
627
|
+
- **Content-Type**: Not defined
|
628
|
+
- **Accept**: text/plain
|
629
|
+
|
630
|
+
|
631
|
+
## update_user_secret
|
632
|
+
|
633
|
+
> update_user_secret(secretname, opts)
|
634
|
+
|
635
|
+
Create or Update a secret value in a user scope
|
636
|
+
|
637
|
+
### Examples
|
638
|
+
|
639
|
+
```ruby
|
640
|
+
require 'time'
|
641
|
+
require 'forgejo'
|
642
|
+
# setup authorization
|
643
|
+
Forgejo.configure do |config|
|
644
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
645
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
646
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
647
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
648
|
+
end
|
649
|
+
|
650
|
+
api_instance = Forgejo::UserApi.new
|
651
|
+
secretname = 'secretname_example' # String | name of the secret
|
652
|
+
opts = {
|
653
|
+
body: Forgejo::CreateOrUpdateSecretOption.new({data: 'data_example'}) # CreateOrUpdateSecretOption |
|
654
|
+
}
|
655
|
+
|
656
|
+
begin
|
657
|
+
# Create or Update a secret value in a user scope
|
658
|
+
api_instance.update_user_secret(secretname, opts)
|
659
|
+
rescue Forgejo::ApiError => e
|
660
|
+
puts "Error when calling UserApi->update_user_secret: #{e}"
|
661
|
+
end
|
662
|
+
```
|
663
|
+
|
664
|
+
#### Using the update_user_secret_with_http_info variant
|
665
|
+
|
666
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
667
|
+
|
668
|
+
> <Array(nil, Integer, Hash)> update_user_secret_with_http_info(secretname, opts)
|
669
|
+
|
670
|
+
```ruby
|
671
|
+
begin
|
672
|
+
# Create or Update a secret value in a user scope
|
673
|
+
data, status_code, headers = api_instance.update_user_secret_with_http_info(secretname, opts)
|
674
|
+
p status_code # => 2xx
|
675
|
+
p headers # => { ... }
|
676
|
+
p data # => nil
|
677
|
+
rescue Forgejo::ApiError => e
|
678
|
+
puts "Error when calling UserApi->update_user_secret_with_http_info: #{e}"
|
679
|
+
end
|
680
|
+
```
|
681
|
+
|
682
|
+
### Parameters
|
683
|
+
|
684
|
+
| Name | Type | Description | Notes |
|
685
|
+
| ---- | ---- | ----------- | ----- |
|
686
|
+
| **secretname** | **String** | name of the secret | |
|
687
|
+
| **body** | [**CreateOrUpdateSecretOption**](CreateOrUpdateSecretOption.md) | | [optional] |
|
688
|
+
|
689
|
+
### Return type
|
690
|
+
|
691
|
+
nil (empty response body)
|
692
|
+
|
693
|
+
### Authorization
|
694
|
+
|
695
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
696
|
+
|
697
|
+
### HTTP request headers
|
698
|
+
|
699
|
+
- **Content-Type**: application/json
|
700
|
+
- **Accept**: Not defined
|
701
|
+
|
702
|
+
|
703
|
+
## update_user_settings
|
704
|
+
|
705
|
+
> <UserSettings> update_user_settings(opts)
|
706
|
+
|
707
|
+
Update user settings
|
708
|
+
|
709
|
+
### Examples
|
710
|
+
|
711
|
+
```ruby
|
712
|
+
require 'time'
|
713
|
+
require 'forgejo'
|
714
|
+
# setup authorization
|
715
|
+
Forgejo.configure do |config|
|
716
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
717
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
718
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
719
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
720
|
+
end
|
721
|
+
|
722
|
+
api_instance = Forgejo::UserApi.new
|
723
|
+
opts = {
|
724
|
+
body: Forgejo::UserSettingsOptions.new # UserSettingsOptions |
|
725
|
+
}
|
726
|
+
|
727
|
+
begin
|
728
|
+
# Update user settings
|
729
|
+
result = api_instance.update_user_settings(opts)
|
730
|
+
p result
|
731
|
+
rescue Forgejo::ApiError => e
|
732
|
+
puts "Error when calling UserApi->update_user_settings: #{e}"
|
733
|
+
end
|
734
|
+
```
|
735
|
+
|
736
|
+
#### Using the update_user_settings_with_http_info variant
|
737
|
+
|
738
|
+
This returns an Array which contains the response data, status code and headers.
|
739
|
+
|
740
|
+
> <Array(<UserSettings>, Integer, Hash)> update_user_settings_with_http_info(opts)
|
741
|
+
|
742
|
+
```ruby
|
743
|
+
begin
|
744
|
+
# Update user settings
|
745
|
+
data, status_code, headers = api_instance.update_user_settings_with_http_info(opts)
|
746
|
+
p status_code # => 2xx
|
747
|
+
p headers # => { ... }
|
748
|
+
p data # => <UserSettings>
|
749
|
+
rescue Forgejo::ApiError => e
|
750
|
+
puts "Error when calling UserApi->update_user_settings_with_http_info: #{e}"
|
751
|
+
end
|
752
|
+
```
|
753
|
+
|
754
|
+
### Parameters
|
755
|
+
|
756
|
+
| Name | Type | Description | Notes |
|
757
|
+
| ---- | ---- | ----------- | ----- |
|
758
|
+
| **body** | [**UserSettingsOptions**](UserSettingsOptions.md) | | [optional] |
|
759
|
+
|
760
|
+
### Return type
|
761
|
+
|
762
|
+
[**UserSettings**](UserSettings.md)
|
763
|
+
|
764
|
+
### Authorization
|
765
|
+
|
766
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
767
|
+
|
768
|
+
### HTTP request headers
|
769
|
+
|
770
|
+
- **Content-Type**: application/json, text/plain
|
771
|
+
- **Accept**: application/json
|
772
|
+
|
773
|
+
|
774
|
+
## update_user_variable
|
775
|
+
|
776
|
+
> update_user_variable(variablename, opts)
|
777
|
+
|
778
|
+
Update a user-level variable which is created by current doer
|
779
|
+
|
780
|
+
### Examples
|
781
|
+
|
782
|
+
```ruby
|
783
|
+
require 'time'
|
784
|
+
require 'forgejo'
|
785
|
+
# setup authorization
|
786
|
+
Forgejo.configure do |config|
|
787
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
788
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
789
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
790
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
791
|
+
end
|
792
|
+
|
793
|
+
api_instance = Forgejo::UserApi.new
|
794
|
+
variablename = 'variablename_example' # String | name of the variable
|
795
|
+
opts = {
|
796
|
+
body: Forgejo::UpdateVariableOption.new({value: 'value_example'}) # UpdateVariableOption |
|
797
|
+
}
|
798
|
+
|
799
|
+
begin
|
800
|
+
# Update a user-level variable which is created by current doer
|
801
|
+
api_instance.update_user_variable(variablename, opts)
|
802
|
+
rescue Forgejo::ApiError => e
|
803
|
+
puts "Error when calling UserApi->update_user_variable: #{e}"
|
804
|
+
end
|
805
|
+
```
|
806
|
+
|
807
|
+
#### Using the update_user_variable_with_http_info variant
|
808
|
+
|
809
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
810
|
+
|
811
|
+
> <Array(nil, Integer, Hash)> update_user_variable_with_http_info(variablename, opts)
|
812
|
+
|
813
|
+
```ruby
|
814
|
+
begin
|
815
|
+
# Update a user-level variable which is created by current doer
|
816
|
+
data, status_code, headers = api_instance.update_user_variable_with_http_info(variablename, opts)
|
817
|
+
p status_code # => 2xx
|
818
|
+
p headers # => { ... }
|
819
|
+
p data # => nil
|
820
|
+
rescue Forgejo::ApiError => e
|
821
|
+
puts "Error when calling UserApi->update_user_variable_with_http_info: #{e}"
|
822
|
+
end
|
823
|
+
```
|
824
|
+
|
825
|
+
### Parameters
|
826
|
+
|
827
|
+
| Name | Type | Description | Notes |
|
828
|
+
| ---- | ---- | ----------- | ----- |
|
829
|
+
| **variablename** | **String** | name of the variable | |
|
830
|
+
| **body** | [**UpdateVariableOption**](UpdateVariableOption.md) | | [optional] |
|
831
|
+
|
832
|
+
### Return type
|
833
|
+
|
834
|
+
nil (empty response body)
|
835
|
+
|
836
|
+
### Authorization
|
837
|
+
|
838
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
839
|
+
|
840
|
+
### HTTP request headers
|
841
|
+
|
842
|
+
- **Content-Type**: application/json
|
843
|
+
- **Accept**: Not defined
|
844
|
+
|
845
|
+
|
846
|
+
## user_add_email
|
847
|
+
|
848
|
+
> <Array<Email>> user_add_email(opts)
|
849
|
+
|
850
|
+
Add email addresses
|
851
|
+
|
852
|
+
### Examples
|
853
|
+
|
854
|
+
```ruby
|
855
|
+
require 'time'
|
856
|
+
require 'forgejo'
|
857
|
+
# setup authorization
|
858
|
+
Forgejo.configure do |config|
|
859
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
860
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
861
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
862
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
863
|
+
end
|
864
|
+
|
865
|
+
api_instance = Forgejo::UserApi.new
|
866
|
+
opts = {
|
867
|
+
body: Forgejo::CreateEmailOption.new # CreateEmailOption |
|
868
|
+
}
|
869
|
+
|
870
|
+
begin
|
871
|
+
# Add email addresses
|
872
|
+
result = api_instance.user_add_email(opts)
|
873
|
+
p result
|
874
|
+
rescue Forgejo::ApiError => e
|
875
|
+
puts "Error when calling UserApi->user_add_email: #{e}"
|
876
|
+
end
|
877
|
+
```
|
878
|
+
|
879
|
+
#### Using the user_add_email_with_http_info variant
|
880
|
+
|
881
|
+
This returns an Array which contains the response data, status code and headers.
|
882
|
+
|
883
|
+
> <Array(<Array<Email>>, Integer, Hash)> user_add_email_with_http_info(opts)
|
884
|
+
|
885
|
+
```ruby
|
886
|
+
begin
|
887
|
+
# Add email addresses
|
888
|
+
data, status_code, headers = api_instance.user_add_email_with_http_info(opts)
|
889
|
+
p status_code # => 2xx
|
890
|
+
p headers # => { ... }
|
891
|
+
p data # => <Array<Email>>
|
892
|
+
rescue Forgejo::ApiError => e
|
893
|
+
puts "Error when calling UserApi->user_add_email_with_http_info: #{e}"
|
894
|
+
end
|
895
|
+
```
|
896
|
+
|
897
|
+
### Parameters
|
898
|
+
|
899
|
+
| Name | Type | Description | Notes |
|
900
|
+
| ---- | ---- | ----------- | ----- |
|
901
|
+
| **body** | [**CreateEmailOption**](CreateEmailOption.md) | | [optional] |
|
902
|
+
|
903
|
+
### Return type
|
904
|
+
|
905
|
+
[**Array<Email>**](Email.md)
|
906
|
+
|
907
|
+
### Authorization
|
908
|
+
|
909
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
910
|
+
|
911
|
+
### HTTP request headers
|
912
|
+
|
913
|
+
- **Content-Type**: application/json, text/plain
|
914
|
+
- **Accept**: application/json
|
915
|
+
|
916
|
+
|
917
|
+
## user_block_user
|
918
|
+
|
919
|
+
> user_block_user(username)
|
920
|
+
|
921
|
+
Blocks a user from the doer.
|
922
|
+
|
923
|
+
### Examples
|
924
|
+
|
925
|
+
```ruby
|
926
|
+
require 'time'
|
927
|
+
require 'forgejo'
|
928
|
+
# setup authorization
|
929
|
+
Forgejo.configure do |config|
|
930
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
931
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
932
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
933
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
934
|
+
end
|
935
|
+
|
936
|
+
api_instance = Forgejo::UserApi.new
|
937
|
+
username = 'username_example' # String | username of the user
|
938
|
+
|
939
|
+
begin
|
940
|
+
# Blocks a user from the doer.
|
941
|
+
api_instance.user_block_user(username)
|
942
|
+
rescue Forgejo::ApiError => e
|
943
|
+
puts "Error when calling UserApi->user_block_user: #{e}"
|
944
|
+
end
|
945
|
+
```
|
946
|
+
|
947
|
+
#### Using the user_block_user_with_http_info variant
|
948
|
+
|
949
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
950
|
+
|
951
|
+
> <Array(nil, Integer, Hash)> user_block_user_with_http_info(username)
|
952
|
+
|
953
|
+
```ruby
|
954
|
+
begin
|
955
|
+
# Blocks a user from the doer.
|
956
|
+
data, status_code, headers = api_instance.user_block_user_with_http_info(username)
|
957
|
+
p status_code # => 2xx
|
958
|
+
p headers # => { ... }
|
959
|
+
p data # => nil
|
960
|
+
rescue Forgejo::ApiError => e
|
961
|
+
puts "Error when calling UserApi->user_block_user_with_http_info: #{e}"
|
962
|
+
end
|
963
|
+
```
|
964
|
+
|
965
|
+
### Parameters
|
966
|
+
|
967
|
+
| Name | Type | Description | Notes |
|
968
|
+
| ---- | ---- | ----------- | ----- |
|
969
|
+
| **username** | **String** | username of the user | |
|
970
|
+
|
971
|
+
### Return type
|
972
|
+
|
973
|
+
nil (empty response body)
|
974
|
+
|
975
|
+
### Authorization
|
976
|
+
|
977
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
978
|
+
|
979
|
+
### HTTP request headers
|
980
|
+
|
981
|
+
- **Content-Type**: Not defined
|
982
|
+
- **Accept**: Not defined
|
983
|
+
|
984
|
+
|
985
|
+
## user_check_following
|
986
|
+
|
987
|
+
> user_check_following(username, target)
|
988
|
+
|
989
|
+
Check if one user is following another user
|
990
|
+
|
991
|
+
### Examples
|
992
|
+
|
993
|
+
```ruby
|
994
|
+
require 'time'
|
995
|
+
require 'forgejo'
|
996
|
+
# setup authorization
|
997
|
+
Forgejo.configure do |config|
|
998
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
999
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1000
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1001
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
api_instance = Forgejo::UserApi.new
|
1005
|
+
username = 'username_example' # String | username of following user
|
1006
|
+
target = 'target_example' # String | username of followed user
|
1007
|
+
|
1008
|
+
begin
|
1009
|
+
# Check if one user is following another user
|
1010
|
+
api_instance.user_check_following(username, target)
|
1011
|
+
rescue Forgejo::ApiError => e
|
1012
|
+
puts "Error when calling UserApi->user_check_following: #{e}"
|
1013
|
+
end
|
1014
|
+
```
|
1015
|
+
|
1016
|
+
#### Using the user_check_following_with_http_info variant
|
1017
|
+
|
1018
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1019
|
+
|
1020
|
+
> <Array(nil, Integer, Hash)> user_check_following_with_http_info(username, target)
|
1021
|
+
|
1022
|
+
```ruby
|
1023
|
+
begin
|
1024
|
+
# Check if one user is following another user
|
1025
|
+
data, status_code, headers = api_instance.user_check_following_with_http_info(username, target)
|
1026
|
+
p status_code # => 2xx
|
1027
|
+
p headers # => { ... }
|
1028
|
+
p data # => nil
|
1029
|
+
rescue Forgejo::ApiError => e
|
1030
|
+
puts "Error when calling UserApi->user_check_following_with_http_info: #{e}"
|
1031
|
+
end
|
1032
|
+
```
|
1033
|
+
|
1034
|
+
### Parameters
|
1035
|
+
|
1036
|
+
| Name | Type | Description | Notes |
|
1037
|
+
| ---- | ---- | ----------- | ----- |
|
1038
|
+
| **username** | **String** | username of following user | |
|
1039
|
+
| **target** | **String** | username of followed user | |
|
1040
|
+
|
1041
|
+
### Return type
|
1042
|
+
|
1043
|
+
nil (empty response body)
|
1044
|
+
|
1045
|
+
### Authorization
|
1046
|
+
|
1047
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1048
|
+
|
1049
|
+
### HTTP request headers
|
1050
|
+
|
1051
|
+
- **Content-Type**: Not defined
|
1052
|
+
- **Accept**: Not defined
|
1053
|
+
|
1054
|
+
|
1055
|
+
## user_create_hook
|
1056
|
+
|
1057
|
+
> <Hook> user_create_hook(body)
|
1058
|
+
|
1059
|
+
Create a hook
|
1060
|
+
|
1061
|
+
### Examples
|
1062
|
+
|
1063
|
+
```ruby
|
1064
|
+
require 'time'
|
1065
|
+
require 'forgejo'
|
1066
|
+
# setup authorization
|
1067
|
+
Forgejo.configure do |config|
|
1068
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1069
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1070
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1071
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1072
|
+
end
|
1073
|
+
|
1074
|
+
api_instance = Forgejo::UserApi.new
|
1075
|
+
body = Forgejo::CreateHookOption.new({config: { key: 'inner_example'}, type: 'forgejo'}) # CreateHookOption |
|
1076
|
+
|
1077
|
+
begin
|
1078
|
+
# Create a hook
|
1079
|
+
result = api_instance.user_create_hook(body)
|
1080
|
+
p result
|
1081
|
+
rescue Forgejo::ApiError => e
|
1082
|
+
puts "Error when calling UserApi->user_create_hook: #{e}"
|
1083
|
+
end
|
1084
|
+
```
|
1085
|
+
|
1086
|
+
#### Using the user_create_hook_with_http_info variant
|
1087
|
+
|
1088
|
+
This returns an Array which contains the response data, status code and headers.
|
1089
|
+
|
1090
|
+
> <Array(<Hook>, Integer, Hash)> user_create_hook_with_http_info(body)
|
1091
|
+
|
1092
|
+
```ruby
|
1093
|
+
begin
|
1094
|
+
# Create a hook
|
1095
|
+
data, status_code, headers = api_instance.user_create_hook_with_http_info(body)
|
1096
|
+
p status_code # => 2xx
|
1097
|
+
p headers # => { ... }
|
1098
|
+
p data # => <Hook>
|
1099
|
+
rescue Forgejo::ApiError => e
|
1100
|
+
puts "Error when calling UserApi->user_create_hook_with_http_info: #{e}"
|
1101
|
+
end
|
1102
|
+
```
|
1103
|
+
|
1104
|
+
### Parameters
|
1105
|
+
|
1106
|
+
| Name | Type | Description | Notes |
|
1107
|
+
| ---- | ---- | ----------- | ----- |
|
1108
|
+
| **body** | [**CreateHookOption**](CreateHookOption.md) | | |
|
1109
|
+
|
1110
|
+
### Return type
|
1111
|
+
|
1112
|
+
[**Hook**](Hook.md)
|
1113
|
+
|
1114
|
+
### Authorization
|
1115
|
+
|
1116
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1117
|
+
|
1118
|
+
### HTTP request headers
|
1119
|
+
|
1120
|
+
- **Content-Type**: application/json
|
1121
|
+
- **Accept**: application/json
|
1122
|
+
|
1123
|
+
|
1124
|
+
## user_create_o_auth2_application
|
1125
|
+
|
1126
|
+
> <OAuth2Application> user_create_o_auth2_application(body)
|
1127
|
+
|
1128
|
+
creates a new OAuth2 application
|
1129
|
+
|
1130
|
+
### Examples
|
1131
|
+
|
1132
|
+
```ruby
|
1133
|
+
require 'time'
|
1134
|
+
require 'forgejo'
|
1135
|
+
# setup authorization
|
1136
|
+
Forgejo.configure do |config|
|
1137
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1138
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1139
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1140
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1141
|
+
end
|
1142
|
+
|
1143
|
+
api_instance = Forgejo::UserApi.new
|
1144
|
+
body = Forgejo::CreateOAuth2ApplicationOptions.new # CreateOAuth2ApplicationOptions |
|
1145
|
+
|
1146
|
+
begin
|
1147
|
+
# creates a new OAuth2 application
|
1148
|
+
result = api_instance.user_create_o_auth2_application(body)
|
1149
|
+
p result
|
1150
|
+
rescue Forgejo::ApiError => e
|
1151
|
+
puts "Error when calling UserApi->user_create_o_auth2_application: #{e}"
|
1152
|
+
end
|
1153
|
+
```
|
1154
|
+
|
1155
|
+
#### Using the user_create_o_auth2_application_with_http_info variant
|
1156
|
+
|
1157
|
+
This returns an Array which contains the response data, status code and headers.
|
1158
|
+
|
1159
|
+
> <Array(<OAuth2Application>, Integer, Hash)> user_create_o_auth2_application_with_http_info(body)
|
1160
|
+
|
1161
|
+
```ruby
|
1162
|
+
begin
|
1163
|
+
# creates a new OAuth2 application
|
1164
|
+
data, status_code, headers = api_instance.user_create_o_auth2_application_with_http_info(body)
|
1165
|
+
p status_code # => 2xx
|
1166
|
+
p headers # => { ... }
|
1167
|
+
p data # => <OAuth2Application>
|
1168
|
+
rescue Forgejo::ApiError => e
|
1169
|
+
puts "Error when calling UserApi->user_create_o_auth2_application_with_http_info: #{e}"
|
1170
|
+
end
|
1171
|
+
```
|
1172
|
+
|
1173
|
+
### Parameters
|
1174
|
+
|
1175
|
+
| Name | Type | Description | Notes |
|
1176
|
+
| ---- | ---- | ----------- | ----- |
|
1177
|
+
| **body** | [**CreateOAuth2ApplicationOptions**](CreateOAuth2ApplicationOptions.md) | | |
|
1178
|
+
|
1179
|
+
### Return type
|
1180
|
+
|
1181
|
+
[**OAuth2Application**](OAuth2Application.md)
|
1182
|
+
|
1183
|
+
### Authorization
|
1184
|
+
|
1185
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1186
|
+
|
1187
|
+
### HTTP request headers
|
1188
|
+
|
1189
|
+
- **Content-Type**: application/json, text/plain
|
1190
|
+
- **Accept**: application/json
|
1191
|
+
|
1192
|
+
|
1193
|
+
## user_create_token
|
1194
|
+
|
1195
|
+
> <AccessToken> user_create_token(username, opts)
|
1196
|
+
|
1197
|
+
Create an access token
|
1198
|
+
|
1199
|
+
### Examples
|
1200
|
+
|
1201
|
+
```ruby
|
1202
|
+
require 'time'
|
1203
|
+
require 'forgejo'
|
1204
|
+
# setup authorization
|
1205
|
+
Forgejo.configure do |config|
|
1206
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1207
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1208
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1209
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1210
|
+
end
|
1211
|
+
|
1212
|
+
api_instance = Forgejo::UserApi.new
|
1213
|
+
username = 'username_example' # String | username of user
|
1214
|
+
opts = {
|
1215
|
+
body: Forgejo::CreateAccessTokenOption.new({name: 'name_example'}) # CreateAccessTokenOption |
|
1216
|
+
}
|
1217
|
+
|
1218
|
+
begin
|
1219
|
+
# Create an access token
|
1220
|
+
result = api_instance.user_create_token(username, opts)
|
1221
|
+
p result
|
1222
|
+
rescue Forgejo::ApiError => e
|
1223
|
+
puts "Error when calling UserApi->user_create_token: #{e}"
|
1224
|
+
end
|
1225
|
+
```
|
1226
|
+
|
1227
|
+
#### Using the user_create_token_with_http_info variant
|
1228
|
+
|
1229
|
+
This returns an Array which contains the response data, status code and headers.
|
1230
|
+
|
1231
|
+
> <Array(<AccessToken>, Integer, Hash)> user_create_token_with_http_info(username, opts)
|
1232
|
+
|
1233
|
+
```ruby
|
1234
|
+
begin
|
1235
|
+
# Create an access token
|
1236
|
+
data, status_code, headers = api_instance.user_create_token_with_http_info(username, opts)
|
1237
|
+
p status_code # => 2xx
|
1238
|
+
p headers # => { ... }
|
1239
|
+
p data # => <AccessToken>
|
1240
|
+
rescue Forgejo::ApiError => e
|
1241
|
+
puts "Error when calling UserApi->user_create_token_with_http_info: #{e}"
|
1242
|
+
end
|
1243
|
+
```
|
1244
|
+
|
1245
|
+
### Parameters
|
1246
|
+
|
1247
|
+
| Name | Type | Description | Notes |
|
1248
|
+
| ---- | ---- | ----------- | ----- |
|
1249
|
+
| **username** | **String** | username of user | |
|
1250
|
+
| **body** | [**CreateAccessTokenOption**](CreateAccessTokenOption.md) | | [optional] |
|
1251
|
+
|
1252
|
+
### Return type
|
1253
|
+
|
1254
|
+
[**AccessToken**](AccessToken.md)
|
1255
|
+
|
1256
|
+
### Authorization
|
1257
|
+
|
1258
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1259
|
+
|
1260
|
+
### HTTP request headers
|
1261
|
+
|
1262
|
+
- **Content-Type**: application/json
|
1263
|
+
- **Accept**: application/json
|
1264
|
+
|
1265
|
+
|
1266
|
+
## user_current_check_following
|
1267
|
+
|
1268
|
+
> user_current_check_following(username)
|
1269
|
+
|
1270
|
+
Check whether a user is followed by the authenticated user
|
1271
|
+
|
1272
|
+
### Examples
|
1273
|
+
|
1274
|
+
```ruby
|
1275
|
+
require 'time'
|
1276
|
+
require 'forgejo'
|
1277
|
+
# setup authorization
|
1278
|
+
Forgejo.configure do |config|
|
1279
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1280
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1281
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1282
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1283
|
+
end
|
1284
|
+
|
1285
|
+
api_instance = Forgejo::UserApi.new
|
1286
|
+
username = 'username_example' # String | username of followed user
|
1287
|
+
|
1288
|
+
begin
|
1289
|
+
# Check whether a user is followed by the authenticated user
|
1290
|
+
api_instance.user_current_check_following(username)
|
1291
|
+
rescue Forgejo::ApiError => e
|
1292
|
+
puts "Error when calling UserApi->user_current_check_following: #{e}"
|
1293
|
+
end
|
1294
|
+
```
|
1295
|
+
|
1296
|
+
#### Using the user_current_check_following_with_http_info variant
|
1297
|
+
|
1298
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1299
|
+
|
1300
|
+
> <Array(nil, Integer, Hash)> user_current_check_following_with_http_info(username)
|
1301
|
+
|
1302
|
+
```ruby
|
1303
|
+
begin
|
1304
|
+
# Check whether a user is followed by the authenticated user
|
1305
|
+
data, status_code, headers = api_instance.user_current_check_following_with_http_info(username)
|
1306
|
+
p status_code # => 2xx
|
1307
|
+
p headers # => { ... }
|
1308
|
+
p data # => nil
|
1309
|
+
rescue Forgejo::ApiError => e
|
1310
|
+
puts "Error when calling UserApi->user_current_check_following_with_http_info: #{e}"
|
1311
|
+
end
|
1312
|
+
```
|
1313
|
+
|
1314
|
+
### Parameters
|
1315
|
+
|
1316
|
+
| Name | Type | Description | Notes |
|
1317
|
+
| ---- | ---- | ----------- | ----- |
|
1318
|
+
| **username** | **String** | username of followed user | |
|
1319
|
+
|
1320
|
+
### Return type
|
1321
|
+
|
1322
|
+
nil (empty response body)
|
1323
|
+
|
1324
|
+
### Authorization
|
1325
|
+
|
1326
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1327
|
+
|
1328
|
+
### HTTP request headers
|
1329
|
+
|
1330
|
+
- **Content-Type**: Not defined
|
1331
|
+
- **Accept**: Not defined
|
1332
|
+
|
1333
|
+
|
1334
|
+
## user_current_check_starring
|
1335
|
+
|
1336
|
+
> user_current_check_starring(owner, repo)
|
1337
|
+
|
1338
|
+
Whether the authenticated is starring the repo
|
1339
|
+
|
1340
|
+
### Examples
|
1341
|
+
|
1342
|
+
```ruby
|
1343
|
+
require 'time'
|
1344
|
+
require 'forgejo'
|
1345
|
+
# setup authorization
|
1346
|
+
Forgejo.configure do |config|
|
1347
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1348
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1349
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1350
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1351
|
+
end
|
1352
|
+
|
1353
|
+
api_instance = Forgejo::UserApi.new
|
1354
|
+
owner = 'owner_example' # String | owner of the repo
|
1355
|
+
repo = 'repo_example' # String | name of the repo
|
1356
|
+
|
1357
|
+
begin
|
1358
|
+
# Whether the authenticated is starring the repo
|
1359
|
+
api_instance.user_current_check_starring(owner, repo)
|
1360
|
+
rescue Forgejo::ApiError => e
|
1361
|
+
puts "Error when calling UserApi->user_current_check_starring: #{e}"
|
1362
|
+
end
|
1363
|
+
```
|
1364
|
+
|
1365
|
+
#### Using the user_current_check_starring_with_http_info variant
|
1366
|
+
|
1367
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1368
|
+
|
1369
|
+
> <Array(nil, Integer, Hash)> user_current_check_starring_with_http_info(owner, repo)
|
1370
|
+
|
1371
|
+
```ruby
|
1372
|
+
begin
|
1373
|
+
# Whether the authenticated is starring the repo
|
1374
|
+
data, status_code, headers = api_instance.user_current_check_starring_with_http_info(owner, repo)
|
1375
|
+
p status_code # => 2xx
|
1376
|
+
p headers # => { ... }
|
1377
|
+
p data # => nil
|
1378
|
+
rescue Forgejo::ApiError => e
|
1379
|
+
puts "Error when calling UserApi->user_current_check_starring_with_http_info: #{e}"
|
1380
|
+
end
|
1381
|
+
```
|
1382
|
+
|
1383
|
+
### Parameters
|
1384
|
+
|
1385
|
+
| Name | Type | Description | Notes |
|
1386
|
+
| ---- | ---- | ----------- | ----- |
|
1387
|
+
| **owner** | **String** | owner of the repo | |
|
1388
|
+
| **repo** | **String** | name of the repo | |
|
1389
|
+
|
1390
|
+
### Return type
|
1391
|
+
|
1392
|
+
nil (empty response body)
|
1393
|
+
|
1394
|
+
### Authorization
|
1395
|
+
|
1396
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1397
|
+
|
1398
|
+
### HTTP request headers
|
1399
|
+
|
1400
|
+
- **Content-Type**: Not defined
|
1401
|
+
- **Accept**: Not defined
|
1402
|
+
|
1403
|
+
|
1404
|
+
## user_current_delete_follow
|
1405
|
+
|
1406
|
+
> user_current_delete_follow(username)
|
1407
|
+
|
1408
|
+
Unfollow a user
|
1409
|
+
|
1410
|
+
### Examples
|
1411
|
+
|
1412
|
+
```ruby
|
1413
|
+
require 'time'
|
1414
|
+
require 'forgejo'
|
1415
|
+
# setup authorization
|
1416
|
+
Forgejo.configure do |config|
|
1417
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1418
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1420
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1421
|
+
end
|
1422
|
+
|
1423
|
+
api_instance = Forgejo::UserApi.new
|
1424
|
+
username = 'username_example' # String | username of user to unfollow
|
1425
|
+
|
1426
|
+
begin
|
1427
|
+
# Unfollow a user
|
1428
|
+
api_instance.user_current_delete_follow(username)
|
1429
|
+
rescue Forgejo::ApiError => e
|
1430
|
+
puts "Error when calling UserApi->user_current_delete_follow: #{e}"
|
1431
|
+
end
|
1432
|
+
```
|
1433
|
+
|
1434
|
+
#### Using the user_current_delete_follow_with_http_info variant
|
1435
|
+
|
1436
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1437
|
+
|
1438
|
+
> <Array(nil, Integer, Hash)> user_current_delete_follow_with_http_info(username)
|
1439
|
+
|
1440
|
+
```ruby
|
1441
|
+
begin
|
1442
|
+
# Unfollow a user
|
1443
|
+
data, status_code, headers = api_instance.user_current_delete_follow_with_http_info(username)
|
1444
|
+
p status_code # => 2xx
|
1445
|
+
p headers # => { ... }
|
1446
|
+
p data # => nil
|
1447
|
+
rescue Forgejo::ApiError => e
|
1448
|
+
puts "Error when calling UserApi->user_current_delete_follow_with_http_info: #{e}"
|
1449
|
+
end
|
1450
|
+
```
|
1451
|
+
|
1452
|
+
### Parameters
|
1453
|
+
|
1454
|
+
| Name | Type | Description | Notes |
|
1455
|
+
| ---- | ---- | ----------- | ----- |
|
1456
|
+
| **username** | **String** | username of user to unfollow | |
|
1457
|
+
|
1458
|
+
### Return type
|
1459
|
+
|
1460
|
+
nil (empty response body)
|
1461
|
+
|
1462
|
+
### Authorization
|
1463
|
+
|
1464
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1465
|
+
|
1466
|
+
### HTTP request headers
|
1467
|
+
|
1468
|
+
- **Content-Type**: Not defined
|
1469
|
+
- **Accept**: Not defined
|
1470
|
+
|
1471
|
+
|
1472
|
+
## user_current_delete_gpg_key
|
1473
|
+
|
1474
|
+
> user_current_delete_gpg_key(id)
|
1475
|
+
|
1476
|
+
Remove a GPG key
|
1477
|
+
|
1478
|
+
### Examples
|
1479
|
+
|
1480
|
+
```ruby
|
1481
|
+
require 'time'
|
1482
|
+
require 'forgejo'
|
1483
|
+
# setup authorization
|
1484
|
+
Forgejo.configure do |config|
|
1485
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1486
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1487
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1488
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1489
|
+
end
|
1490
|
+
|
1491
|
+
api_instance = Forgejo::UserApi.new
|
1492
|
+
id = 789 # Integer | id of key to delete
|
1493
|
+
|
1494
|
+
begin
|
1495
|
+
# Remove a GPG key
|
1496
|
+
api_instance.user_current_delete_gpg_key(id)
|
1497
|
+
rescue Forgejo::ApiError => e
|
1498
|
+
puts "Error when calling UserApi->user_current_delete_gpg_key: #{e}"
|
1499
|
+
end
|
1500
|
+
```
|
1501
|
+
|
1502
|
+
#### Using the user_current_delete_gpg_key_with_http_info variant
|
1503
|
+
|
1504
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1505
|
+
|
1506
|
+
> <Array(nil, Integer, Hash)> user_current_delete_gpg_key_with_http_info(id)
|
1507
|
+
|
1508
|
+
```ruby
|
1509
|
+
begin
|
1510
|
+
# Remove a GPG key
|
1511
|
+
data, status_code, headers = api_instance.user_current_delete_gpg_key_with_http_info(id)
|
1512
|
+
p status_code # => 2xx
|
1513
|
+
p headers # => { ... }
|
1514
|
+
p data # => nil
|
1515
|
+
rescue Forgejo::ApiError => e
|
1516
|
+
puts "Error when calling UserApi->user_current_delete_gpg_key_with_http_info: #{e}"
|
1517
|
+
end
|
1518
|
+
```
|
1519
|
+
|
1520
|
+
### Parameters
|
1521
|
+
|
1522
|
+
| Name | Type | Description | Notes |
|
1523
|
+
| ---- | ---- | ----------- | ----- |
|
1524
|
+
| **id** | **Integer** | id of key to delete | |
|
1525
|
+
|
1526
|
+
### Return type
|
1527
|
+
|
1528
|
+
nil (empty response body)
|
1529
|
+
|
1530
|
+
### Authorization
|
1531
|
+
|
1532
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1533
|
+
|
1534
|
+
### HTTP request headers
|
1535
|
+
|
1536
|
+
- **Content-Type**: Not defined
|
1537
|
+
- **Accept**: Not defined
|
1538
|
+
|
1539
|
+
|
1540
|
+
## user_current_delete_key
|
1541
|
+
|
1542
|
+
> user_current_delete_key(id)
|
1543
|
+
|
1544
|
+
Delete a public key
|
1545
|
+
|
1546
|
+
### Examples
|
1547
|
+
|
1548
|
+
```ruby
|
1549
|
+
require 'time'
|
1550
|
+
require 'forgejo'
|
1551
|
+
# setup authorization
|
1552
|
+
Forgejo.configure do |config|
|
1553
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1554
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1555
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1556
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1557
|
+
end
|
1558
|
+
|
1559
|
+
api_instance = Forgejo::UserApi.new
|
1560
|
+
id = 789 # Integer | id of key to delete
|
1561
|
+
|
1562
|
+
begin
|
1563
|
+
# Delete a public key
|
1564
|
+
api_instance.user_current_delete_key(id)
|
1565
|
+
rescue Forgejo::ApiError => e
|
1566
|
+
puts "Error when calling UserApi->user_current_delete_key: #{e}"
|
1567
|
+
end
|
1568
|
+
```
|
1569
|
+
|
1570
|
+
#### Using the user_current_delete_key_with_http_info variant
|
1571
|
+
|
1572
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1573
|
+
|
1574
|
+
> <Array(nil, Integer, Hash)> user_current_delete_key_with_http_info(id)
|
1575
|
+
|
1576
|
+
```ruby
|
1577
|
+
begin
|
1578
|
+
# Delete a public key
|
1579
|
+
data, status_code, headers = api_instance.user_current_delete_key_with_http_info(id)
|
1580
|
+
p status_code # => 2xx
|
1581
|
+
p headers # => { ... }
|
1582
|
+
p data # => nil
|
1583
|
+
rescue Forgejo::ApiError => e
|
1584
|
+
puts "Error when calling UserApi->user_current_delete_key_with_http_info: #{e}"
|
1585
|
+
end
|
1586
|
+
```
|
1587
|
+
|
1588
|
+
### Parameters
|
1589
|
+
|
1590
|
+
| Name | Type | Description | Notes |
|
1591
|
+
| ---- | ---- | ----------- | ----- |
|
1592
|
+
| **id** | **Integer** | id of key to delete | |
|
1593
|
+
|
1594
|
+
### Return type
|
1595
|
+
|
1596
|
+
nil (empty response body)
|
1597
|
+
|
1598
|
+
### Authorization
|
1599
|
+
|
1600
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1601
|
+
|
1602
|
+
### HTTP request headers
|
1603
|
+
|
1604
|
+
- **Content-Type**: Not defined
|
1605
|
+
- **Accept**: Not defined
|
1606
|
+
|
1607
|
+
|
1608
|
+
## user_current_delete_star
|
1609
|
+
|
1610
|
+
> user_current_delete_star(owner, repo)
|
1611
|
+
|
1612
|
+
Unstar the given repo
|
1613
|
+
|
1614
|
+
### Examples
|
1615
|
+
|
1616
|
+
```ruby
|
1617
|
+
require 'time'
|
1618
|
+
require 'forgejo'
|
1619
|
+
# setup authorization
|
1620
|
+
Forgejo.configure do |config|
|
1621
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1622
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1623
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1624
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1625
|
+
end
|
1626
|
+
|
1627
|
+
api_instance = Forgejo::UserApi.new
|
1628
|
+
owner = 'owner_example' # String | owner of the repo to unstar
|
1629
|
+
repo = 'repo_example' # String | name of the repo to unstar
|
1630
|
+
|
1631
|
+
begin
|
1632
|
+
# Unstar the given repo
|
1633
|
+
api_instance.user_current_delete_star(owner, repo)
|
1634
|
+
rescue Forgejo::ApiError => e
|
1635
|
+
puts "Error when calling UserApi->user_current_delete_star: #{e}"
|
1636
|
+
end
|
1637
|
+
```
|
1638
|
+
|
1639
|
+
#### Using the user_current_delete_star_with_http_info variant
|
1640
|
+
|
1641
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1642
|
+
|
1643
|
+
> <Array(nil, Integer, Hash)> user_current_delete_star_with_http_info(owner, repo)
|
1644
|
+
|
1645
|
+
```ruby
|
1646
|
+
begin
|
1647
|
+
# Unstar the given repo
|
1648
|
+
data, status_code, headers = api_instance.user_current_delete_star_with_http_info(owner, repo)
|
1649
|
+
p status_code # => 2xx
|
1650
|
+
p headers # => { ... }
|
1651
|
+
p data # => nil
|
1652
|
+
rescue Forgejo::ApiError => e
|
1653
|
+
puts "Error when calling UserApi->user_current_delete_star_with_http_info: #{e}"
|
1654
|
+
end
|
1655
|
+
```
|
1656
|
+
|
1657
|
+
### Parameters
|
1658
|
+
|
1659
|
+
| Name | Type | Description | Notes |
|
1660
|
+
| ---- | ---- | ----------- | ----- |
|
1661
|
+
| **owner** | **String** | owner of the repo to unstar | |
|
1662
|
+
| **repo** | **String** | name of the repo to unstar | |
|
1663
|
+
|
1664
|
+
### Return type
|
1665
|
+
|
1666
|
+
nil (empty response body)
|
1667
|
+
|
1668
|
+
### Authorization
|
1669
|
+
|
1670
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1671
|
+
|
1672
|
+
### HTTP request headers
|
1673
|
+
|
1674
|
+
- **Content-Type**: Not defined
|
1675
|
+
- **Accept**: Not defined
|
1676
|
+
|
1677
|
+
|
1678
|
+
## user_current_get_gpg_key
|
1679
|
+
|
1680
|
+
> <GPGKey> user_current_get_gpg_key(id)
|
1681
|
+
|
1682
|
+
Get a GPG key
|
1683
|
+
|
1684
|
+
### Examples
|
1685
|
+
|
1686
|
+
```ruby
|
1687
|
+
require 'time'
|
1688
|
+
require 'forgejo'
|
1689
|
+
# setup authorization
|
1690
|
+
Forgejo.configure do |config|
|
1691
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1692
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1693
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1694
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1695
|
+
end
|
1696
|
+
|
1697
|
+
api_instance = Forgejo::UserApi.new
|
1698
|
+
id = 789 # Integer | id of key to get
|
1699
|
+
|
1700
|
+
begin
|
1701
|
+
# Get a GPG key
|
1702
|
+
result = api_instance.user_current_get_gpg_key(id)
|
1703
|
+
p result
|
1704
|
+
rescue Forgejo::ApiError => e
|
1705
|
+
puts "Error when calling UserApi->user_current_get_gpg_key: #{e}"
|
1706
|
+
end
|
1707
|
+
```
|
1708
|
+
|
1709
|
+
#### Using the user_current_get_gpg_key_with_http_info variant
|
1710
|
+
|
1711
|
+
This returns an Array which contains the response data, status code and headers.
|
1712
|
+
|
1713
|
+
> <Array(<GPGKey>, Integer, Hash)> user_current_get_gpg_key_with_http_info(id)
|
1714
|
+
|
1715
|
+
```ruby
|
1716
|
+
begin
|
1717
|
+
# Get a GPG key
|
1718
|
+
data, status_code, headers = api_instance.user_current_get_gpg_key_with_http_info(id)
|
1719
|
+
p status_code # => 2xx
|
1720
|
+
p headers # => { ... }
|
1721
|
+
p data # => <GPGKey>
|
1722
|
+
rescue Forgejo::ApiError => e
|
1723
|
+
puts "Error when calling UserApi->user_current_get_gpg_key_with_http_info: #{e}"
|
1724
|
+
end
|
1725
|
+
```
|
1726
|
+
|
1727
|
+
### Parameters
|
1728
|
+
|
1729
|
+
| Name | Type | Description | Notes |
|
1730
|
+
| ---- | ---- | ----------- | ----- |
|
1731
|
+
| **id** | **Integer** | id of key to get | |
|
1732
|
+
|
1733
|
+
### Return type
|
1734
|
+
|
1735
|
+
[**GPGKey**](GPGKey.md)
|
1736
|
+
|
1737
|
+
### Authorization
|
1738
|
+
|
1739
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1740
|
+
|
1741
|
+
### HTTP request headers
|
1742
|
+
|
1743
|
+
- **Content-Type**: Not defined
|
1744
|
+
- **Accept**: application/json
|
1745
|
+
|
1746
|
+
|
1747
|
+
## user_current_get_key
|
1748
|
+
|
1749
|
+
> <PublicKey> user_current_get_key(id)
|
1750
|
+
|
1751
|
+
Get a public key
|
1752
|
+
|
1753
|
+
### Examples
|
1754
|
+
|
1755
|
+
```ruby
|
1756
|
+
require 'time'
|
1757
|
+
require 'forgejo'
|
1758
|
+
# setup authorization
|
1759
|
+
Forgejo.configure do |config|
|
1760
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1761
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1762
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1763
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1764
|
+
end
|
1765
|
+
|
1766
|
+
api_instance = Forgejo::UserApi.new
|
1767
|
+
id = 789 # Integer | id of key to get
|
1768
|
+
|
1769
|
+
begin
|
1770
|
+
# Get a public key
|
1771
|
+
result = api_instance.user_current_get_key(id)
|
1772
|
+
p result
|
1773
|
+
rescue Forgejo::ApiError => e
|
1774
|
+
puts "Error when calling UserApi->user_current_get_key: #{e}"
|
1775
|
+
end
|
1776
|
+
```
|
1777
|
+
|
1778
|
+
#### Using the user_current_get_key_with_http_info variant
|
1779
|
+
|
1780
|
+
This returns an Array which contains the response data, status code and headers.
|
1781
|
+
|
1782
|
+
> <Array(<PublicKey>, Integer, Hash)> user_current_get_key_with_http_info(id)
|
1783
|
+
|
1784
|
+
```ruby
|
1785
|
+
begin
|
1786
|
+
# Get a public key
|
1787
|
+
data, status_code, headers = api_instance.user_current_get_key_with_http_info(id)
|
1788
|
+
p status_code # => 2xx
|
1789
|
+
p headers # => { ... }
|
1790
|
+
p data # => <PublicKey>
|
1791
|
+
rescue Forgejo::ApiError => e
|
1792
|
+
puts "Error when calling UserApi->user_current_get_key_with_http_info: #{e}"
|
1793
|
+
end
|
1794
|
+
```
|
1795
|
+
|
1796
|
+
### Parameters
|
1797
|
+
|
1798
|
+
| Name | Type | Description | Notes |
|
1799
|
+
| ---- | ---- | ----------- | ----- |
|
1800
|
+
| **id** | **Integer** | id of key to get | |
|
1801
|
+
|
1802
|
+
### Return type
|
1803
|
+
|
1804
|
+
[**PublicKey**](PublicKey.md)
|
1805
|
+
|
1806
|
+
### Authorization
|
1807
|
+
|
1808
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1809
|
+
|
1810
|
+
### HTTP request headers
|
1811
|
+
|
1812
|
+
- **Content-Type**: Not defined
|
1813
|
+
- **Accept**: application/json
|
1814
|
+
|
1815
|
+
|
1816
|
+
## user_current_list_followers
|
1817
|
+
|
1818
|
+
> <Array<User>> user_current_list_followers(opts)
|
1819
|
+
|
1820
|
+
List the authenticated user's followers
|
1821
|
+
|
1822
|
+
### Examples
|
1823
|
+
|
1824
|
+
```ruby
|
1825
|
+
require 'time'
|
1826
|
+
require 'forgejo'
|
1827
|
+
# setup authorization
|
1828
|
+
Forgejo.configure do |config|
|
1829
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1830
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1831
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1832
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1833
|
+
end
|
1834
|
+
|
1835
|
+
api_instance = Forgejo::UserApi.new
|
1836
|
+
opts = {
|
1837
|
+
page: 56, # Integer | page number of results to return (1-based)
|
1838
|
+
limit: 56 # Integer | page size of results
|
1839
|
+
}
|
1840
|
+
|
1841
|
+
begin
|
1842
|
+
# List the authenticated user's followers
|
1843
|
+
result = api_instance.user_current_list_followers(opts)
|
1844
|
+
p result
|
1845
|
+
rescue Forgejo::ApiError => e
|
1846
|
+
puts "Error when calling UserApi->user_current_list_followers: #{e}"
|
1847
|
+
end
|
1848
|
+
```
|
1849
|
+
|
1850
|
+
#### Using the user_current_list_followers_with_http_info variant
|
1851
|
+
|
1852
|
+
This returns an Array which contains the response data, status code and headers.
|
1853
|
+
|
1854
|
+
> <Array(<Array<User>>, Integer, Hash)> user_current_list_followers_with_http_info(opts)
|
1855
|
+
|
1856
|
+
```ruby
|
1857
|
+
begin
|
1858
|
+
# List the authenticated user's followers
|
1859
|
+
data, status_code, headers = api_instance.user_current_list_followers_with_http_info(opts)
|
1860
|
+
p status_code # => 2xx
|
1861
|
+
p headers # => { ... }
|
1862
|
+
p data # => <Array<User>>
|
1863
|
+
rescue Forgejo::ApiError => e
|
1864
|
+
puts "Error when calling UserApi->user_current_list_followers_with_http_info: #{e}"
|
1865
|
+
end
|
1866
|
+
```
|
1867
|
+
|
1868
|
+
### Parameters
|
1869
|
+
|
1870
|
+
| Name | Type | Description | Notes |
|
1871
|
+
| ---- | ---- | ----------- | ----- |
|
1872
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
1873
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
1874
|
+
|
1875
|
+
### Return type
|
1876
|
+
|
1877
|
+
[**Array<User>**](User.md)
|
1878
|
+
|
1879
|
+
### Authorization
|
1880
|
+
|
1881
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1882
|
+
|
1883
|
+
### HTTP request headers
|
1884
|
+
|
1885
|
+
- **Content-Type**: Not defined
|
1886
|
+
- **Accept**: application/json
|
1887
|
+
|
1888
|
+
|
1889
|
+
## user_current_list_following
|
1890
|
+
|
1891
|
+
> <Array<User>> user_current_list_following(opts)
|
1892
|
+
|
1893
|
+
List the users that the authenticated user is following
|
1894
|
+
|
1895
|
+
### Examples
|
1896
|
+
|
1897
|
+
```ruby
|
1898
|
+
require 'time'
|
1899
|
+
require 'forgejo'
|
1900
|
+
# setup authorization
|
1901
|
+
Forgejo.configure do |config|
|
1902
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1903
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1904
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1905
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1906
|
+
end
|
1907
|
+
|
1908
|
+
api_instance = Forgejo::UserApi.new
|
1909
|
+
opts = {
|
1910
|
+
page: 56, # Integer | page number of results to return (1-based)
|
1911
|
+
limit: 56 # Integer | page size of results
|
1912
|
+
}
|
1913
|
+
|
1914
|
+
begin
|
1915
|
+
# List the users that the authenticated user is following
|
1916
|
+
result = api_instance.user_current_list_following(opts)
|
1917
|
+
p result
|
1918
|
+
rescue Forgejo::ApiError => e
|
1919
|
+
puts "Error when calling UserApi->user_current_list_following: #{e}"
|
1920
|
+
end
|
1921
|
+
```
|
1922
|
+
|
1923
|
+
#### Using the user_current_list_following_with_http_info variant
|
1924
|
+
|
1925
|
+
This returns an Array which contains the response data, status code and headers.
|
1926
|
+
|
1927
|
+
> <Array(<Array<User>>, Integer, Hash)> user_current_list_following_with_http_info(opts)
|
1928
|
+
|
1929
|
+
```ruby
|
1930
|
+
begin
|
1931
|
+
# List the users that the authenticated user is following
|
1932
|
+
data, status_code, headers = api_instance.user_current_list_following_with_http_info(opts)
|
1933
|
+
p status_code # => 2xx
|
1934
|
+
p headers # => { ... }
|
1935
|
+
p data # => <Array<User>>
|
1936
|
+
rescue Forgejo::ApiError => e
|
1937
|
+
puts "Error when calling UserApi->user_current_list_following_with_http_info: #{e}"
|
1938
|
+
end
|
1939
|
+
```
|
1940
|
+
|
1941
|
+
### Parameters
|
1942
|
+
|
1943
|
+
| Name | Type | Description | Notes |
|
1944
|
+
| ---- | ---- | ----------- | ----- |
|
1945
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
1946
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
1947
|
+
|
1948
|
+
### Return type
|
1949
|
+
|
1950
|
+
[**Array<User>**](User.md)
|
1951
|
+
|
1952
|
+
### Authorization
|
1953
|
+
|
1954
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
1955
|
+
|
1956
|
+
### HTTP request headers
|
1957
|
+
|
1958
|
+
- **Content-Type**: Not defined
|
1959
|
+
- **Accept**: application/json
|
1960
|
+
|
1961
|
+
|
1962
|
+
## user_current_list_gpg_keys
|
1963
|
+
|
1964
|
+
> <Array<GPGKey>> user_current_list_gpg_keys(opts)
|
1965
|
+
|
1966
|
+
List the authenticated user's GPG keys
|
1967
|
+
|
1968
|
+
### Examples
|
1969
|
+
|
1970
|
+
```ruby
|
1971
|
+
require 'time'
|
1972
|
+
require 'forgejo'
|
1973
|
+
# setup authorization
|
1974
|
+
Forgejo.configure do |config|
|
1975
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
1976
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1977
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1978
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1979
|
+
end
|
1980
|
+
|
1981
|
+
api_instance = Forgejo::UserApi.new
|
1982
|
+
opts = {
|
1983
|
+
page: 56, # Integer | page number of results to return (1-based)
|
1984
|
+
limit: 56 # Integer | page size of results
|
1985
|
+
}
|
1986
|
+
|
1987
|
+
begin
|
1988
|
+
# List the authenticated user's GPG keys
|
1989
|
+
result = api_instance.user_current_list_gpg_keys(opts)
|
1990
|
+
p result
|
1991
|
+
rescue Forgejo::ApiError => e
|
1992
|
+
puts "Error when calling UserApi->user_current_list_gpg_keys: #{e}"
|
1993
|
+
end
|
1994
|
+
```
|
1995
|
+
|
1996
|
+
#### Using the user_current_list_gpg_keys_with_http_info variant
|
1997
|
+
|
1998
|
+
This returns an Array which contains the response data, status code and headers.
|
1999
|
+
|
2000
|
+
> <Array(<Array<GPGKey>>, Integer, Hash)> user_current_list_gpg_keys_with_http_info(opts)
|
2001
|
+
|
2002
|
+
```ruby
|
2003
|
+
begin
|
2004
|
+
# List the authenticated user's GPG keys
|
2005
|
+
data, status_code, headers = api_instance.user_current_list_gpg_keys_with_http_info(opts)
|
2006
|
+
p status_code # => 2xx
|
2007
|
+
p headers # => { ... }
|
2008
|
+
p data # => <Array<GPGKey>>
|
2009
|
+
rescue Forgejo::ApiError => e
|
2010
|
+
puts "Error when calling UserApi->user_current_list_gpg_keys_with_http_info: #{e}"
|
2011
|
+
end
|
2012
|
+
```
|
2013
|
+
|
2014
|
+
### Parameters
|
2015
|
+
|
2016
|
+
| Name | Type | Description | Notes |
|
2017
|
+
| ---- | ---- | ----------- | ----- |
|
2018
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2019
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2020
|
+
|
2021
|
+
### Return type
|
2022
|
+
|
2023
|
+
[**Array<GPGKey>**](GPGKey.md)
|
2024
|
+
|
2025
|
+
### Authorization
|
2026
|
+
|
2027
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2028
|
+
|
2029
|
+
### HTTP request headers
|
2030
|
+
|
2031
|
+
- **Content-Type**: Not defined
|
2032
|
+
- **Accept**: application/json
|
2033
|
+
|
2034
|
+
|
2035
|
+
## user_current_list_keys
|
2036
|
+
|
2037
|
+
> <Array<PublicKey>> user_current_list_keys(opts)
|
2038
|
+
|
2039
|
+
List the authenticated user's public keys
|
2040
|
+
|
2041
|
+
### Examples
|
2042
|
+
|
2043
|
+
```ruby
|
2044
|
+
require 'time'
|
2045
|
+
require 'forgejo'
|
2046
|
+
# setup authorization
|
2047
|
+
Forgejo.configure do |config|
|
2048
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2049
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2050
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2051
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2052
|
+
end
|
2053
|
+
|
2054
|
+
api_instance = Forgejo::UserApi.new
|
2055
|
+
opts = {
|
2056
|
+
fingerprint: 'fingerprint_example', # String | fingerprint of the key
|
2057
|
+
page: 56, # Integer | page number of results to return (1-based)
|
2058
|
+
limit: 56 # Integer | page size of results
|
2059
|
+
}
|
2060
|
+
|
2061
|
+
begin
|
2062
|
+
# List the authenticated user's public keys
|
2063
|
+
result = api_instance.user_current_list_keys(opts)
|
2064
|
+
p result
|
2065
|
+
rescue Forgejo::ApiError => e
|
2066
|
+
puts "Error when calling UserApi->user_current_list_keys: #{e}"
|
2067
|
+
end
|
2068
|
+
```
|
2069
|
+
|
2070
|
+
#### Using the user_current_list_keys_with_http_info variant
|
2071
|
+
|
2072
|
+
This returns an Array which contains the response data, status code and headers.
|
2073
|
+
|
2074
|
+
> <Array(<Array<PublicKey>>, Integer, Hash)> user_current_list_keys_with_http_info(opts)
|
2075
|
+
|
2076
|
+
```ruby
|
2077
|
+
begin
|
2078
|
+
# List the authenticated user's public keys
|
2079
|
+
data, status_code, headers = api_instance.user_current_list_keys_with_http_info(opts)
|
2080
|
+
p status_code # => 2xx
|
2081
|
+
p headers # => { ... }
|
2082
|
+
p data # => <Array<PublicKey>>
|
2083
|
+
rescue Forgejo::ApiError => e
|
2084
|
+
puts "Error when calling UserApi->user_current_list_keys_with_http_info: #{e}"
|
2085
|
+
end
|
2086
|
+
```
|
2087
|
+
|
2088
|
+
### Parameters
|
2089
|
+
|
2090
|
+
| Name | Type | Description | Notes |
|
2091
|
+
| ---- | ---- | ----------- | ----- |
|
2092
|
+
| **fingerprint** | **String** | fingerprint of the key | [optional] |
|
2093
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2094
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2095
|
+
|
2096
|
+
### Return type
|
2097
|
+
|
2098
|
+
[**Array<PublicKey>**](PublicKey.md)
|
2099
|
+
|
2100
|
+
### Authorization
|
2101
|
+
|
2102
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2103
|
+
|
2104
|
+
### HTTP request headers
|
2105
|
+
|
2106
|
+
- **Content-Type**: Not defined
|
2107
|
+
- **Accept**: application/json
|
2108
|
+
|
2109
|
+
|
2110
|
+
## user_current_list_repos
|
2111
|
+
|
2112
|
+
> <Array<Repository>> user_current_list_repos(opts)
|
2113
|
+
|
2114
|
+
List the repos that the authenticated user owns
|
2115
|
+
|
2116
|
+
### Examples
|
2117
|
+
|
2118
|
+
```ruby
|
2119
|
+
require 'time'
|
2120
|
+
require 'forgejo'
|
2121
|
+
# setup authorization
|
2122
|
+
Forgejo.configure do |config|
|
2123
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2124
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2125
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2126
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2127
|
+
end
|
2128
|
+
|
2129
|
+
api_instance = Forgejo::UserApi.new
|
2130
|
+
opts = {
|
2131
|
+
page: 56, # Integer | page number of results to return (1-based)
|
2132
|
+
limit: 56 # Integer | page size of results
|
2133
|
+
}
|
2134
|
+
|
2135
|
+
begin
|
2136
|
+
# List the repos that the authenticated user owns
|
2137
|
+
result = api_instance.user_current_list_repos(opts)
|
2138
|
+
p result
|
2139
|
+
rescue Forgejo::ApiError => e
|
2140
|
+
puts "Error when calling UserApi->user_current_list_repos: #{e}"
|
2141
|
+
end
|
2142
|
+
```
|
2143
|
+
|
2144
|
+
#### Using the user_current_list_repos_with_http_info variant
|
2145
|
+
|
2146
|
+
This returns an Array which contains the response data, status code and headers.
|
2147
|
+
|
2148
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_current_list_repos_with_http_info(opts)
|
2149
|
+
|
2150
|
+
```ruby
|
2151
|
+
begin
|
2152
|
+
# List the repos that the authenticated user owns
|
2153
|
+
data, status_code, headers = api_instance.user_current_list_repos_with_http_info(opts)
|
2154
|
+
p status_code # => 2xx
|
2155
|
+
p headers # => { ... }
|
2156
|
+
p data # => <Array<Repository>>
|
2157
|
+
rescue Forgejo::ApiError => e
|
2158
|
+
puts "Error when calling UserApi->user_current_list_repos_with_http_info: #{e}"
|
2159
|
+
end
|
2160
|
+
```
|
2161
|
+
|
2162
|
+
### Parameters
|
2163
|
+
|
2164
|
+
| Name | Type | Description | Notes |
|
2165
|
+
| ---- | ---- | ----------- | ----- |
|
2166
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2167
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2168
|
+
|
2169
|
+
### Return type
|
2170
|
+
|
2171
|
+
[**Array<Repository>**](Repository.md)
|
2172
|
+
|
2173
|
+
### Authorization
|
2174
|
+
|
2175
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2176
|
+
|
2177
|
+
### HTTP request headers
|
2178
|
+
|
2179
|
+
- **Content-Type**: Not defined
|
2180
|
+
- **Accept**: application/json
|
2181
|
+
|
2182
|
+
|
2183
|
+
## user_current_list_starred
|
2184
|
+
|
2185
|
+
> <Array<Repository>> user_current_list_starred(opts)
|
2186
|
+
|
2187
|
+
The repos that the authenticated user has starred
|
2188
|
+
|
2189
|
+
### Examples
|
2190
|
+
|
2191
|
+
```ruby
|
2192
|
+
require 'time'
|
2193
|
+
require 'forgejo'
|
2194
|
+
# setup authorization
|
2195
|
+
Forgejo.configure do |config|
|
2196
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2197
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2198
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2199
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2200
|
+
end
|
2201
|
+
|
2202
|
+
api_instance = Forgejo::UserApi.new
|
2203
|
+
opts = {
|
2204
|
+
page: 56, # Integer | page number of results to return (1-based)
|
2205
|
+
limit: 56 # Integer | page size of results
|
2206
|
+
}
|
2207
|
+
|
2208
|
+
begin
|
2209
|
+
# The repos that the authenticated user has starred
|
2210
|
+
result = api_instance.user_current_list_starred(opts)
|
2211
|
+
p result
|
2212
|
+
rescue Forgejo::ApiError => e
|
2213
|
+
puts "Error when calling UserApi->user_current_list_starred: #{e}"
|
2214
|
+
end
|
2215
|
+
```
|
2216
|
+
|
2217
|
+
#### Using the user_current_list_starred_with_http_info variant
|
2218
|
+
|
2219
|
+
This returns an Array which contains the response data, status code and headers.
|
2220
|
+
|
2221
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_current_list_starred_with_http_info(opts)
|
2222
|
+
|
2223
|
+
```ruby
|
2224
|
+
begin
|
2225
|
+
# The repos that the authenticated user has starred
|
2226
|
+
data, status_code, headers = api_instance.user_current_list_starred_with_http_info(opts)
|
2227
|
+
p status_code # => 2xx
|
2228
|
+
p headers # => { ... }
|
2229
|
+
p data # => <Array<Repository>>
|
2230
|
+
rescue Forgejo::ApiError => e
|
2231
|
+
puts "Error when calling UserApi->user_current_list_starred_with_http_info: #{e}"
|
2232
|
+
end
|
2233
|
+
```
|
2234
|
+
|
2235
|
+
### Parameters
|
2236
|
+
|
2237
|
+
| Name | Type | Description | Notes |
|
2238
|
+
| ---- | ---- | ----------- | ----- |
|
2239
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2240
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2241
|
+
|
2242
|
+
### Return type
|
2243
|
+
|
2244
|
+
[**Array<Repository>**](Repository.md)
|
2245
|
+
|
2246
|
+
### Authorization
|
2247
|
+
|
2248
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2249
|
+
|
2250
|
+
### HTTP request headers
|
2251
|
+
|
2252
|
+
- **Content-Type**: Not defined
|
2253
|
+
- **Accept**: application/json
|
2254
|
+
|
2255
|
+
|
2256
|
+
## user_current_list_subscriptions
|
2257
|
+
|
2258
|
+
> <Array<Repository>> user_current_list_subscriptions(opts)
|
2259
|
+
|
2260
|
+
List repositories watched by the authenticated user
|
2261
|
+
|
2262
|
+
### Examples
|
2263
|
+
|
2264
|
+
```ruby
|
2265
|
+
require 'time'
|
2266
|
+
require 'forgejo'
|
2267
|
+
# setup authorization
|
2268
|
+
Forgejo.configure do |config|
|
2269
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2270
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2271
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2272
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2273
|
+
end
|
2274
|
+
|
2275
|
+
api_instance = Forgejo::UserApi.new
|
2276
|
+
opts = {
|
2277
|
+
page: 56, # Integer | page number of results to return (1-based)
|
2278
|
+
limit: 56 # Integer | page size of results
|
2279
|
+
}
|
2280
|
+
|
2281
|
+
begin
|
2282
|
+
# List repositories watched by the authenticated user
|
2283
|
+
result = api_instance.user_current_list_subscriptions(opts)
|
2284
|
+
p result
|
2285
|
+
rescue Forgejo::ApiError => e
|
2286
|
+
puts "Error when calling UserApi->user_current_list_subscriptions: #{e}"
|
2287
|
+
end
|
2288
|
+
```
|
2289
|
+
|
2290
|
+
#### Using the user_current_list_subscriptions_with_http_info variant
|
2291
|
+
|
2292
|
+
This returns an Array which contains the response data, status code and headers.
|
2293
|
+
|
2294
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_current_list_subscriptions_with_http_info(opts)
|
2295
|
+
|
2296
|
+
```ruby
|
2297
|
+
begin
|
2298
|
+
# List repositories watched by the authenticated user
|
2299
|
+
data, status_code, headers = api_instance.user_current_list_subscriptions_with_http_info(opts)
|
2300
|
+
p status_code # => 2xx
|
2301
|
+
p headers # => { ... }
|
2302
|
+
p data # => <Array<Repository>>
|
2303
|
+
rescue Forgejo::ApiError => e
|
2304
|
+
puts "Error when calling UserApi->user_current_list_subscriptions_with_http_info: #{e}"
|
2305
|
+
end
|
2306
|
+
```
|
2307
|
+
|
2308
|
+
### Parameters
|
2309
|
+
|
2310
|
+
| Name | Type | Description | Notes |
|
2311
|
+
| ---- | ---- | ----------- | ----- |
|
2312
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2313
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2314
|
+
|
2315
|
+
### Return type
|
2316
|
+
|
2317
|
+
[**Array<Repository>**](Repository.md)
|
2318
|
+
|
2319
|
+
### Authorization
|
2320
|
+
|
2321
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2322
|
+
|
2323
|
+
### HTTP request headers
|
2324
|
+
|
2325
|
+
- **Content-Type**: Not defined
|
2326
|
+
- **Accept**: application/json
|
2327
|
+
|
2328
|
+
|
2329
|
+
## user_current_post_gpg_key
|
2330
|
+
|
2331
|
+
> <GPGKey> user_current_post_gpg_key(opts)
|
2332
|
+
|
2333
|
+
Create a GPG key
|
2334
|
+
|
2335
|
+
### Examples
|
2336
|
+
|
2337
|
+
```ruby
|
2338
|
+
require 'time'
|
2339
|
+
require 'forgejo'
|
2340
|
+
# setup authorization
|
2341
|
+
Forgejo.configure do |config|
|
2342
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2343
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2344
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2345
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2346
|
+
end
|
2347
|
+
|
2348
|
+
api_instance = Forgejo::UserApi.new
|
2349
|
+
opts = {
|
2350
|
+
form: Forgejo::CreateGPGKeyOption.new({armored_public_key: 'armored_public_key_example'}) # CreateGPGKeyOption |
|
2351
|
+
}
|
2352
|
+
|
2353
|
+
begin
|
2354
|
+
# Create a GPG key
|
2355
|
+
result = api_instance.user_current_post_gpg_key(opts)
|
2356
|
+
p result
|
2357
|
+
rescue Forgejo::ApiError => e
|
2358
|
+
puts "Error when calling UserApi->user_current_post_gpg_key: #{e}"
|
2359
|
+
end
|
2360
|
+
```
|
2361
|
+
|
2362
|
+
#### Using the user_current_post_gpg_key_with_http_info variant
|
2363
|
+
|
2364
|
+
This returns an Array which contains the response data, status code and headers.
|
2365
|
+
|
2366
|
+
> <Array(<GPGKey>, Integer, Hash)> user_current_post_gpg_key_with_http_info(opts)
|
2367
|
+
|
2368
|
+
```ruby
|
2369
|
+
begin
|
2370
|
+
# Create a GPG key
|
2371
|
+
data, status_code, headers = api_instance.user_current_post_gpg_key_with_http_info(opts)
|
2372
|
+
p status_code # => 2xx
|
2373
|
+
p headers # => { ... }
|
2374
|
+
p data # => <GPGKey>
|
2375
|
+
rescue Forgejo::ApiError => e
|
2376
|
+
puts "Error when calling UserApi->user_current_post_gpg_key_with_http_info: #{e}"
|
2377
|
+
end
|
2378
|
+
```
|
2379
|
+
|
2380
|
+
### Parameters
|
2381
|
+
|
2382
|
+
| Name | Type | Description | Notes |
|
2383
|
+
| ---- | ---- | ----------- | ----- |
|
2384
|
+
| **form** | [**CreateGPGKeyOption**](CreateGPGKeyOption.md) | | [optional] |
|
2385
|
+
|
2386
|
+
### Return type
|
2387
|
+
|
2388
|
+
[**GPGKey**](GPGKey.md)
|
2389
|
+
|
2390
|
+
### Authorization
|
2391
|
+
|
2392
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2393
|
+
|
2394
|
+
### HTTP request headers
|
2395
|
+
|
2396
|
+
- **Content-Type**: application/json
|
2397
|
+
- **Accept**: application/json
|
2398
|
+
|
2399
|
+
|
2400
|
+
## user_current_post_key
|
2401
|
+
|
2402
|
+
> <PublicKey> user_current_post_key(opts)
|
2403
|
+
|
2404
|
+
Create a public key
|
2405
|
+
|
2406
|
+
### Examples
|
2407
|
+
|
2408
|
+
```ruby
|
2409
|
+
require 'time'
|
2410
|
+
require 'forgejo'
|
2411
|
+
# setup authorization
|
2412
|
+
Forgejo.configure do |config|
|
2413
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2414
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2415
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2416
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2417
|
+
end
|
2418
|
+
|
2419
|
+
api_instance = Forgejo::UserApi.new
|
2420
|
+
opts = {
|
2421
|
+
body: Forgejo::CreateKeyOption.new({key: 'key_example', title: 'title_example'}) # CreateKeyOption |
|
2422
|
+
}
|
2423
|
+
|
2424
|
+
begin
|
2425
|
+
# Create a public key
|
2426
|
+
result = api_instance.user_current_post_key(opts)
|
2427
|
+
p result
|
2428
|
+
rescue Forgejo::ApiError => e
|
2429
|
+
puts "Error when calling UserApi->user_current_post_key: #{e}"
|
2430
|
+
end
|
2431
|
+
```
|
2432
|
+
|
2433
|
+
#### Using the user_current_post_key_with_http_info variant
|
2434
|
+
|
2435
|
+
This returns an Array which contains the response data, status code and headers.
|
2436
|
+
|
2437
|
+
> <Array(<PublicKey>, Integer, Hash)> user_current_post_key_with_http_info(opts)
|
2438
|
+
|
2439
|
+
```ruby
|
2440
|
+
begin
|
2441
|
+
# Create a public key
|
2442
|
+
data, status_code, headers = api_instance.user_current_post_key_with_http_info(opts)
|
2443
|
+
p status_code # => 2xx
|
2444
|
+
p headers # => { ... }
|
2445
|
+
p data # => <PublicKey>
|
2446
|
+
rescue Forgejo::ApiError => e
|
2447
|
+
puts "Error when calling UserApi->user_current_post_key_with_http_info: #{e}"
|
2448
|
+
end
|
2449
|
+
```
|
2450
|
+
|
2451
|
+
### Parameters
|
2452
|
+
|
2453
|
+
| Name | Type | Description | Notes |
|
2454
|
+
| ---- | ---- | ----------- | ----- |
|
2455
|
+
| **body** | [**CreateKeyOption**](CreateKeyOption.md) | | [optional] |
|
2456
|
+
|
2457
|
+
### Return type
|
2458
|
+
|
2459
|
+
[**PublicKey**](PublicKey.md)
|
2460
|
+
|
2461
|
+
### Authorization
|
2462
|
+
|
2463
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2464
|
+
|
2465
|
+
### HTTP request headers
|
2466
|
+
|
2467
|
+
- **Content-Type**: application/json
|
2468
|
+
- **Accept**: application/json
|
2469
|
+
|
2470
|
+
|
2471
|
+
## user_current_put_follow
|
2472
|
+
|
2473
|
+
> user_current_put_follow(username)
|
2474
|
+
|
2475
|
+
Follow a user
|
2476
|
+
|
2477
|
+
### Examples
|
2478
|
+
|
2479
|
+
```ruby
|
2480
|
+
require 'time'
|
2481
|
+
require 'forgejo'
|
2482
|
+
# setup authorization
|
2483
|
+
Forgejo.configure do |config|
|
2484
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2485
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2486
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2487
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2488
|
+
end
|
2489
|
+
|
2490
|
+
api_instance = Forgejo::UserApi.new
|
2491
|
+
username = 'username_example' # String | username of user to follow
|
2492
|
+
|
2493
|
+
begin
|
2494
|
+
# Follow a user
|
2495
|
+
api_instance.user_current_put_follow(username)
|
2496
|
+
rescue Forgejo::ApiError => e
|
2497
|
+
puts "Error when calling UserApi->user_current_put_follow: #{e}"
|
2498
|
+
end
|
2499
|
+
```
|
2500
|
+
|
2501
|
+
#### Using the user_current_put_follow_with_http_info variant
|
2502
|
+
|
2503
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2504
|
+
|
2505
|
+
> <Array(nil, Integer, Hash)> user_current_put_follow_with_http_info(username)
|
2506
|
+
|
2507
|
+
```ruby
|
2508
|
+
begin
|
2509
|
+
# Follow a user
|
2510
|
+
data, status_code, headers = api_instance.user_current_put_follow_with_http_info(username)
|
2511
|
+
p status_code # => 2xx
|
2512
|
+
p headers # => { ... }
|
2513
|
+
p data # => nil
|
2514
|
+
rescue Forgejo::ApiError => e
|
2515
|
+
puts "Error when calling UserApi->user_current_put_follow_with_http_info: #{e}"
|
2516
|
+
end
|
2517
|
+
```
|
2518
|
+
|
2519
|
+
### Parameters
|
2520
|
+
|
2521
|
+
| Name | Type | Description | Notes |
|
2522
|
+
| ---- | ---- | ----------- | ----- |
|
2523
|
+
| **username** | **String** | username of user to follow | |
|
2524
|
+
|
2525
|
+
### Return type
|
2526
|
+
|
2527
|
+
nil (empty response body)
|
2528
|
+
|
2529
|
+
### Authorization
|
2530
|
+
|
2531
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2532
|
+
|
2533
|
+
### HTTP request headers
|
2534
|
+
|
2535
|
+
- **Content-Type**: Not defined
|
2536
|
+
- **Accept**: Not defined
|
2537
|
+
|
2538
|
+
|
2539
|
+
## user_current_put_star
|
2540
|
+
|
2541
|
+
> user_current_put_star(owner, repo)
|
2542
|
+
|
2543
|
+
Star the given repo
|
2544
|
+
|
2545
|
+
### Examples
|
2546
|
+
|
2547
|
+
```ruby
|
2548
|
+
require 'time'
|
2549
|
+
require 'forgejo'
|
2550
|
+
# setup authorization
|
2551
|
+
Forgejo.configure do |config|
|
2552
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2553
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2554
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2555
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2556
|
+
end
|
2557
|
+
|
2558
|
+
api_instance = Forgejo::UserApi.new
|
2559
|
+
owner = 'owner_example' # String | owner of the repo to star
|
2560
|
+
repo = 'repo_example' # String | name of the repo to star
|
2561
|
+
|
2562
|
+
begin
|
2563
|
+
# Star the given repo
|
2564
|
+
api_instance.user_current_put_star(owner, repo)
|
2565
|
+
rescue Forgejo::ApiError => e
|
2566
|
+
puts "Error when calling UserApi->user_current_put_star: #{e}"
|
2567
|
+
end
|
2568
|
+
```
|
2569
|
+
|
2570
|
+
#### Using the user_current_put_star_with_http_info variant
|
2571
|
+
|
2572
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2573
|
+
|
2574
|
+
> <Array(nil, Integer, Hash)> user_current_put_star_with_http_info(owner, repo)
|
2575
|
+
|
2576
|
+
```ruby
|
2577
|
+
begin
|
2578
|
+
# Star the given repo
|
2579
|
+
data, status_code, headers = api_instance.user_current_put_star_with_http_info(owner, repo)
|
2580
|
+
p status_code # => 2xx
|
2581
|
+
p headers # => { ... }
|
2582
|
+
p data # => nil
|
2583
|
+
rescue Forgejo::ApiError => e
|
2584
|
+
puts "Error when calling UserApi->user_current_put_star_with_http_info: #{e}"
|
2585
|
+
end
|
2586
|
+
```
|
2587
|
+
|
2588
|
+
### Parameters
|
2589
|
+
|
2590
|
+
| Name | Type | Description | Notes |
|
2591
|
+
| ---- | ---- | ----------- | ----- |
|
2592
|
+
| **owner** | **String** | owner of the repo to star | |
|
2593
|
+
| **repo** | **String** | name of the repo to star | |
|
2594
|
+
|
2595
|
+
### Return type
|
2596
|
+
|
2597
|
+
nil (empty response body)
|
2598
|
+
|
2599
|
+
### Authorization
|
2600
|
+
|
2601
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2602
|
+
|
2603
|
+
### HTTP request headers
|
2604
|
+
|
2605
|
+
- **Content-Type**: Not defined
|
2606
|
+
- **Accept**: Not defined
|
2607
|
+
|
2608
|
+
|
2609
|
+
## user_current_tracked_times
|
2610
|
+
|
2611
|
+
> <Array<TrackedTime>> user_current_tracked_times(opts)
|
2612
|
+
|
2613
|
+
List the current user's tracked times
|
2614
|
+
|
2615
|
+
### Examples
|
2616
|
+
|
2617
|
+
```ruby
|
2618
|
+
require 'time'
|
2619
|
+
require 'forgejo'
|
2620
|
+
# setup authorization
|
2621
|
+
Forgejo.configure do |config|
|
2622
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2623
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2624
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2625
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2626
|
+
end
|
2627
|
+
|
2628
|
+
api_instance = Forgejo::UserApi.new
|
2629
|
+
opts = {
|
2630
|
+
page: 56, # Integer | page number of results to return (1-based)
|
2631
|
+
limit: 56, # Integer | page size of results
|
2632
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only show times updated after the given time. This is a timestamp in RFC 3339 format
|
2633
|
+
before: Time.parse('2013-10-20T19:20:30+01:00') # Time | Only show times updated before the given time. This is a timestamp in RFC 3339 format
|
2634
|
+
}
|
2635
|
+
|
2636
|
+
begin
|
2637
|
+
# List the current user's tracked times
|
2638
|
+
result = api_instance.user_current_tracked_times(opts)
|
2639
|
+
p result
|
2640
|
+
rescue Forgejo::ApiError => e
|
2641
|
+
puts "Error when calling UserApi->user_current_tracked_times: #{e}"
|
2642
|
+
end
|
2643
|
+
```
|
2644
|
+
|
2645
|
+
#### Using the user_current_tracked_times_with_http_info variant
|
2646
|
+
|
2647
|
+
This returns an Array which contains the response data, status code and headers.
|
2648
|
+
|
2649
|
+
> <Array(<Array<TrackedTime>>, Integer, Hash)> user_current_tracked_times_with_http_info(opts)
|
2650
|
+
|
2651
|
+
```ruby
|
2652
|
+
begin
|
2653
|
+
# List the current user's tracked times
|
2654
|
+
data, status_code, headers = api_instance.user_current_tracked_times_with_http_info(opts)
|
2655
|
+
p status_code # => 2xx
|
2656
|
+
p headers # => { ... }
|
2657
|
+
p data # => <Array<TrackedTime>>
|
2658
|
+
rescue Forgejo::ApiError => e
|
2659
|
+
puts "Error when calling UserApi->user_current_tracked_times_with_http_info: #{e}"
|
2660
|
+
end
|
2661
|
+
```
|
2662
|
+
|
2663
|
+
### Parameters
|
2664
|
+
|
2665
|
+
| Name | Type | Description | Notes |
|
2666
|
+
| ---- | ---- | ----------- | ----- |
|
2667
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
2668
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
2669
|
+
| **since** | **Time** | Only show times updated after the given time. This is a timestamp in RFC 3339 format | [optional] |
|
2670
|
+
| **before** | **Time** | Only show times updated before the given time. This is a timestamp in RFC 3339 format | [optional] |
|
2671
|
+
|
2672
|
+
### Return type
|
2673
|
+
|
2674
|
+
[**Array<TrackedTime>**](TrackedTime.md)
|
2675
|
+
|
2676
|
+
### Authorization
|
2677
|
+
|
2678
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2679
|
+
|
2680
|
+
### HTTP request headers
|
2681
|
+
|
2682
|
+
- **Content-Type**: Not defined
|
2683
|
+
- **Accept**: application/json
|
2684
|
+
|
2685
|
+
|
2686
|
+
## user_delete_access_token
|
2687
|
+
|
2688
|
+
> user_delete_access_token(username, token)
|
2689
|
+
|
2690
|
+
delete an access token
|
2691
|
+
|
2692
|
+
### Examples
|
2693
|
+
|
2694
|
+
```ruby
|
2695
|
+
require 'time'
|
2696
|
+
require 'forgejo'
|
2697
|
+
# setup authorization
|
2698
|
+
Forgejo.configure do |config|
|
2699
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2700
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2701
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2702
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2703
|
+
end
|
2704
|
+
|
2705
|
+
api_instance = Forgejo::UserApi.new
|
2706
|
+
username = 'username_example' # String | username of user
|
2707
|
+
token = 'token_example' # String | token to be deleted, identified by ID and if not available by name
|
2708
|
+
|
2709
|
+
begin
|
2710
|
+
# delete an access token
|
2711
|
+
api_instance.user_delete_access_token(username, token)
|
2712
|
+
rescue Forgejo::ApiError => e
|
2713
|
+
puts "Error when calling UserApi->user_delete_access_token: #{e}"
|
2714
|
+
end
|
2715
|
+
```
|
2716
|
+
|
2717
|
+
#### Using the user_delete_access_token_with_http_info variant
|
2718
|
+
|
2719
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2720
|
+
|
2721
|
+
> <Array(nil, Integer, Hash)> user_delete_access_token_with_http_info(username, token)
|
2722
|
+
|
2723
|
+
```ruby
|
2724
|
+
begin
|
2725
|
+
# delete an access token
|
2726
|
+
data, status_code, headers = api_instance.user_delete_access_token_with_http_info(username, token)
|
2727
|
+
p status_code # => 2xx
|
2728
|
+
p headers # => { ... }
|
2729
|
+
p data # => nil
|
2730
|
+
rescue Forgejo::ApiError => e
|
2731
|
+
puts "Error when calling UserApi->user_delete_access_token_with_http_info: #{e}"
|
2732
|
+
end
|
2733
|
+
```
|
2734
|
+
|
2735
|
+
### Parameters
|
2736
|
+
|
2737
|
+
| Name | Type | Description | Notes |
|
2738
|
+
| ---- | ---- | ----------- | ----- |
|
2739
|
+
| **username** | **String** | username of user | |
|
2740
|
+
| **token** | **String** | token to be deleted, identified by ID and if not available by name | |
|
2741
|
+
|
2742
|
+
### Return type
|
2743
|
+
|
2744
|
+
nil (empty response body)
|
2745
|
+
|
2746
|
+
### Authorization
|
2747
|
+
|
2748
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2749
|
+
|
2750
|
+
### HTTP request headers
|
2751
|
+
|
2752
|
+
- **Content-Type**: Not defined
|
2753
|
+
- **Accept**: Not defined
|
2754
|
+
|
2755
|
+
|
2756
|
+
## user_delete_avatar
|
2757
|
+
|
2758
|
+
> user_delete_avatar
|
2759
|
+
|
2760
|
+
Delete Avatar
|
2761
|
+
|
2762
|
+
### Examples
|
2763
|
+
|
2764
|
+
```ruby
|
2765
|
+
require 'time'
|
2766
|
+
require 'forgejo'
|
2767
|
+
# setup authorization
|
2768
|
+
Forgejo.configure do |config|
|
2769
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2770
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2771
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2772
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2773
|
+
end
|
2774
|
+
|
2775
|
+
api_instance = Forgejo::UserApi.new
|
2776
|
+
|
2777
|
+
begin
|
2778
|
+
# Delete Avatar
|
2779
|
+
api_instance.user_delete_avatar
|
2780
|
+
rescue Forgejo::ApiError => e
|
2781
|
+
puts "Error when calling UserApi->user_delete_avatar: #{e}"
|
2782
|
+
end
|
2783
|
+
```
|
2784
|
+
|
2785
|
+
#### Using the user_delete_avatar_with_http_info variant
|
2786
|
+
|
2787
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2788
|
+
|
2789
|
+
> <Array(nil, Integer, Hash)> user_delete_avatar_with_http_info
|
2790
|
+
|
2791
|
+
```ruby
|
2792
|
+
begin
|
2793
|
+
# Delete Avatar
|
2794
|
+
data, status_code, headers = api_instance.user_delete_avatar_with_http_info
|
2795
|
+
p status_code # => 2xx
|
2796
|
+
p headers # => { ... }
|
2797
|
+
p data # => nil
|
2798
|
+
rescue Forgejo::ApiError => e
|
2799
|
+
puts "Error when calling UserApi->user_delete_avatar_with_http_info: #{e}"
|
2800
|
+
end
|
2801
|
+
```
|
2802
|
+
|
2803
|
+
### Parameters
|
2804
|
+
|
2805
|
+
This endpoint does not need any parameter.
|
2806
|
+
|
2807
|
+
### Return type
|
2808
|
+
|
2809
|
+
nil (empty response body)
|
2810
|
+
|
2811
|
+
### Authorization
|
2812
|
+
|
2813
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2814
|
+
|
2815
|
+
### HTTP request headers
|
2816
|
+
|
2817
|
+
- **Content-Type**: Not defined
|
2818
|
+
- **Accept**: Not defined
|
2819
|
+
|
2820
|
+
|
2821
|
+
## user_delete_email
|
2822
|
+
|
2823
|
+
> user_delete_email(opts)
|
2824
|
+
|
2825
|
+
Delete email addresses
|
2826
|
+
|
2827
|
+
### Examples
|
2828
|
+
|
2829
|
+
```ruby
|
2830
|
+
require 'time'
|
2831
|
+
require 'forgejo'
|
2832
|
+
# setup authorization
|
2833
|
+
Forgejo.configure do |config|
|
2834
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2835
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2836
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2837
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2838
|
+
end
|
2839
|
+
|
2840
|
+
api_instance = Forgejo::UserApi.new
|
2841
|
+
opts = {
|
2842
|
+
body: Forgejo::DeleteEmailOption.new # DeleteEmailOption |
|
2843
|
+
}
|
2844
|
+
|
2845
|
+
begin
|
2846
|
+
# Delete email addresses
|
2847
|
+
api_instance.user_delete_email(opts)
|
2848
|
+
rescue Forgejo::ApiError => e
|
2849
|
+
puts "Error when calling UserApi->user_delete_email: #{e}"
|
2850
|
+
end
|
2851
|
+
```
|
2852
|
+
|
2853
|
+
#### Using the user_delete_email_with_http_info variant
|
2854
|
+
|
2855
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2856
|
+
|
2857
|
+
> <Array(nil, Integer, Hash)> user_delete_email_with_http_info(opts)
|
2858
|
+
|
2859
|
+
```ruby
|
2860
|
+
begin
|
2861
|
+
# Delete email addresses
|
2862
|
+
data, status_code, headers = api_instance.user_delete_email_with_http_info(opts)
|
2863
|
+
p status_code # => 2xx
|
2864
|
+
p headers # => { ... }
|
2865
|
+
p data # => nil
|
2866
|
+
rescue Forgejo::ApiError => e
|
2867
|
+
puts "Error when calling UserApi->user_delete_email_with_http_info: #{e}"
|
2868
|
+
end
|
2869
|
+
```
|
2870
|
+
|
2871
|
+
### Parameters
|
2872
|
+
|
2873
|
+
| Name | Type | Description | Notes |
|
2874
|
+
| ---- | ---- | ----------- | ----- |
|
2875
|
+
| **body** | [**DeleteEmailOption**](DeleteEmailOption.md) | | [optional] |
|
2876
|
+
|
2877
|
+
### Return type
|
2878
|
+
|
2879
|
+
nil (empty response body)
|
2880
|
+
|
2881
|
+
### Authorization
|
2882
|
+
|
2883
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2884
|
+
|
2885
|
+
### HTTP request headers
|
2886
|
+
|
2887
|
+
- **Content-Type**: application/json, text/plain
|
2888
|
+
- **Accept**: Not defined
|
2889
|
+
|
2890
|
+
|
2891
|
+
## user_delete_hook
|
2892
|
+
|
2893
|
+
> user_delete_hook(id)
|
2894
|
+
|
2895
|
+
Delete a hook
|
2896
|
+
|
2897
|
+
### Examples
|
2898
|
+
|
2899
|
+
```ruby
|
2900
|
+
require 'time'
|
2901
|
+
require 'forgejo'
|
2902
|
+
# setup authorization
|
2903
|
+
Forgejo.configure do |config|
|
2904
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2905
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2906
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2907
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2908
|
+
end
|
2909
|
+
|
2910
|
+
api_instance = Forgejo::UserApi.new
|
2911
|
+
id = 789 # Integer | id of the hook to delete
|
2912
|
+
|
2913
|
+
begin
|
2914
|
+
# Delete a hook
|
2915
|
+
api_instance.user_delete_hook(id)
|
2916
|
+
rescue Forgejo::ApiError => e
|
2917
|
+
puts "Error when calling UserApi->user_delete_hook: #{e}"
|
2918
|
+
end
|
2919
|
+
```
|
2920
|
+
|
2921
|
+
#### Using the user_delete_hook_with_http_info variant
|
2922
|
+
|
2923
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2924
|
+
|
2925
|
+
> <Array(nil, Integer, Hash)> user_delete_hook_with_http_info(id)
|
2926
|
+
|
2927
|
+
```ruby
|
2928
|
+
begin
|
2929
|
+
# Delete a hook
|
2930
|
+
data, status_code, headers = api_instance.user_delete_hook_with_http_info(id)
|
2931
|
+
p status_code # => 2xx
|
2932
|
+
p headers # => { ... }
|
2933
|
+
p data # => nil
|
2934
|
+
rescue Forgejo::ApiError => e
|
2935
|
+
puts "Error when calling UserApi->user_delete_hook_with_http_info: #{e}"
|
2936
|
+
end
|
2937
|
+
```
|
2938
|
+
|
2939
|
+
### Parameters
|
2940
|
+
|
2941
|
+
| Name | Type | Description | Notes |
|
2942
|
+
| ---- | ---- | ----------- | ----- |
|
2943
|
+
| **id** | **Integer** | id of the hook to delete | |
|
2944
|
+
|
2945
|
+
### Return type
|
2946
|
+
|
2947
|
+
nil (empty response body)
|
2948
|
+
|
2949
|
+
### Authorization
|
2950
|
+
|
2951
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
2952
|
+
|
2953
|
+
### HTTP request headers
|
2954
|
+
|
2955
|
+
- **Content-Type**: Not defined
|
2956
|
+
- **Accept**: Not defined
|
2957
|
+
|
2958
|
+
|
2959
|
+
## user_delete_o_auth2_application
|
2960
|
+
|
2961
|
+
> user_delete_o_auth2_application(id)
|
2962
|
+
|
2963
|
+
delete an OAuth2 Application
|
2964
|
+
|
2965
|
+
### Examples
|
2966
|
+
|
2967
|
+
```ruby
|
2968
|
+
require 'time'
|
2969
|
+
require 'forgejo'
|
2970
|
+
# setup authorization
|
2971
|
+
Forgejo.configure do |config|
|
2972
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
2973
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
2974
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2975
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
2976
|
+
end
|
2977
|
+
|
2978
|
+
api_instance = Forgejo::UserApi.new
|
2979
|
+
id = 789 # Integer | token to be deleted
|
2980
|
+
|
2981
|
+
begin
|
2982
|
+
# delete an OAuth2 Application
|
2983
|
+
api_instance.user_delete_o_auth2_application(id)
|
2984
|
+
rescue Forgejo::ApiError => e
|
2985
|
+
puts "Error when calling UserApi->user_delete_o_auth2_application: #{e}"
|
2986
|
+
end
|
2987
|
+
```
|
2988
|
+
|
2989
|
+
#### Using the user_delete_o_auth2_application_with_http_info variant
|
2990
|
+
|
2991
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
2992
|
+
|
2993
|
+
> <Array(nil, Integer, Hash)> user_delete_o_auth2_application_with_http_info(id)
|
2994
|
+
|
2995
|
+
```ruby
|
2996
|
+
begin
|
2997
|
+
# delete an OAuth2 Application
|
2998
|
+
data, status_code, headers = api_instance.user_delete_o_auth2_application_with_http_info(id)
|
2999
|
+
p status_code # => 2xx
|
3000
|
+
p headers # => { ... }
|
3001
|
+
p data # => nil
|
3002
|
+
rescue Forgejo::ApiError => e
|
3003
|
+
puts "Error when calling UserApi->user_delete_o_auth2_application_with_http_info: #{e}"
|
3004
|
+
end
|
3005
|
+
```
|
3006
|
+
|
3007
|
+
### Parameters
|
3008
|
+
|
3009
|
+
| Name | Type | Description | Notes |
|
3010
|
+
| ---- | ---- | ----------- | ----- |
|
3011
|
+
| **id** | **Integer** | token to be deleted | |
|
3012
|
+
|
3013
|
+
### Return type
|
3014
|
+
|
3015
|
+
nil (empty response body)
|
3016
|
+
|
3017
|
+
### Authorization
|
3018
|
+
|
3019
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3020
|
+
|
3021
|
+
### HTTP request headers
|
3022
|
+
|
3023
|
+
- **Content-Type**: Not defined
|
3024
|
+
- **Accept**: Not defined
|
3025
|
+
|
3026
|
+
|
3027
|
+
## user_edit_hook
|
3028
|
+
|
3029
|
+
> <Hook> user_edit_hook(id, opts)
|
3030
|
+
|
3031
|
+
Update a hook
|
3032
|
+
|
3033
|
+
### Examples
|
3034
|
+
|
3035
|
+
```ruby
|
3036
|
+
require 'time'
|
3037
|
+
require 'forgejo'
|
3038
|
+
# setup authorization
|
3039
|
+
Forgejo.configure do |config|
|
3040
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3041
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3042
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3043
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3044
|
+
end
|
3045
|
+
|
3046
|
+
api_instance = Forgejo::UserApi.new
|
3047
|
+
id = 789 # Integer | id of the hook to update
|
3048
|
+
opts = {
|
3049
|
+
body: Forgejo::EditHookOption.new # EditHookOption |
|
3050
|
+
}
|
3051
|
+
|
3052
|
+
begin
|
3053
|
+
# Update a hook
|
3054
|
+
result = api_instance.user_edit_hook(id, opts)
|
3055
|
+
p result
|
3056
|
+
rescue Forgejo::ApiError => e
|
3057
|
+
puts "Error when calling UserApi->user_edit_hook: #{e}"
|
3058
|
+
end
|
3059
|
+
```
|
3060
|
+
|
3061
|
+
#### Using the user_edit_hook_with_http_info variant
|
3062
|
+
|
3063
|
+
This returns an Array which contains the response data, status code and headers.
|
3064
|
+
|
3065
|
+
> <Array(<Hook>, Integer, Hash)> user_edit_hook_with_http_info(id, opts)
|
3066
|
+
|
3067
|
+
```ruby
|
3068
|
+
begin
|
3069
|
+
# Update a hook
|
3070
|
+
data, status_code, headers = api_instance.user_edit_hook_with_http_info(id, opts)
|
3071
|
+
p status_code # => 2xx
|
3072
|
+
p headers # => { ... }
|
3073
|
+
p data # => <Hook>
|
3074
|
+
rescue Forgejo::ApiError => e
|
3075
|
+
puts "Error when calling UserApi->user_edit_hook_with_http_info: #{e}"
|
3076
|
+
end
|
3077
|
+
```
|
3078
|
+
|
3079
|
+
### Parameters
|
3080
|
+
|
3081
|
+
| Name | Type | Description | Notes |
|
3082
|
+
| ---- | ---- | ----------- | ----- |
|
3083
|
+
| **id** | **Integer** | id of the hook to update | |
|
3084
|
+
| **body** | [**EditHookOption**](EditHookOption.md) | | [optional] |
|
3085
|
+
|
3086
|
+
### Return type
|
3087
|
+
|
3088
|
+
[**Hook**](Hook.md)
|
3089
|
+
|
3090
|
+
### Authorization
|
3091
|
+
|
3092
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3093
|
+
|
3094
|
+
### HTTP request headers
|
3095
|
+
|
3096
|
+
- **Content-Type**: application/json
|
3097
|
+
- **Accept**: application/json
|
3098
|
+
|
3099
|
+
|
3100
|
+
## user_get
|
3101
|
+
|
3102
|
+
> <User> user_get(username)
|
3103
|
+
|
3104
|
+
Get a user
|
3105
|
+
|
3106
|
+
### Examples
|
3107
|
+
|
3108
|
+
```ruby
|
3109
|
+
require 'time'
|
3110
|
+
require 'forgejo'
|
3111
|
+
# setup authorization
|
3112
|
+
Forgejo.configure do |config|
|
3113
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3114
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3115
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3116
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3117
|
+
end
|
3118
|
+
|
3119
|
+
api_instance = Forgejo::UserApi.new
|
3120
|
+
username = 'username_example' # String | username of user to get
|
3121
|
+
|
3122
|
+
begin
|
3123
|
+
# Get a user
|
3124
|
+
result = api_instance.user_get(username)
|
3125
|
+
p result
|
3126
|
+
rescue Forgejo::ApiError => e
|
3127
|
+
puts "Error when calling UserApi->user_get: #{e}"
|
3128
|
+
end
|
3129
|
+
```
|
3130
|
+
|
3131
|
+
#### Using the user_get_with_http_info variant
|
3132
|
+
|
3133
|
+
This returns an Array which contains the response data, status code and headers.
|
3134
|
+
|
3135
|
+
> <Array(<User>, Integer, Hash)> user_get_with_http_info(username)
|
3136
|
+
|
3137
|
+
```ruby
|
3138
|
+
begin
|
3139
|
+
# Get a user
|
3140
|
+
data, status_code, headers = api_instance.user_get_with_http_info(username)
|
3141
|
+
p status_code # => 2xx
|
3142
|
+
p headers # => { ... }
|
3143
|
+
p data # => <User>
|
3144
|
+
rescue Forgejo::ApiError => e
|
3145
|
+
puts "Error when calling UserApi->user_get_with_http_info: #{e}"
|
3146
|
+
end
|
3147
|
+
```
|
3148
|
+
|
3149
|
+
### Parameters
|
3150
|
+
|
3151
|
+
| Name | Type | Description | Notes |
|
3152
|
+
| ---- | ---- | ----------- | ----- |
|
3153
|
+
| **username** | **String** | username of user to get | |
|
3154
|
+
|
3155
|
+
### Return type
|
3156
|
+
|
3157
|
+
[**User**](User.md)
|
3158
|
+
|
3159
|
+
### Authorization
|
3160
|
+
|
3161
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3162
|
+
|
3163
|
+
### HTTP request headers
|
3164
|
+
|
3165
|
+
- **Content-Type**: Not defined
|
3166
|
+
- **Accept**: application/json
|
3167
|
+
|
3168
|
+
|
3169
|
+
## user_get_current
|
3170
|
+
|
3171
|
+
> <User> user_get_current
|
3172
|
+
|
3173
|
+
Get the authenticated user
|
3174
|
+
|
3175
|
+
### Examples
|
3176
|
+
|
3177
|
+
```ruby
|
3178
|
+
require 'time'
|
3179
|
+
require 'forgejo'
|
3180
|
+
# setup authorization
|
3181
|
+
Forgejo.configure do |config|
|
3182
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3183
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3184
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3185
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3186
|
+
end
|
3187
|
+
|
3188
|
+
api_instance = Forgejo::UserApi.new
|
3189
|
+
|
3190
|
+
begin
|
3191
|
+
# Get the authenticated user
|
3192
|
+
result = api_instance.user_get_current
|
3193
|
+
p result
|
3194
|
+
rescue Forgejo::ApiError => e
|
3195
|
+
puts "Error when calling UserApi->user_get_current: #{e}"
|
3196
|
+
end
|
3197
|
+
```
|
3198
|
+
|
3199
|
+
#### Using the user_get_current_with_http_info variant
|
3200
|
+
|
3201
|
+
This returns an Array which contains the response data, status code and headers.
|
3202
|
+
|
3203
|
+
> <Array(<User>, Integer, Hash)> user_get_current_with_http_info
|
3204
|
+
|
3205
|
+
```ruby
|
3206
|
+
begin
|
3207
|
+
# Get the authenticated user
|
3208
|
+
data, status_code, headers = api_instance.user_get_current_with_http_info
|
3209
|
+
p status_code # => 2xx
|
3210
|
+
p headers # => { ... }
|
3211
|
+
p data # => <User>
|
3212
|
+
rescue Forgejo::ApiError => e
|
3213
|
+
puts "Error when calling UserApi->user_get_current_with_http_info: #{e}"
|
3214
|
+
end
|
3215
|
+
```
|
3216
|
+
|
3217
|
+
### Parameters
|
3218
|
+
|
3219
|
+
This endpoint does not need any parameter.
|
3220
|
+
|
3221
|
+
### Return type
|
3222
|
+
|
3223
|
+
[**User**](User.md)
|
3224
|
+
|
3225
|
+
### Authorization
|
3226
|
+
|
3227
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3228
|
+
|
3229
|
+
### HTTP request headers
|
3230
|
+
|
3231
|
+
- **Content-Type**: Not defined
|
3232
|
+
- **Accept**: application/json
|
3233
|
+
|
3234
|
+
|
3235
|
+
## user_get_heatmap_data
|
3236
|
+
|
3237
|
+
> <Array<UserHeatmapData>> user_get_heatmap_data(username)
|
3238
|
+
|
3239
|
+
Get a user's heatmap
|
3240
|
+
|
3241
|
+
### Examples
|
3242
|
+
|
3243
|
+
```ruby
|
3244
|
+
require 'time'
|
3245
|
+
require 'forgejo'
|
3246
|
+
# setup authorization
|
3247
|
+
Forgejo.configure do |config|
|
3248
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3249
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3251
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3252
|
+
end
|
3253
|
+
|
3254
|
+
api_instance = Forgejo::UserApi.new
|
3255
|
+
username = 'username_example' # String | username of user to get
|
3256
|
+
|
3257
|
+
begin
|
3258
|
+
# Get a user's heatmap
|
3259
|
+
result = api_instance.user_get_heatmap_data(username)
|
3260
|
+
p result
|
3261
|
+
rescue Forgejo::ApiError => e
|
3262
|
+
puts "Error when calling UserApi->user_get_heatmap_data: #{e}"
|
3263
|
+
end
|
3264
|
+
```
|
3265
|
+
|
3266
|
+
#### Using the user_get_heatmap_data_with_http_info variant
|
3267
|
+
|
3268
|
+
This returns an Array which contains the response data, status code and headers.
|
3269
|
+
|
3270
|
+
> <Array(<Array<UserHeatmapData>>, Integer, Hash)> user_get_heatmap_data_with_http_info(username)
|
3271
|
+
|
3272
|
+
```ruby
|
3273
|
+
begin
|
3274
|
+
# Get a user's heatmap
|
3275
|
+
data, status_code, headers = api_instance.user_get_heatmap_data_with_http_info(username)
|
3276
|
+
p status_code # => 2xx
|
3277
|
+
p headers # => { ... }
|
3278
|
+
p data # => <Array<UserHeatmapData>>
|
3279
|
+
rescue Forgejo::ApiError => e
|
3280
|
+
puts "Error when calling UserApi->user_get_heatmap_data_with_http_info: #{e}"
|
3281
|
+
end
|
3282
|
+
```
|
3283
|
+
|
3284
|
+
### Parameters
|
3285
|
+
|
3286
|
+
| Name | Type | Description | Notes |
|
3287
|
+
| ---- | ---- | ----------- | ----- |
|
3288
|
+
| **username** | **String** | username of user to get | |
|
3289
|
+
|
3290
|
+
### Return type
|
3291
|
+
|
3292
|
+
[**Array<UserHeatmapData>**](UserHeatmapData.md)
|
3293
|
+
|
3294
|
+
### Authorization
|
3295
|
+
|
3296
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3297
|
+
|
3298
|
+
### HTTP request headers
|
3299
|
+
|
3300
|
+
- **Content-Type**: Not defined
|
3301
|
+
- **Accept**: application/json
|
3302
|
+
|
3303
|
+
|
3304
|
+
## user_get_hook
|
3305
|
+
|
3306
|
+
> <Hook> user_get_hook(id)
|
3307
|
+
|
3308
|
+
Get a hook
|
3309
|
+
|
3310
|
+
### Examples
|
3311
|
+
|
3312
|
+
```ruby
|
3313
|
+
require 'time'
|
3314
|
+
require 'forgejo'
|
3315
|
+
# setup authorization
|
3316
|
+
Forgejo.configure do |config|
|
3317
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3318
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3319
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3320
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3321
|
+
end
|
3322
|
+
|
3323
|
+
api_instance = Forgejo::UserApi.new
|
3324
|
+
id = 789 # Integer | id of the hook to get
|
3325
|
+
|
3326
|
+
begin
|
3327
|
+
# Get a hook
|
3328
|
+
result = api_instance.user_get_hook(id)
|
3329
|
+
p result
|
3330
|
+
rescue Forgejo::ApiError => e
|
3331
|
+
puts "Error when calling UserApi->user_get_hook: #{e}"
|
3332
|
+
end
|
3333
|
+
```
|
3334
|
+
|
3335
|
+
#### Using the user_get_hook_with_http_info variant
|
3336
|
+
|
3337
|
+
This returns an Array which contains the response data, status code and headers.
|
3338
|
+
|
3339
|
+
> <Array(<Hook>, Integer, Hash)> user_get_hook_with_http_info(id)
|
3340
|
+
|
3341
|
+
```ruby
|
3342
|
+
begin
|
3343
|
+
# Get a hook
|
3344
|
+
data, status_code, headers = api_instance.user_get_hook_with_http_info(id)
|
3345
|
+
p status_code # => 2xx
|
3346
|
+
p headers # => { ... }
|
3347
|
+
p data # => <Hook>
|
3348
|
+
rescue Forgejo::ApiError => e
|
3349
|
+
puts "Error when calling UserApi->user_get_hook_with_http_info: #{e}"
|
3350
|
+
end
|
3351
|
+
```
|
3352
|
+
|
3353
|
+
### Parameters
|
3354
|
+
|
3355
|
+
| Name | Type | Description | Notes |
|
3356
|
+
| ---- | ---- | ----------- | ----- |
|
3357
|
+
| **id** | **Integer** | id of the hook to get | |
|
3358
|
+
|
3359
|
+
### Return type
|
3360
|
+
|
3361
|
+
[**Hook**](Hook.md)
|
3362
|
+
|
3363
|
+
### Authorization
|
3364
|
+
|
3365
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3366
|
+
|
3367
|
+
### HTTP request headers
|
3368
|
+
|
3369
|
+
- **Content-Type**: Not defined
|
3370
|
+
- **Accept**: application/json
|
3371
|
+
|
3372
|
+
|
3373
|
+
## user_get_o_auth2_application
|
3374
|
+
|
3375
|
+
> <OAuth2Application> user_get_o_auth2_application(id)
|
3376
|
+
|
3377
|
+
get an OAuth2 Application
|
3378
|
+
|
3379
|
+
### Examples
|
3380
|
+
|
3381
|
+
```ruby
|
3382
|
+
require 'time'
|
3383
|
+
require 'forgejo'
|
3384
|
+
# setup authorization
|
3385
|
+
Forgejo.configure do |config|
|
3386
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3387
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3388
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3389
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3390
|
+
end
|
3391
|
+
|
3392
|
+
api_instance = Forgejo::UserApi.new
|
3393
|
+
id = 789 # Integer | Application ID to be found
|
3394
|
+
|
3395
|
+
begin
|
3396
|
+
# get an OAuth2 Application
|
3397
|
+
result = api_instance.user_get_o_auth2_application(id)
|
3398
|
+
p result
|
3399
|
+
rescue Forgejo::ApiError => e
|
3400
|
+
puts "Error when calling UserApi->user_get_o_auth2_application: #{e}"
|
3401
|
+
end
|
3402
|
+
```
|
3403
|
+
|
3404
|
+
#### Using the user_get_o_auth2_application_with_http_info variant
|
3405
|
+
|
3406
|
+
This returns an Array which contains the response data, status code and headers.
|
3407
|
+
|
3408
|
+
> <Array(<OAuth2Application>, Integer, Hash)> user_get_o_auth2_application_with_http_info(id)
|
3409
|
+
|
3410
|
+
```ruby
|
3411
|
+
begin
|
3412
|
+
# get an OAuth2 Application
|
3413
|
+
data, status_code, headers = api_instance.user_get_o_auth2_application_with_http_info(id)
|
3414
|
+
p status_code # => 2xx
|
3415
|
+
p headers # => { ... }
|
3416
|
+
p data # => <OAuth2Application>
|
3417
|
+
rescue Forgejo::ApiError => e
|
3418
|
+
puts "Error when calling UserApi->user_get_o_auth2_application_with_http_info: #{e}"
|
3419
|
+
end
|
3420
|
+
```
|
3421
|
+
|
3422
|
+
### Parameters
|
3423
|
+
|
3424
|
+
| Name | Type | Description | Notes |
|
3425
|
+
| ---- | ---- | ----------- | ----- |
|
3426
|
+
| **id** | **Integer** | Application ID to be found | |
|
3427
|
+
|
3428
|
+
### Return type
|
3429
|
+
|
3430
|
+
[**OAuth2Application**](OAuth2Application.md)
|
3431
|
+
|
3432
|
+
### Authorization
|
3433
|
+
|
3434
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3435
|
+
|
3436
|
+
### HTTP request headers
|
3437
|
+
|
3438
|
+
- **Content-Type**: Not defined
|
3439
|
+
- **Accept**: application/json
|
3440
|
+
|
3441
|
+
|
3442
|
+
## user_get_o_auth2_applications
|
3443
|
+
|
3444
|
+
> <Array<OAuth2Application>> user_get_o_auth2_applications(opts)
|
3445
|
+
|
3446
|
+
List the authenticated user's oauth2 applications
|
3447
|
+
|
3448
|
+
### Examples
|
3449
|
+
|
3450
|
+
```ruby
|
3451
|
+
require 'time'
|
3452
|
+
require 'forgejo'
|
3453
|
+
# setup authorization
|
3454
|
+
Forgejo.configure do |config|
|
3455
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3456
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3457
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3458
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3459
|
+
end
|
3460
|
+
|
3461
|
+
api_instance = Forgejo::UserApi.new
|
3462
|
+
opts = {
|
3463
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3464
|
+
limit: 56 # Integer | page size of results
|
3465
|
+
}
|
3466
|
+
|
3467
|
+
begin
|
3468
|
+
# List the authenticated user's oauth2 applications
|
3469
|
+
result = api_instance.user_get_o_auth2_applications(opts)
|
3470
|
+
p result
|
3471
|
+
rescue Forgejo::ApiError => e
|
3472
|
+
puts "Error when calling UserApi->user_get_o_auth2_applications: #{e}"
|
3473
|
+
end
|
3474
|
+
```
|
3475
|
+
|
3476
|
+
#### Using the user_get_o_auth2_applications_with_http_info variant
|
3477
|
+
|
3478
|
+
This returns an Array which contains the response data, status code and headers.
|
3479
|
+
|
3480
|
+
> <Array(<Array<OAuth2Application>>, Integer, Hash)> user_get_o_auth2_applications_with_http_info(opts)
|
3481
|
+
|
3482
|
+
```ruby
|
3483
|
+
begin
|
3484
|
+
# List the authenticated user's oauth2 applications
|
3485
|
+
data, status_code, headers = api_instance.user_get_o_auth2_applications_with_http_info(opts)
|
3486
|
+
p status_code # => 2xx
|
3487
|
+
p headers # => { ... }
|
3488
|
+
p data # => <Array<OAuth2Application>>
|
3489
|
+
rescue Forgejo::ApiError => e
|
3490
|
+
puts "Error when calling UserApi->user_get_o_auth2_applications_with_http_info: #{e}"
|
3491
|
+
end
|
3492
|
+
```
|
3493
|
+
|
3494
|
+
### Parameters
|
3495
|
+
|
3496
|
+
| Name | Type | Description | Notes |
|
3497
|
+
| ---- | ---- | ----------- | ----- |
|
3498
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
3499
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
3500
|
+
|
3501
|
+
### Return type
|
3502
|
+
|
3503
|
+
[**Array<OAuth2Application>**](OAuth2Application.md)
|
3504
|
+
|
3505
|
+
### Authorization
|
3506
|
+
|
3507
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3508
|
+
|
3509
|
+
### HTTP request headers
|
3510
|
+
|
3511
|
+
- **Content-Type**: Not defined
|
3512
|
+
- **Accept**: application/json
|
3513
|
+
|
3514
|
+
|
3515
|
+
## user_get_runner_registration_token
|
3516
|
+
|
3517
|
+
> user_get_runner_registration_token
|
3518
|
+
|
3519
|
+
Get an user's actions runner registration token
|
3520
|
+
|
3521
|
+
### Examples
|
3522
|
+
|
3523
|
+
```ruby
|
3524
|
+
require 'time'
|
3525
|
+
require 'forgejo'
|
3526
|
+
# setup authorization
|
3527
|
+
Forgejo.configure do |config|
|
3528
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3529
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3530
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3531
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3532
|
+
end
|
3533
|
+
|
3534
|
+
api_instance = Forgejo::UserApi.new
|
3535
|
+
|
3536
|
+
begin
|
3537
|
+
# Get an user's actions runner registration token
|
3538
|
+
api_instance.user_get_runner_registration_token
|
3539
|
+
rescue Forgejo::ApiError => e
|
3540
|
+
puts "Error when calling UserApi->user_get_runner_registration_token: #{e}"
|
3541
|
+
end
|
3542
|
+
```
|
3543
|
+
|
3544
|
+
#### Using the user_get_runner_registration_token_with_http_info variant
|
3545
|
+
|
3546
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
3547
|
+
|
3548
|
+
> <Array(nil, Integer, Hash)> user_get_runner_registration_token_with_http_info
|
3549
|
+
|
3550
|
+
```ruby
|
3551
|
+
begin
|
3552
|
+
# Get an user's actions runner registration token
|
3553
|
+
data, status_code, headers = api_instance.user_get_runner_registration_token_with_http_info
|
3554
|
+
p status_code # => 2xx
|
3555
|
+
p headers # => { ... }
|
3556
|
+
p data # => nil
|
3557
|
+
rescue Forgejo::ApiError => e
|
3558
|
+
puts "Error when calling UserApi->user_get_runner_registration_token_with_http_info: #{e}"
|
3559
|
+
end
|
3560
|
+
```
|
3561
|
+
|
3562
|
+
### Parameters
|
3563
|
+
|
3564
|
+
This endpoint does not need any parameter.
|
3565
|
+
|
3566
|
+
### Return type
|
3567
|
+
|
3568
|
+
nil (empty response body)
|
3569
|
+
|
3570
|
+
### Authorization
|
3571
|
+
|
3572
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3573
|
+
|
3574
|
+
### HTTP request headers
|
3575
|
+
|
3576
|
+
- **Content-Type**: Not defined
|
3577
|
+
- **Accept**: Not defined
|
3578
|
+
|
3579
|
+
|
3580
|
+
## user_get_stop_watches
|
3581
|
+
|
3582
|
+
> <Array<StopWatch>> user_get_stop_watches(opts)
|
3583
|
+
|
3584
|
+
Get list of all existing stopwatches
|
3585
|
+
|
3586
|
+
### Examples
|
3587
|
+
|
3588
|
+
```ruby
|
3589
|
+
require 'time'
|
3590
|
+
require 'forgejo'
|
3591
|
+
# setup authorization
|
3592
|
+
Forgejo.configure do |config|
|
3593
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3594
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3595
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3596
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3597
|
+
end
|
3598
|
+
|
3599
|
+
api_instance = Forgejo::UserApi.new
|
3600
|
+
opts = {
|
3601
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3602
|
+
limit: 56 # Integer | page size of results
|
3603
|
+
}
|
3604
|
+
|
3605
|
+
begin
|
3606
|
+
# Get list of all existing stopwatches
|
3607
|
+
result = api_instance.user_get_stop_watches(opts)
|
3608
|
+
p result
|
3609
|
+
rescue Forgejo::ApiError => e
|
3610
|
+
puts "Error when calling UserApi->user_get_stop_watches: #{e}"
|
3611
|
+
end
|
3612
|
+
```
|
3613
|
+
|
3614
|
+
#### Using the user_get_stop_watches_with_http_info variant
|
3615
|
+
|
3616
|
+
This returns an Array which contains the response data, status code and headers.
|
3617
|
+
|
3618
|
+
> <Array(<Array<StopWatch>>, Integer, Hash)> user_get_stop_watches_with_http_info(opts)
|
3619
|
+
|
3620
|
+
```ruby
|
3621
|
+
begin
|
3622
|
+
# Get list of all existing stopwatches
|
3623
|
+
data, status_code, headers = api_instance.user_get_stop_watches_with_http_info(opts)
|
3624
|
+
p status_code # => 2xx
|
3625
|
+
p headers # => { ... }
|
3626
|
+
p data # => <Array<StopWatch>>
|
3627
|
+
rescue Forgejo::ApiError => e
|
3628
|
+
puts "Error when calling UserApi->user_get_stop_watches_with_http_info: #{e}"
|
3629
|
+
end
|
3630
|
+
```
|
3631
|
+
|
3632
|
+
### Parameters
|
3633
|
+
|
3634
|
+
| Name | Type | Description | Notes |
|
3635
|
+
| ---- | ---- | ----------- | ----- |
|
3636
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
3637
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
3638
|
+
|
3639
|
+
### Return type
|
3640
|
+
|
3641
|
+
[**Array<StopWatch>**](StopWatch.md)
|
3642
|
+
|
3643
|
+
### Authorization
|
3644
|
+
|
3645
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3646
|
+
|
3647
|
+
### HTTP request headers
|
3648
|
+
|
3649
|
+
- **Content-Type**: Not defined
|
3650
|
+
- **Accept**: application/json
|
3651
|
+
|
3652
|
+
|
3653
|
+
## user_get_tokens
|
3654
|
+
|
3655
|
+
> <Array<AccessToken>> user_get_tokens(username, opts)
|
3656
|
+
|
3657
|
+
List the authenticated user's access tokens
|
3658
|
+
|
3659
|
+
### Examples
|
3660
|
+
|
3661
|
+
```ruby
|
3662
|
+
require 'time'
|
3663
|
+
require 'forgejo'
|
3664
|
+
# setup authorization
|
3665
|
+
Forgejo.configure do |config|
|
3666
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3667
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3668
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3669
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3670
|
+
end
|
3671
|
+
|
3672
|
+
api_instance = Forgejo::UserApi.new
|
3673
|
+
username = 'username_example' # String | username of user
|
3674
|
+
opts = {
|
3675
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3676
|
+
limit: 56 # Integer | page size of results
|
3677
|
+
}
|
3678
|
+
|
3679
|
+
begin
|
3680
|
+
# List the authenticated user's access tokens
|
3681
|
+
result = api_instance.user_get_tokens(username, opts)
|
3682
|
+
p result
|
3683
|
+
rescue Forgejo::ApiError => e
|
3684
|
+
puts "Error when calling UserApi->user_get_tokens: #{e}"
|
3685
|
+
end
|
3686
|
+
```
|
3687
|
+
|
3688
|
+
#### Using the user_get_tokens_with_http_info variant
|
3689
|
+
|
3690
|
+
This returns an Array which contains the response data, status code and headers.
|
3691
|
+
|
3692
|
+
> <Array(<Array<AccessToken>>, Integer, Hash)> user_get_tokens_with_http_info(username, opts)
|
3693
|
+
|
3694
|
+
```ruby
|
3695
|
+
begin
|
3696
|
+
# List the authenticated user's access tokens
|
3697
|
+
data, status_code, headers = api_instance.user_get_tokens_with_http_info(username, opts)
|
3698
|
+
p status_code # => 2xx
|
3699
|
+
p headers # => { ... }
|
3700
|
+
p data # => <Array<AccessToken>>
|
3701
|
+
rescue Forgejo::ApiError => e
|
3702
|
+
puts "Error when calling UserApi->user_get_tokens_with_http_info: #{e}"
|
3703
|
+
end
|
3704
|
+
```
|
3705
|
+
|
3706
|
+
### Parameters
|
3707
|
+
|
3708
|
+
| Name | Type | Description | Notes |
|
3709
|
+
| ---- | ---- | ----------- | ----- |
|
3710
|
+
| **username** | **String** | username of user | |
|
3711
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
3712
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
3713
|
+
|
3714
|
+
### Return type
|
3715
|
+
|
3716
|
+
[**Array<AccessToken>**](AccessToken.md)
|
3717
|
+
|
3718
|
+
### Authorization
|
3719
|
+
|
3720
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3721
|
+
|
3722
|
+
### HTTP request headers
|
3723
|
+
|
3724
|
+
- **Content-Type**: Not defined
|
3725
|
+
- **Accept**: application/json
|
3726
|
+
|
3727
|
+
|
3728
|
+
## user_list_activity_feeds
|
3729
|
+
|
3730
|
+
> <Array<Activity>> user_list_activity_feeds(username, opts)
|
3731
|
+
|
3732
|
+
List a user's activity feeds
|
3733
|
+
|
3734
|
+
### Examples
|
3735
|
+
|
3736
|
+
```ruby
|
3737
|
+
require 'time'
|
3738
|
+
require 'forgejo'
|
3739
|
+
# setup authorization
|
3740
|
+
Forgejo.configure do |config|
|
3741
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3742
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3743
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3744
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3745
|
+
end
|
3746
|
+
|
3747
|
+
api_instance = Forgejo::UserApi.new
|
3748
|
+
username = 'username_example' # String | username of user
|
3749
|
+
opts = {
|
3750
|
+
only_performed_by: true, # Boolean | if true, only show actions performed by the requested user
|
3751
|
+
date: Date.parse('2013-10-20'), # Date | the date of the activities to be found
|
3752
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3753
|
+
limit: 56 # Integer | page size of results
|
3754
|
+
}
|
3755
|
+
|
3756
|
+
begin
|
3757
|
+
# List a user's activity feeds
|
3758
|
+
result = api_instance.user_list_activity_feeds(username, opts)
|
3759
|
+
p result
|
3760
|
+
rescue Forgejo::ApiError => e
|
3761
|
+
puts "Error when calling UserApi->user_list_activity_feeds: #{e}"
|
3762
|
+
end
|
3763
|
+
```
|
3764
|
+
|
3765
|
+
#### Using the user_list_activity_feeds_with_http_info variant
|
3766
|
+
|
3767
|
+
This returns an Array which contains the response data, status code and headers.
|
3768
|
+
|
3769
|
+
> <Array(<Array<Activity>>, Integer, Hash)> user_list_activity_feeds_with_http_info(username, opts)
|
3770
|
+
|
3771
|
+
```ruby
|
3772
|
+
begin
|
3773
|
+
# List a user's activity feeds
|
3774
|
+
data, status_code, headers = api_instance.user_list_activity_feeds_with_http_info(username, opts)
|
3775
|
+
p status_code # => 2xx
|
3776
|
+
p headers # => { ... }
|
3777
|
+
p data # => <Array<Activity>>
|
3778
|
+
rescue Forgejo::ApiError => e
|
3779
|
+
puts "Error when calling UserApi->user_list_activity_feeds_with_http_info: #{e}"
|
3780
|
+
end
|
3781
|
+
```
|
3782
|
+
|
3783
|
+
### Parameters
|
3784
|
+
|
3785
|
+
| Name | Type | Description | Notes |
|
3786
|
+
| ---- | ---- | ----------- | ----- |
|
3787
|
+
| **username** | **String** | username of user | |
|
3788
|
+
| **only_performed_by** | **Boolean** | if true, only show actions performed by the requested user | [optional] |
|
3789
|
+
| **date** | **Date** | the date of the activities to be found | [optional] |
|
3790
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
3791
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
3792
|
+
|
3793
|
+
### Return type
|
3794
|
+
|
3795
|
+
[**Array<Activity>**](Activity.md)
|
3796
|
+
|
3797
|
+
### Authorization
|
3798
|
+
|
3799
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3800
|
+
|
3801
|
+
### HTTP request headers
|
3802
|
+
|
3803
|
+
- **Content-Type**: Not defined
|
3804
|
+
- **Accept**: application/json
|
3805
|
+
|
3806
|
+
|
3807
|
+
## user_list_blocked_users
|
3808
|
+
|
3809
|
+
> <Array<BlockedUser>> user_list_blocked_users(opts)
|
3810
|
+
|
3811
|
+
List the authenticated user's blocked users
|
3812
|
+
|
3813
|
+
### Examples
|
3814
|
+
|
3815
|
+
```ruby
|
3816
|
+
require 'time'
|
3817
|
+
require 'forgejo'
|
3818
|
+
# setup authorization
|
3819
|
+
Forgejo.configure do |config|
|
3820
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3821
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3822
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3823
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3824
|
+
end
|
3825
|
+
|
3826
|
+
api_instance = Forgejo::UserApi.new
|
3827
|
+
opts = {
|
3828
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3829
|
+
limit: 56 # Integer | page size of results
|
3830
|
+
}
|
3831
|
+
|
3832
|
+
begin
|
3833
|
+
# List the authenticated user's blocked users
|
3834
|
+
result = api_instance.user_list_blocked_users(opts)
|
3835
|
+
p result
|
3836
|
+
rescue Forgejo::ApiError => e
|
3837
|
+
puts "Error when calling UserApi->user_list_blocked_users: #{e}"
|
3838
|
+
end
|
3839
|
+
```
|
3840
|
+
|
3841
|
+
#### Using the user_list_blocked_users_with_http_info variant
|
3842
|
+
|
3843
|
+
This returns an Array which contains the response data, status code and headers.
|
3844
|
+
|
3845
|
+
> <Array(<Array<BlockedUser>>, Integer, Hash)> user_list_blocked_users_with_http_info(opts)
|
3846
|
+
|
3847
|
+
```ruby
|
3848
|
+
begin
|
3849
|
+
# List the authenticated user's blocked users
|
3850
|
+
data, status_code, headers = api_instance.user_list_blocked_users_with_http_info(opts)
|
3851
|
+
p status_code # => 2xx
|
3852
|
+
p headers # => { ... }
|
3853
|
+
p data # => <Array<BlockedUser>>
|
3854
|
+
rescue Forgejo::ApiError => e
|
3855
|
+
puts "Error when calling UserApi->user_list_blocked_users_with_http_info: #{e}"
|
3856
|
+
end
|
3857
|
+
```
|
3858
|
+
|
3859
|
+
### Parameters
|
3860
|
+
|
3861
|
+
| Name | Type | Description | Notes |
|
3862
|
+
| ---- | ---- | ----------- | ----- |
|
3863
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
3864
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
3865
|
+
|
3866
|
+
### Return type
|
3867
|
+
|
3868
|
+
[**Array<BlockedUser>**](BlockedUser.md)
|
3869
|
+
|
3870
|
+
### Authorization
|
3871
|
+
|
3872
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3873
|
+
|
3874
|
+
### HTTP request headers
|
3875
|
+
|
3876
|
+
- **Content-Type**: Not defined
|
3877
|
+
- **Accept**: application/json
|
3878
|
+
|
3879
|
+
|
3880
|
+
## user_list_emails
|
3881
|
+
|
3882
|
+
> <Array<Email>> user_list_emails
|
3883
|
+
|
3884
|
+
List the authenticated user's email addresses
|
3885
|
+
|
3886
|
+
### Examples
|
3887
|
+
|
3888
|
+
```ruby
|
3889
|
+
require 'time'
|
3890
|
+
require 'forgejo'
|
3891
|
+
# setup authorization
|
3892
|
+
Forgejo.configure do |config|
|
3893
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3894
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3895
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3896
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3897
|
+
end
|
3898
|
+
|
3899
|
+
api_instance = Forgejo::UserApi.new
|
3900
|
+
|
3901
|
+
begin
|
3902
|
+
# List the authenticated user's email addresses
|
3903
|
+
result = api_instance.user_list_emails
|
3904
|
+
p result
|
3905
|
+
rescue Forgejo::ApiError => e
|
3906
|
+
puts "Error when calling UserApi->user_list_emails: #{e}"
|
3907
|
+
end
|
3908
|
+
```
|
3909
|
+
|
3910
|
+
#### Using the user_list_emails_with_http_info variant
|
3911
|
+
|
3912
|
+
This returns an Array which contains the response data, status code and headers.
|
3913
|
+
|
3914
|
+
> <Array(<Array<Email>>, Integer, Hash)> user_list_emails_with_http_info
|
3915
|
+
|
3916
|
+
```ruby
|
3917
|
+
begin
|
3918
|
+
# List the authenticated user's email addresses
|
3919
|
+
data, status_code, headers = api_instance.user_list_emails_with_http_info
|
3920
|
+
p status_code # => 2xx
|
3921
|
+
p headers # => { ... }
|
3922
|
+
p data # => <Array<Email>>
|
3923
|
+
rescue Forgejo::ApiError => e
|
3924
|
+
puts "Error when calling UserApi->user_list_emails_with_http_info: #{e}"
|
3925
|
+
end
|
3926
|
+
```
|
3927
|
+
|
3928
|
+
### Parameters
|
3929
|
+
|
3930
|
+
This endpoint does not need any parameter.
|
3931
|
+
|
3932
|
+
### Return type
|
3933
|
+
|
3934
|
+
[**Array<Email>**](Email.md)
|
3935
|
+
|
3936
|
+
### Authorization
|
3937
|
+
|
3938
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
3939
|
+
|
3940
|
+
### HTTP request headers
|
3941
|
+
|
3942
|
+
- **Content-Type**: Not defined
|
3943
|
+
- **Accept**: application/json
|
3944
|
+
|
3945
|
+
|
3946
|
+
## user_list_followers
|
3947
|
+
|
3948
|
+
> <Array<User>> user_list_followers(username, opts)
|
3949
|
+
|
3950
|
+
List the given user's followers
|
3951
|
+
|
3952
|
+
### Examples
|
3953
|
+
|
3954
|
+
```ruby
|
3955
|
+
require 'time'
|
3956
|
+
require 'forgejo'
|
3957
|
+
# setup authorization
|
3958
|
+
Forgejo.configure do |config|
|
3959
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
3960
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
3961
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
3962
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
3963
|
+
end
|
3964
|
+
|
3965
|
+
api_instance = Forgejo::UserApi.new
|
3966
|
+
username = 'username_example' # String | username of user
|
3967
|
+
opts = {
|
3968
|
+
page: 56, # Integer | page number of results to return (1-based)
|
3969
|
+
limit: 56 # Integer | page size of results
|
3970
|
+
}
|
3971
|
+
|
3972
|
+
begin
|
3973
|
+
# List the given user's followers
|
3974
|
+
result = api_instance.user_list_followers(username, opts)
|
3975
|
+
p result
|
3976
|
+
rescue Forgejo::ApiError => e
|
3977
|
+
puts "Error when calling UserApi->user_list_followers: #{e}"
|
3978
|
+
end
|
3979
|
+
```
|
3980
|
+
|
3981
|
+
#### Using the user_list_followers_with_http_info variant
|
3982
|
+
|
3983
|
+
This returns an Array which contains the response data, status code and headers.
|
3984
|
+
|
3985
|
+
> <Array(<Array<User>>, Integer, Hash)> user_list_followers_with_http_info(username, opts)
|
3986
|
+
|
3987
|
+
```ruby
|
3988
|
+
begin
|
3989
|
+
# List the given user's followers
|
3990
|
+
data, status_code, headers = api_instance.user_list_followers_with_http_info(username, opts)
|
3991
|
+
p status_code # => 2xx
|
3992
|
+
p headers # => { ... }
|
3993
|
+
p data # => <Array<User>>
|
3994
|
+
rescue Forgejo::ApiError => e
|
3995
|
+
puts "Error when calling UserApi->user_list_followers_with_http_info: #{e}"
|
3996
|
+
end
|
3997
|
+
```
|
3998
|
+
|
3999
|
+
### Parameters
|
4000
|
+
|
4001
|
+
| Name | Type | Description | Notes |
|
4002
|
+
| ---- | ---- | ----------- | ----- |
|
4003
|
+
| **username** | **String** | username of user | |
|
4004
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4005
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4006
|
+
|
4007
|
+
### Return type
|
4008
|
+
|
4009
|
+
[**Array<User>**](User.md)
|
4010
|
+
|
4011
|
+
### Authorization
|
4012
|
+
|
4013
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4014
|
+
|
4015
|
+
### HTTP request headers
|
4016
|
+
|
4017
|
+
- **Content-Type**: Not defined
|
4018
|
+
- **Accept**: application/json
|
4019
|
+
|
4020
|
+
|
4021
|
+
## user_list_following
|
4022
|
+
|
4023
|
+
> <Array<User>> user_list_following(username, opts)
|
4024
|
+
|
4025
|
+
List the users that the given user is following
|
4026
|
+
|
4027
|
+
### Examples
|
4028
|
+
|
4029
|
+
```ruby
|
4030
|
+
require 'time'
|
4031
|
+
require 'forgejo'
|
4032
|
+
# setup authorization
|
4033
|
+
Forgejo.configure do |config|
|
4034
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4035
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4036
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4037
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4038
|
+
end
|
4039
|
+
|
4040
|
+
api_instance = Forgejo::UserApi.new
|
4041
|
+
username = 'username_example' # String | username of user
|
4042
|
+
opts = {
|
4043
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4044
|
+
limit: 56 # Integer | page size of results
|
4045
|
+
}
|
4046
|
+
|
4047
|
+
begin
|
4048
|
+
# List the users that the given user is following
|
4049
|
+
result = api_instance.user_list_following(username, opts)
|
4050
|
+
p result
|
4051
|
+
rescue Forgejo::ApiError => e
|
4052
|
+
puts "Error when calling UserApi->user_list_following: #{e}"
|
4053
|
+
end
|
4054
|
+
```
|
4055
|
+
|
4056
|
+
#### Using the user_list_following_with_http_info variant
|
4057
|
+
|
4058
|
+
This returns an Array which contains the response data, status code and headers.
|
4059
|
+
|
4060
|
+
> <Array(<Array<User>>, Integer, Hash)> user_list_following_with_http_info(username, opts)
|
4061
|
+
|
4062
|
+
```ruby
|
4063
|
+
begin
|
4064
|
+
# List the users that the given user is following
|
4065
|
+
data, status_code, headers = api_instance.user_list_following_with_http_info(username, opts)
|
4066
|
+
p status_code # => 2xx
|
4067
|
+
p headers # => { ... }
|
4068
|
+
p data # => <Array<User>>
|
4069
|
+
rescue Forgejo::ApiError => e
|
4070
|
+
puts "Error when calling UserApi->user_list_following_with_http_info: #{e}"
|
4071
|
+
end
|
4072
|
+
```
|
4073
|
+
|
4074
|
+
### Parameters
|
4075
|
+
|
4076
|
+
| Name | Type | Description | Notes |
|
4077
|
+
| ---- | ---- | ----------- | ----- |
|
4078
|
+
| **username** | **String** | username of user | |
|
4079
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4080
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4081
|
+
|
4082
|
+
### Return type
|
4083
|
+
|
4084
|
+
[**Array<User>**](User.md)
|
4085
|
+
|
4086
|
+
### Authorization
|
4087
|
+
|
4088
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4089
|
+
|
4090
|
+
### HTTP request headers
|
4091
|
+
|
4092
|
+
- **Content-Type**: Not defined
|
4093
|
+
- **Accept**: application/json
|
4094
|
+
|
4095
|
+
|
4096
|
+
## user_list_gpg_keys
|
4097
|
+
|
4098
|
+
> <Array<GPGKey>> user_list_gpg_keys(username, opts)
|
4099
|
+
|
4100
|
+
List the given user's GPG keys
|
4101
|
+
|
4102
|
+
### Examples
|
4103
|
+
|
4104
|
+
```ruby
|
4105
|
+
require 'time'
|
4106
|
+
require 'forgejo'
|
4107
|
+
# setup authorization
|
4108
|
+
Forgejo.configure do |config|
|
4109
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4110
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4111
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4112
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4113
|
+
end
|
4114
|
+
|
4115
|
+
api_instance = Forgejo::UserApi.new
|
4116
|
+
username = 'username_example' # String | username of user
|
4117
|
+
opts = {
|
4118
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4119
|
+
limit: 56 # Integer | page size of results
|
4120
|
+
}
|
4121
|
+
|
4122
|
+
begin
|
4123
|
+
# List the given user's GPG keys
|
4124
|
+
result = api_instance.user_list_gpg_keys(username, opts)
|
4125
|
+
p result
|
4126
|
+
rescue Forgejo::ApiError => e
|
4127
|
+
puts "Error when calling UserApi->user_list_gpg_keys: #{e}"
|
4128
|
+
end
|
4129
|
+
```
|
4130
|
+
|
4131
|
+
#### Using the user_list_gpg_keys_with_http_info variant
|
4132
|
+
|
4133
|
+
This returns an Array which contains the response data, status code and headers.
|
4134
|
+
|
4135
|
+
> <Array(<Array<GPGKey>>, Integer, Hash)> user_list_gpg_keys_with_http_info(username, opts)
|
4136
|
+
|
4137
|
+
```ruby
|
4138
|
+
begin
|
4139
|
+
# List the given user's GPG keys
|
4140
|
+
data, status_code, headers = api_instance.user_list_gpg_keys_with_http_info(username, opts)
|
4141
|
+
p status_code # => 2xx
|
4142
|
+
p headers # => { ... }
|
4143
|
+
p data # => <Array<GPGKey>>
|
4144
|
+
rescue Forgejo::ApiError => e
|
4145
|
+
puts "Error when calling UserApi->user_list_gpg_keys_with_http_info: #{e}"
|
4146
|
+
end
|
4147
|
+
```
|
4148
|
+
|
4149
|
+
### Parameters
|
4150
|
+
|
4151
|
+
| Name | Type | Description | Notes |
|
4152
|
+
| ---- | ---- | ----------- | ----- |
|
4153
|
+
| **username** | **String** | username of user | |
|
4154
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4155
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4156
|
+
|
4157
|
+
### Return type
|
4158
|
+
|
4159
|
+
[**Array<GPGKey>**](GPGKey.md)
|
4160
|
+
|
4161
|
+
### Authorization
|
4162
|
+
|
4163
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4164
|
+
|
4165
|
+
### HTTP request headers
|
4166
|
+
|
4167
|
+
- **Content-Type**: Not defined
|
4168
|
+
- **Accept**: application/json
|
4169
|
+
|
4170
|
+
|
4171
|
+
## user_list_hooks
|
4172
|
+
|
4173
|
+
> <Array<Hook>> user_list_hooks(opts)
|
4174
|
+
|
4175
|
+
List the authenticated user's webhooks
|
4176
|
+
|
4177
|
+
### Examples
|
4178
|
+
|
4179
|
+
```ruby
|
4180
|
+
require 'time'
|
4181
|
+
require 'forgejo'
|
4182
|
+
# setup authorization
|
4183
|
+
Forgejo.configure do |config|
|
4184
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4185
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4186
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4187
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4188
|
+
end
|
4189
|
+
|
4190
|
+
api_instance = Forgejo::UserApi.new
|
4191
|
+
opts = {
|
4192
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4193
|
+
limit: 56 # Integer | page size of results
|
4194
|
+
}
|
4195
|
+
|
4196
|
+
begin
|
4197
|
+
# List the authenticated user's webhooks
|
4198
|
+
result = api_instance.user_list_hooks(opts)
|
4199
|
+
p result
|
4200
|
+
rescue Forgejo::ApiError => e
|
4201
|
+
puts "Error when calling UserApi->user_list_hooks: #{e}"
|
4202
|
+
end
|
4203
|
+
```
|
4204
|
+
|
4205
|
+
#### Using the user_list_hooks_with_http_info variant
|
4206
|
+
|
4207
|
+
This returns an Array which contains the response data, status code and headers.
|
4208
|
+
|
4209
|
+
> <Array(<Array<Hook>>, Integer, Hash)> user_list_hooks_with_http_info(opts)
|
4210
|
+
|
4211
|
+
```ruby
|
4212
|
+
begin
|
4213
|
+
# List the authenticated user's webhooks
|
4214
|
+
data, status_code, headers = api_instance.user_list_hooks_with_http_info(opts)
|
4215
|
+
p status_code # => 2xx
|
4216
|
+
p headers # => { ... }
|
4217
|
+
p data # => <Array<Hook>>
|
4218
|
+
rescue Forgejo::ApiError => e
|
4219
|
+
puts "Error when calling UserApi->user_list_hooks_with_http_info: #{e}"
|
4220
|
+
end
|
4221
|
+
```
|
4222
|
+
|
4223
|
+
### Parameters
|
4224
|
+
|
4225
|
+
| Name | Type | Description | Notes |
|
4226
|
+
| ---- | ---- | ----------- | ----- |
|
4227
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4228
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4229
|
+
|
4230
|
+
### Return type
|
4231
|
+
|
4232
|
+
[**Array<Hook>**](Hook.md)
|
4233
|
+
|
4234
|
+
### Authorization
|
4235
|
+
|
4236
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4237
|
+
|
4238
|
+
### HTTP request headers
|
4239
|
+
|
4240
|
+
- **Content-Type**: Not defined
|
4241
|
+
- **Accept**: application/json
|
4242
|
+
|
4243
|
+
|
4244
|
+
## user_list_keys
|
4245
|
+
|
4246
|
+
> <Array<PublicKey>> user_list_keys(username, opts)
|
4247
|
+
|
4248
|
+
List the given user's public keys
|
4249
|
+
|
4250
|
+
### Examples
|
4251
|
+
|
4252
|
+
```ruby
|
4253
|
+
require 'time'
|
4254
|
+
require 'forgejo'
|
4255
|
+
# setup authorization
|
4256
|
+
Forgejo.configure do |config|
|
4257
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4258
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4259
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4260
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4261
|
+
end
|
4262
|
+
|
4263
|
+
api_instance = Forgejo::UserApi.new
|
4264
|
+
username = 'username_example' # String | username of user
|
4265
|
+
opts = {
|
4266
|
+
fingerprint: 'fingerprint_example', # String | fingerprint of the key
|
4267
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4268
|
+
limit: 56 # Integer | page size of results
|
4269
|
+
}
|
4270
|
+
|
4271
|
+
begin
|
4272
|
+
# List the given user's public keys
|
4273
|
+
result = api_instance.user_list_keys(username, opts)
|
4274
|
+
p result
|
4275
|
+
rescue Forgejo::ApiError => e
|
4276
|
+
puts "Error when calling UserApi->user_list_keys: #{e}"
|
4277
|
+
end
|
4278
|
+
```
|
4279
|
+
|
4280
|
+
#### Using the user_list_keys_with_http_info variant
|
4281
|
+
|
4282
|
+
This returns an Array which contains the response data, status code and headers.
|
4283
|
+
|
4284
|
+
> <Array(<Array<PublicKey>>, Integer, Hash)> user_list_keys_with_http_info(username, opts)
|
4285
|
+
|
4286
|
+
```ruby
|
4287
|
+
begin
|
4288
|
+
# List the given user's public keys
|
4289
|
+
data, status_code, headers = api_instance.user_list_keys_with_http_info(username, opts)
|
4290
|
+
p status_code # => 2xx
|
4291
|
+
p headers # => { ... }
|
4292
|
+
p data # => <Array<PublicKey>>
|
4293
|
+
rescue Forgejo::ApiError => e
|
4294
|
+
puts "Error when calling UserApi->user_list_keys_with_http_info: #{e}"
|
4295
|
+
end
|
4296
|
+
```
|
4297
|
+
|
4298
|
+
### Parameters
|
4299
|
+
|
4300
|
+
| Name | Type | Description | Notes |
|
4301
|
+
| ---- | ---- | ----------- | ----- |
|
4302
|
+
| **username** | **String** | username of user | |
|
4303
|
+
| **fingerprint** | **String** | fingerprint of the key | [optional] |
|
4304
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4305
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4306
|
+
|
4307
|
+
### Return type
|
4308
|
+
|
4309
|
+
[**Array<PublicKey>**](PublicKey.md)
|
4310
|
+
|
4311
|
+
### Authorization
|
4312
|
+
|
4313
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4314
|
+
|
4315
|
+
### HTTP request headers
|
4316
|
+
|
4317
|
+
- **Content-Type**: Not defined
|
4318
|
+
- **Accept**: application/json
|
4319
|
+
|
4320
|
+
|
4321
|
+
## user_list_repos
|
4322
|
+
|
4323
|
+
> <Array<Repository>> user_list_repos(username, opts)
|
4324
|
+
|
4325
|
+
List the repos owned by the given user
|
4326
|
+
|
4327
|
+
### Examples
|
4328
|
+
|
4329
|
+
```ruby
|
4330
|
+
require 'time'
|
4331
|
+
require 'forgejo'
|
4332
|
+
# setup authorization
|
4333
|
+
Forgejo.configure do |config|
|
4334
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4335
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4336
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4337
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4338
|
+
end
|
4339
|
+
|
4340
|
+
api_instance = Forgejo::UserApi.new
|
4341
|
+
username = 'username_example' # String | username of user
|
4342
|
+
opts = {
|
4343
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4344
|
+
limit: 56 # Integer | page size of results
|
4345
|
+
}
|
4346
|
+
|
4347
|
+
begin
|
4348
|
+
# List the repos owned by the given user
|
4349
|
+
result = api_instance.user_list_repos(username, opts)
|
4350
|
+
p result
|
4351
|
+
rescue Forgejo::ApiError => e
|
4352
|
+
puts "Error when calling UserApi->user_list_repos: #{e}"
|
4353
|
+
end
|
4354
|
+
```
|
4355
|
+
|
4356
|
+
#### Using the user_list_repos_with_http_info variant
|
4357
|
+
|
4358
|
+
This returns an Array which contains the response data, status code and headers.
|
4359
|
+
|
4360
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_list_repos_with_http_info(username, opts)
|
4361
|
+
|
4362
|
+
```ruby
|
4363
|
+
begin
|
4364
|
+
# List the repos owned by the given user
|
4365
|
+
data, status_code, headers = api_instance.user_list_repos_with_http_info(username, opts)
|
4366
|
+
p status_code # => 2xx
|
4367
|
+
p headers # => { ... }
|
4368
|
+
p data # => <Array<Repository>>
|
4369
|
+
rescue Forgejo::ApiError => e
|
4370
|
+
puts "Error when calling UserApi->user_list_repos_with_http_info: #{e}"
|
4371
|
+
end
|
4372
|
+
```
|
4373
|
+
|
4374
|
+
### Parameters
|
4375
|
+
|
4376
|
+
| Name | Type | Description | Notes |
|
4377
|
+
| ---- | ---- | ----------- | ----- |
|
4378
|
+
| **username** | **String** | username of user | |
|
4379
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4380
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4381
|
+
|
4382
|
+
### Return type
|
4383
|
+
|
4384
|
+
[**Array<Repository>**](Repository.md)
|
4385
|
+
|
4386
|
+
### Authorization
|
4387
|
+
|
4388
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4389
|
+
|
4390
|
+
### HTTP request headers
|
4391
|
+
|
4392
|
+
- **Content-Type**: Not defined
|
4393
|
+
- **Accept**: application/json
|
4394
|
+
|
4395
|
+
|
4396
|
+
## user_list_starred
|
4397
|
+
|
4398
|
+
> <Array<Repository>> user_list_starred(username, opts)
|
4399
|
+
|
4400
|
+
The repos that the given user has starred
|
4401
|
+
|
4402
|
+
### Examples
|
4403
|
+
|
4404
|
+
```ruby
|
4405
|
+
require 'time'
|
4406
|
+
require 'forgejo'
|
4407
|
+
# setup authorization
|
4408
|
+
Forgejo.configure do |config|
|
4409
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4410
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4411
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4412
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4413
|
+
end
|
4414
|
+
|
4415
|
+
api_instance = Forgejo::UserApi.new
|
4416
|
+
username = 'username_example' # String | username of user
|
4417
|
+
opts = {
|
4418
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4419
|
+
limit: 56 # Integer | page size of results
|
4420
|
+
}
|
4421
|
+
|
4422
|
+
begin
|
4423
|
+
# The repos that the given user has starred
|
4424
|
+
result = api_instance.user_list_starred(username, opts)
|
4425
|
+
p result
|
4426
|
+
rescue Forgejo::ApiError => e
|
4427
|
+
puts "Error when calling UserApi->user_list_starred: #{e}"
|
4428
|
+
end
|
4429
|
+
```
|
4430
|
+
|
4431
|
+
#### Using the user_list_starred_with_http_info variant
|
4432
|
+
|
4433
|
+
This returns an Array which contains the response data, status code and headers.
|
4434
|
+
|
4435
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_list_starred_with_http_info(username, opts)
|
4436
|
+
|
4437
|
+
```ruby
|
4438
|
+
begin
|
4439
|
+
# The repos that the given user has starred
|
4440
|
+
data, status_code, headers = api_instance.user_list_starred_with_http_info(username, opts)
|
4441
|
+
p status_code # => 2xx
|
4442
|
+
p headers # => { ... }
|
4443
|
+
p data # => <Array<Repository>>
|
4444
|
+
rescue Forgejo::ApiError => e
|
4445
|
+
puts "Error when calling UserApi->user_list_starred_with_http_info: #{e}"
|
4446
|
+
end
|
4447
|
+
```
|
4448
|
+
|
4449
|
+
### Parameters
|
4450
|
+
|
4451
|
+
| Name | Type | Description | Notes |
|
4452
|
+
| ---- | ---- | ----------- | ----- |
|
4453
|
+
| **username** | **String** | username of user | |
|
4454
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4455
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4456
|
+
|
4457
|
+
### Return type
|
4458
|
+
|
4459
|
+
[**Array<Repository>**](Repository.md)
|
4460
|
+
|
4461
|
+
### Authorization
|
4462
|
+
|
4463
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4464
|
+
|
4465
|
+
### HTTP request headers
|
4466
|
+
|
4467
|
+
- **Content-Type**: Not defined
|
4468
|
+
- **Accept**: application/json
|
4469
|
+
|
4470
|
+
|
4471
|
+
## user_list_subscriptions
|
4472
|
+
|
4473
|
+
> <Array<Repository>> user_list_subscriptions(username, opts)
|
4474
|
+
|
4475
|
+
List the repositories watched by a user
|
4476
|
+
|
4477
|
+
### Examples
|
4478
|
+
|
4479
|
+
```ruby
|
4480
|
+
require 'time'
|
4481
|
+
require 'forgejo'
|
4482
|
+
# setup authorization
|
4483
|
+
Forgejo.configure do |config|
|
4484
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4485
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4486
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4487
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4488
|
+
end
|
4489
|
+
|
4490
|
+
api_instance = Forgejo::UserApi.new
|
4491
|
+
username = 'username_example' # String | username of the user
|
4492
|
+
opts = {
|
4493
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4494
|
+
limit: 56 # Integer | page size of results
|
4495
|
+
}
|
4496
|
+
|
4497
|
+
begin
|
4498
|
+
# List the repositories watched by a user
|
4499
|
+
result = api_instance.user_list_subscriptions(username, opts)
|
4500
|
+
p result
|
4501
|
+
rescue Forgejo::ApiError => e
|
4502
|
+
puts "Error when calling UserApi->user_list_subscriptions: #{e}"
|
4503
|
+
end
|
4504
|
+
```
|
4505
|
+
|
4506
|
+
#### Using the user_list_subscriptions_with_http_info variant
|
4507
|
+
|
4508
|
+
This returns an Array which contains the response data, status code and headers.
|
4509
|
+
|
4510
|
+
> <Array(<Array<Repository>>, Integer, Hash)> user_list_subscriptions_with_http_info(username, opts)
|
4511
|
+
|
4512
|
+
```ruby
|
4513
|
+
begin
|
4514
|
+
# List the repositories watched by a user
|
4515
|
+
data, status_code, headers = api_instance.user_list_subscriptions_with_http_info(username, opts)
|
4516
|
+
p status_code # => 2xx
|
4517
|
+
p headers # => { ... }
|
4518
|
+
p data # => <Array<Repository>>
|
4519
|
+
rescue Forgejo::ApiError => e
|
4520
|
+
puts "Error when calling UserApi->user_list_subscriptions_with_http_info: #{e}"
|
4521
|
+
end
|
4522
|
+
```
|
4523
|
+
|
4524
|
+
### Parameters
|
4525
|
+
|
4526
|
+
| Name | Type | Description | Notes |
|
4527
|
+
| ---- | ---- | ----------- | ----- |
|
4528
|
+
| **username** | **String** | username of the user | |
|
4529
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4530
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4531
|
+
|
4532
|
+
### Return type
|
4533
|
+
|
4534
|
+
[**Array<Repository>**](Repository.md)
|
4535
|
+
|
4536
|
+
### Authorization
|
4537
|
+
|
4538
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4539
|
+
|
4540
|
+
### HTTP request headers
|
4541
|
+
|
4542
|
+
- **Content-Type**: Not defined
|
4543
|
+
- **Accept**: application/json
|
4544
|
+
|
4545
|
+
|
4546
|
+
## user_list_teams
|
4547
|
+
|
4548
|
+
> <Array<Team>> user_list_teams(opts)
|
4549
|
+
|
4550
|
+
List all the teams a user belongs to
|
4551
|
+
|
4552
|
+
### Examples
|
4553
|
+
|
4554
|
+
```ruby
|
4555
|
+
require 'time'
|
4556
|
+
require 'forgejo'
|
4557
|
+
# setup authorization
|
4558
|
+
Forgejo.configure do |config|
|
4559
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4560
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4561
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4562
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4563
|
+
end
|
4564
|
+
|
4565
|
+
api_instance = Forgejo::UserApi.new
|
4566
|
+
opts = {
|
4567
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4568
|
+
limit: 56 # Integer | page size of results
|
4569
|
+
}
|
4570
|
+
|
4571
|
+
begin
|
4572
|
+
# List all the teams a user belongs to
|
4573
|
+
result = api_instance.user_list_teams(opts)
|
4574
|
+
p result
|
4575
|
+
rescue Forgejo::ApiError => e
|
4576
|
+
puts "Error when calling UserApi->user_list_teams: #{e}"
|
4577
|
+
end
|
4578
|
+
```
|
4579
|
+
|
4580
|
+
#### Using the user_list_teams_with_http_info variant
|
4581
|
+
|
4582
|
+
This returns an Array which contains the response data, status code and headers.
|
4583
|
+
|
4584
|
+
> <Array(<Array<Team>>, Integer, Hash)> user_list_teams_with_http_info(opts)
|
4585
|
+
|
4586
|
+
```ruby
|
4587
|
+
begin
|
4588
|
+
# List all the teams a user belongs to
|
4589
|
+
data, status_code, headers = api_instance.user_list_teams_with_http_info(opts)
|
4590
|
+
p status_code # => 2xx
|
4591
|
+
p headers # => { ... }
|
4592
|
+
p data # => <Array<Team>>
|
4593
|
+
rescue Forgejo::ApiError => e
|
4594
|
+
puts "Error when calling UserApi->user_list_teams_with_http_info: #{e}"
|
4595
|
+
end
|
4596
|
+
```
|
4597
|
+
|
4598
|
+
### Parameters
|
4599
|
+
|
4600
|
+
| Name | Type | Description | Notes |
|
4601
|
+
| ---- | ---- | ----------- | ----- |
|
4602
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4603
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4604
|
+
|
4605
|
+
### Return type
|
4606
|
+
|
4607
|
+
[**Array<Team>**](Team.md)
|
4608
|
+
|
4609
|
+
### Authorization
|
4610
|
+
|
4611
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4612
|
+
|
4613
|
+
### HTTP request headers
|
4614
|
+
|
4615
|
+
- **Content-Type**: Not defined
|
4616
|
+
- **Accept**: application/json
|
4617
|
+
|
4618
|
+
|
4619
|
+
## user_search
|
4620
|
+
|
4621
|
+
> <UserSearch200Response> user_search(opts)
|
4622
|
+
|
4623
|
+
Search for users
|
4624
|
+
|
4625
|
+
### Examples
|
4626
|
+
|
4627
|
+
```ruby
|
4628
|
+
require 'time'
|
4629
|
+
require 'forgejo'
|
4630
|
+
# setup authorization
|
4631
|
+
Forgejo.configure do |config|
|
4632
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4633
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4634
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4635
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4636
|
+
end
|
4637
|
+
|
4638
|
+
api_instance = Forgejo::UserApi.new
|
4639
|
+
opts = {
|
4640
|
+
q: 'q_example', # String | keyword
|
4641
|
+
uid: 789, # Integer | ID of the user to search for
|
4642
|
+
page: 56, # Integer | page number of results to return (1-based)
|
4643
|
+
limit: 56 # Integer | page size of results
|
4644
|
+
}
|
4645
|
+
|
4646
|
+
begin
|
4647
|
+
# Search for users
|
4648
|
+
result = api_instance.user_search(opts)
|
4649
|
+
p result
|
4650
|
+
rescue Forgejo::ApiError => e
|
4651
|
+
puts "Error when calling UserApi->user_search: #{e}"
|
4652
|
+
end
|
4653
|
+
```
|
4654
|
+
|
4655
|
+
#### Using the user_search_with_http_info variant
|
4656
|
+
|
4657
|
+
This returns an Array which contains the response data, status code and headers.
|
4658
|
+
|
4659
|
+
> <Array(<UserSearch200Response>, Integer, Hash)> user_search_with_http_info(opts)
|
4660
|
+
|
4661
|
+
```ruby
|
4662
|
+
begin
|
4663
|
+
# Search for users
|
4664
|
+
data, status_code, headers = api_instance.user_search_with_http_info(opts)
|
4665
|
+
p status_code # => 2xx
|
4666
|
+
p headers # => { ... }
|
4667
|
+
p data # => <UserSearch200Response>
|
4668
|
+
rescue Forgejo::ApiError => e
|
4669
|
+
puts "Error when calling UserApi->user_search_with_http_info: #{e}"
|
4670
|
+
end
|
4671
|
+
```
|
4672
|
+
|
4673
|
+
### Parameters
|
4674
|
+
|
4675
|
+
| Name | Type | Description | Notes |
|
4676
|
+
| ---- | ---- | ----------- | ----- |
|
4677
|
+
| **q** | **String** | keyword | [optional] |
|
4678
|
+
| **uid** | **Integer** | ID of the user to search for | [optional] |
|
4679
|
+
| **page** | **Integer** | page number of results to return (1-based) | [optional] |
|
4680
|
+
| **limit** | **Integer** | page size of results | [optional] |
|
4681
|
+
|
4682
|
+
### Return type
|
4683
|
+
|
4684
|
+
[**UserSearch200Response**](UserSearch200Response.md)
|
4685
|
+
|
4686
|
+
### Authorization
|
4687
|
+
|
4688
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4689
|
+
|
4690
|
+
### HTTP request headers
|
4691
|
+
|
4692
|
+
- **Content-Type**: Not defined
|
4693
|
+
- **Accept**: application/json
|
4694
|
+
|
4695
|
+
|
4696
|
+
## user_unblock_user
|
4697
|
+
|
4698
|
+
> user_unblock_user(username)
|
4699
|
+
|
4700
|
+
Unblocks a user from the doer.
|
4701
|
+
|
4702
|
+
### Examples
|
4703
|
+
|
4704
|
+
```ruby
|
4705
|
+
require 'time'
|
4706
|
+
require 'forgejo'
|
4707
|
+
# setup authorization
|
4708
|
+
Forgejo.configure do |config|
|
4709
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4710
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4711
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4712
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4713
|
+
end
|
4714
|
+
|
4715
|
+
api_instance = Forgejo::UserApi.new
|
4716
|
+
username = 'username_example' # String | username of the user
|
4717
|
+
|
4718
|
+
begin
|
4719
|
+
# Unblocks a user from the doer.
|
4720
|
+
api_instance.user_unblock_user(username)
|
4721
|
+
rescue Forgejo::ApiError => e
|
4722
|
+
puts "Error when calling UserApi->user_unblock_user: #{e}"
|
4723
|
+
end
|
4724
|
+
```
|
4725
|
+
|
4726
|
+
#### Using the user_unblock_user_with_http_info variant
|
4727
|
+
|
4728
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
4729
|
+
|
4730
|
+
> <Array(nil, Integer, Hash)> user_unblock_user_with_http_info(username)
|
4731
|
+
|
4732
|
+
```ruby
|
4733
|
+
begin
|
4734
|
+
# Unblocks a user from the doer.
|
4735
|
+
data, status_code, headers = api_instance.user_unblock_user_with_http_info(username)
|
4736
|
+
p status_code # => 2xx
|
4737
|
+
p headers # => { ... }
|
4738
|
+
p data # => nil
|
4739
|
+
rescue Forgejo::ApiError => e
|
4740
|
+
puts "Error when calling UserApi->user_unblock_user_with_http_info: #{e}"
|
4741
|
+
end
|
4742
|
+
```
|
4743
|
+
|
4744
|
+
### Parameters
|
4745
|
+
|
4746
|
+
| Name | Type | Description | Notes |
|
4747
|
+
| ---- | ---- | ----------- | ----- |
|
4748
|
+
| **username** | **String** | username of the user | |
|
4749
|
+
|
4750
|
+
### Return type
|
4751
|
+
|
4752
|
+
nil (empty response body)
|
4753
|
+
|
4754
|
+
### Authorization
|
4755
|
+
|
4756
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4757
|
+
|
4758
|
+
### HTTP request headers
|
4759
|
+
|
4760
|
+
- **Content-Type**: Not defined
|
4761
|
+
- **Accept**: Not defined
|
4762
|
+
|
4763
|
+
|
4764
|
+
## user_update_avatar
|
4765
|
+
|
4766
|
+
> user_update_avatar(opts)
|
4767
|
+
|
4768
|
+
Update Avatar
|
4769
|
+
|
4770
|
+
### Examples
|
4771
|
+
|
4772
|
+
```ruby
|
4773
|
+
require 'time'
|
4774
|
+
require 'forgejo'
|
4775
|
+
# setup authorization
|
4776
|
+
Forgejo.configure do |config|
|
4777
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4778
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4779
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4780
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4781
|
+
end
|
4782
|
+
|
4783
|
+
api_instance = Forgejo::UserApi.new
|
4784
|
+
opts = {
|
4785
|
+
body: Forgejo::UpdateUserAvatarOption.new # UpdateUserAvatarOption |
|
4786
|
+
}
|
4787
|
+
|
4788
|
+
begin
|
4789
|
+
# Update Avatar
|
4790
|
+
api_instance.user_update_avatar(opts)
|
4791
|
+
rescue Forgejo::ApiError => e
|
4792
|
+
puts "Error when calling UserApi->user_update_avatar: #{e}"
|
4793
|
+
end
|
4794
|
+
```
|
4795
|
+
|
4796
|
+
#### Using the user_update_avatar_with_http_info variant
|
4797
|
+
|
4798
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
4799
|
+
|
4800
|
+
> <Array(nil, Integer, Hash)> user_update_avatar_with_http_info(opts)
|
4801
|
+
|
4802
|
+
```ruby
|
4803
|
+
begin
|
4804
|
+
# Update Avatar
|
4805
|
+
data, status_code, headers = api_instance.user_update_avatar_with_http_info(opts)
|
4806
|
+
p status_code # => 2xx
|
4807
|
+
p headers # => { ... }
|
4808
|
+
p data # => nil
|
4809
|
+
rescue Forgejo::ApiError => e
|
4810
|
+
puts "Error when calling UserApi->user_update_avatar_with_http_info: #{e}"
|
4811
|
+
end
|
4812
|
+
```
|
4813
|
+
|
4814
|
+
### Parameters
|
4815
|
+
|
4816
|
+
| Name | Type | Description | Notes |
|
4817
|
+
| ---- | ---- | ----------- | ----- |
|
4818
|
+
| **body** | [**UpdateUserAvatarOption**](UpdateUserAvatarOption.md) | | [optional] |
|
4819
|
+
|
4820
|
+
### Return type
|
4821
|
+
|
4822
|
+
nil (empty response body)
|
4823
|
+
|
4824
|
+
### Authorization
|
4825
|
+
|
4826
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4827
|
+
|
4828
|
+
### HTTP request headers
|
4829
|
+
|
4830
|
+
- **Content-Type**: application/json, text/plain
|
4831
|
+
- **Accept**: Not defined
|
4832
|
+
|
4833
|
+
|
4834
|
+
## user_update_o_auth2_application
|
4835
|
+
|
4836
|
+
> <OAuth2Application> user_update_o_auth2_application(id, body)
|
4837
|
+
|
4838
|
+
update an OAuth2 Application, this includes regenerating the client secret
|
4839
|
+
|
4840
|
+
### Examples
|
4841
|
+
|
4842
|
+
```ruby
|
4843
|
+
require 'time'
|
4844
|
+
require 'forgejo'
|
4845
|
+
# setup authorization
|
4846
|
+
Forgejo.configure do |config|
|
4847
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4848
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4849
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4850
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4851
|
+
end
|
4852
|
+
|
4853
|
+
api_instance = Forgejo::UserApi.new
|
4854
|
+
id = 789 # Integer | application to be updated
|
4855
|
+
body = Forgejo::CreateOAuth2ApplicationOptions.new # CreateOAuth2ApplicationOptions |
|
4856
|
+
|
4857
|
+
begin
|
4858
|
+
# update an OAuth2 Application, this includes regenerating the client secret
|
4859
|
+
result = api_instance.user_update_o_auth2_application(id, body)
|
4860
|
+
p result
|
4861
|
+
rescue Forgejo::ApiError => e
|
4862
|
+
puts "Error when calling UserApi->user_update_o_auth2_application: #{e}"
|
4863
|
+
end
|
4864
|
+
```
|
4865
|
+
|
4866
|
+
#### Using the user_update_o_auth2_application_with_http_info variant
|
4867
|
+
|
4868
|
+
This returns an Array which contains the response data, status code and headers.
|
4869
|
+
|
4870
|
+
> <Array(<OAuth2Application>, Integer, Hash)> user_update_o_auth2_application_with_http_info(id, body)
|
4871
|
+
|
4872
|
+
```ruby
|
4873
|
+
begin
|
4874
|
+
# update an OAuth2 Application, this includes regenerating the client secret
|
4875
|
+
data, status_code, headers = api_instance.user_update_o_auth2_application_with_http_info(id, body)
|
4876
|
+
p status_code # => 2xx
|
4877
|
+
p headers # => { ... }
|
4878
|
+
p data # => <OAuth2Application>
|
4879
|
+
rescue Forgejo::ApiError => e
|
4880
|
+
puts "Error when calling UserApi->user_update_o_auth2_application_with_http_info: #{e}"
|
4881
|
+
end
|
4882
|
+
```
|
4883
|
+
|
4884
|
+
### Parameters
|
4885
|
+
|
4886
|
+
| Name | Type | Description | Notes |
|
4887
|
+
| ---- | ---- | ----------- | ----- |
|
4888
|
+
| **id** | **Integer** | application to be updated | |
|
4889
|
+
| **body** | [**CreateOAuth2ApplicationOptions**](CreateOAuth2ApplicationOptions.md) | | |
|
4890
|
+
|
4891
|
+
### Return type
|
4892
|
+
|
4893
|
+
[**OAuth2Application**](OAuth2Application.md)
|
4894
|
+
|
4895
|
+
### Authorization
|
4896
|
+
|
4897
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4898
|
+
|
4899
|
+
### HTTP request headers
|
4900
|
+
|
4901
|
+
- **Content-Type**: application/json, text/plain
|
4902
|
+
- **Accept**: application/json
|
4903
|
+
|
4904
|
+
|
4905
|
+
## user_verify_gpg_key
|
4906
|
+
|
4907
|
+
> <GPGKey> user_verify_gpg_key
|
4908
|
+
|
4909
|
+
Verify a GPG key
|
4910
|
+
|
4911
|
+
### Examples
|
4912
|
+
|
4913
|
+
```ruby
|
4914
|
+
require 'time'
|
4915
|
+
require 'forgejo'
|
4916
|
+
# setup authorization
|
4917
|
+
Forgejo.configure do |config|
|
4918
|
+
# Configure API key authorization: AuthorizationHeaderToken
|
4919
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
4920
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
4921
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
4922
|
+
end
|
4923
|
+
|
4924
|
+
api_instance = Forgejo::UserApi.new
|
4925
|
+
|
4926
|
+
begin
|
4927
|
+
# Verify a GPG key
|
4928
|
+
result = api_instance.user_verify_gpg_key
|
4929
|
+
p result
|
4930
|
+
rescue Forgejo::ApiError => e
|
4931
|
+
puts "Error when calling UserApi->user_verify_gpg_key: #{e}"
|
4932
|
+
end
|
4933
|
+
```
|
4934
|
+
|
4935
|
+
#### Using the user_verify_gpg_key_with_http_info variant
|
4936
|
+
|
4937
|
+
This returns an Array which contains the response data, status code and headers.
|
4938
|
+
|
4939
|
+
> <Array(<GPGKey>, Integer, Hash)> user_verify_gpg_key_with_http_info
|
4940
|
+
|
4941
|
+
```ruby
|
4942
|
+
begin
|
4943
|
+
# Verify a GPG key
|
4944
|
+
data, status_code, headers = api_instance.user_verify_gpg_key_with_http_info
|
4945
|
+
p status_code # => 2xx
|
4946
|
+
p headers # => { ... }
|
4947
|
+
p data # => <GPGKey>
|
4948
|
+
rescue Forgejo::ApiError => e
|
4949
|
+
puts "Error when calling UserApi->user_verify_gpg_key_with_http_info: #{e}"
|
4950
|
+
end
|
4951
|
+
```
|
4952
|
+
|
4953
|
+
### Parameters
|
4954
|
+
|
4955
|
+
This endpoint does not need any parameter.
|
4956
|
+
|
4957
|
+
### Return type
|
4958
|
+
|
4959
|
+
[**GPGKey**](GPGKey.md)
|
4960
|
+
|
4961
|
+
### Authorization
|
4962
|
+
|
4963
|
+
[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)
|
4964
|
+
|
4965
|
+
### HTTP request headers
|
4966
|
+
|
4967
|
+
- **Content-Type**: Not defined
|
4968
|
+
- **Accept**: application/json
|
4969
|
+
|