forgejo 0.1.0 → 0.2.1
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 +4 -4
- data/CHANGELOG.md +5 -0
- data/CHANGELOG.md~ +3 -0
- data/Makefile +16 -16
- data/README.md +68 -12
- data/config.yaml +21 -0
- data/config.yaml~ +13 -0
- data/docs/APIForbiddenError.md +20 -0
- data/docs/APIInvalidTopicsError.md +20 -0
- data/docs/APINotFound.md +22 -0
- data/docs/APIRepoArchivedError.md +20 -0
- data/docs/APIUnauthorizedError.md +20 -0
- data/docs/APIValidationError.md +20 -0
- data/docs/ActivitypubApi.md +133 -0
- data/docs/AdminApi.md +1305 -184
- data/docs/Attachment.md +2 -0
- data/docs/CreatePushMirrorOption.md +3 -1
- data/docs/CreateQuotaGroupOptions.md +20 -0
- data/docs/CreateQuotaRuleOptions.md +22 -0
- data/docs/EditAttachmentOptions.md +2 -0
- data/docs/EditQuotaRuleOptions.md +20 -0
- data/docs/EditRepoOption.md +2 -0
- data/docs/IssueApi.md +55 -55
- data/docs/MarkupOption.md +2 -0
- data/docs/NoteOptions.md +18 -0
- data/docs/OrganizationApi.md +386 -19
- data/docs/PackageApi.md +1 -1
- data/docs/PullRequest.md +2 -0
- data/docs/PushMirror.md +2 -0
- data/docs/QuotaGroup.md +20 -0
- data/docs/QuotaInfo.md +20 -0
- data/docs/QuotaRuleInfo.md +22 -0
- data/docs/QuotaUsed.md +18 -0
- data/docs/QuotaUsedArtifact.md +22 -0
- data/docs/QuotaUsedAttachment.md +24 -0
- data/docs/QuotaUsedAttachmentContainedIn.md +20 -0
- data/docs/QuotaUsedPackage.md +26 -0
- data/docs/QuotaUsedSize.md +22 -0
- data/docs/QuotaUsedSizeAssets.md +22 -0
- data/docs/QuotaUsedSizeAssetsAttachments.md +20 -0
- data/docs/QuotaUsedSizeAssetsPackages.md +18 -0
- data/docs/QuotaUsedSizeGit.md +18 -0
- data/docs/QuotaUsedSizeRepos.md +20 -0
- data/docs/RepoCreateReleaseAttachmentRequest.md +4 -2
- data/docs/Repository.md +2 -0
- data/docs/RepositoryApi.md +308 -72
- data/docs/SetUserQuotaGroupsOptions.md +18 -0
- data/docs/UpdateBranchRepoOption.md +18 -0
- data/docs/UserApi.md +390 -33
- data/forgejo.gemspec +12 -13
- data/lib/forgejo/api/activitypub_api.rb +110 -2
- data/lib/forgejo/api/admin_api.rb +1148 -109
- data/lib/forgejo/api/issue_api.rb +94 -36
- data/lib/forgejo/api/miscellaneous_api.rb +2 -2
- data/lib/forgejo/api/notification_api.rb +2 -2
- data/lib/forgejo/api/organization_api.rb +363 -2
- data/lib/forgejo/api/package_api.rb +4 -2
- data/lib/forgejo/api/repository_api.rb +370 -26
- data/lib/forgejo/api/settings_api.rb +2 -2
- data/lib/forgejo/api/user_api.rb +350 -8
- data/lib/forgejo/api_client.rb +2 -2
- data/lib/forgejo/api_error.rb +2 -2
- data/lib/forgejo/configuration.rb +2 -2
- data/lib/forgejo/models/access_token.rb +11 -5
- data/lib/forgejo/models/action_task.rb +11 -5
- data/lib/forgejo/models/action_task_response.rb +11 -5
- data/lib/forgejo/models/action_variable.rb +11 -5
- data/lib/forgejo/models/activity.rb +11 -5
- data/lib/forgejo/models/activity_pub.rb +11 -5
- data/lib/forgejo/models/add_collaborator_option.rb +45 -5
- data/lib/forgejo/models/add_time_option.rb +21 -5
- data/lib/forgejo/models/annotated_tag.rb +11 -5
- data/lib/forgejo/models/annotated_tag_object.rb +11 -5
- data/lib/forgejo/models/api_error.rb +11 -5
- data/lib/forgejo/models/api_forbidden_error.rb +229 -0
- data/lib/forgejo/models/api_invalid_topics_error.rb +231 -0
- data/lib/forgejo/models/api_not_found.rb +240 -0
- data/lib/forgejo/models/api_repo_archived_error.rb +229 -0
- data/lib/forgejo/models/api_unauthorized_error.rb +229 -0
- data/lib/forgejo/models/api_validation_error.rb +229 -0
- data/lib/forgejo/models/attachment.rb +55 -6
- data/lib/forgejo/models/blocked_user.rb +11 -5
- data/lib/forgejo/models/branch.rb +11 -5
- data/lib/forgejo/models/branch_protection.rb +11 -5
- data/lib/forgejo/models/change_file_operation.rb +21 -5
- data/lib/forgejo/models/change_files_options.rb +21 -5
- data/lib/forgejo/models/changed_file.rb +11 -5
- data/lib/forgejo/models/combined_status.rb +11 -5
- data/lib/forgejo/models/comment.rb +11 -5
- data/lib/forgejo/models/commit.rb +11 -5
- data/lib/forgejo/models/commit_affected_files.rb +11 -5
- data/lib/forgejo/models/commit_date_options.rb +11 -5
- data/lib/forgejo/models/commit_meta.rb +11 -5
- data/lib/forgejo/models/commit_stats.rb +11 -5
- data/lib/forgejo/models/commit_status.rb +11 -5
- data/lib/forgejo/models/commit_user.rb +11 -5
- data/lib/forgejo/models/compare.rb +11 -5
- data/lib/forgejo/models/contents_response.rb +11 -5
- data/lib/forgejo/models/create_access_token_option.rb +21 -5
- data/lib/forgejo/models/create_branch_protection_option.rb +11 -5
- data/lib/forgejo/models/create_branch_repo_option.rb +21 -5
- data/lib/forgejo/models/create_email_option.rb +11 -5
- data/lib/forgejo/models/create_file_options.rb +21 -5
- data/lib/forgejo/models/create_fork_option.rb +11 -5
- data/lib/forgejo/models/create_gpg_key_option.rb +21 -5
- data/lib/forgejo/models/create_hook_option.rb +21 -5
- data/lib/forgejo/models/create_issue_comment_option.rb +21 -5
- data/lib/forgejo/models/create_issue_option.rb +21 -5
- data/lib/forgejo/models/create_key_option.rb +31 -5
- data/lib/forgejo/models/create_label_option.rb +31 -5
- data/lib/forgejo/models/create_milestone_option.rb +11 -5
- data/lib/forgejo/models/create_o_auth2_application_options.rb +11 -5
- data/lib/forgejo/models/create_or_update_secret_option.rb +21 -5
- data/lib/forgejo/models/create_org_option.rb +21 -5
- data/lib/forgejo/models/create_pull_request_option.rb +11 -5
- data/lib/forgejo/models/create_pull_review_comment.rb +11 -5
- data/lib/forgejo/models/create_pull_review_options.rb +11 -5
- data/lib/forgejo/models/create_push_mirror_option.rb +24 -9
- data/lib/forgejo/models/create_quota_group_options.rb +234 -0
- data/lib/forgejo/models/create_quota_rule_options.rb +244 -0
- data/lib/forgejo/models/create_release_option.rb +21 -5
- data/lib/forgejo/models/create_repo_option.rb +21 -5
- data/lib/forgejo/models/create_status_option.rb +11 -5
- data/lib/forgejo/models/create_tag_option.rb +21 -5
- data/lib/forgejo/models/create_tag_protection_option.rb +11 -5
- data/lib/forgejo/models/create_team_option.rb +21 -5
- data/lib/forgejo/models/create_user_option.rb +31 -5
- data/lib/forgejo/models/create_variable_option.rb +21 -5
- data/lib/forgejo/models/create_wiki_page_options.rb +11 -5
- data/lib/forgejo/models/cron.rb +11 -5
- data/lib/forgejo/models/delete_email_option.rb +11 -5
- data/lib/forgejo/models/delete_file_options.rb +21 -5
- data/lib/forgejo/models/delete_labels_option.rb +11 -5
- data/lib/forgejo/models/deploy_key.rb +11 -5
- data/lib/forgejo/models/dismiss_pull_review_options.rb +11 -5
- data/lib/forgejo/models/dispatch_workflow_option.rb +21 -5
- data/lib/forgejo/models/edit_attachment_options.rb +22 -6
- data/lib/forgejo/models/edit_branch_protection_option.rb +11 -5
- data/lib/forgejo/models/edit_deadline_option.rb +21 -5
- data/lib/forgejo/models/edit_git_hook_option.rb +11 -5
- data/lib/forgejo/models/edit_hook_option.rb +11 -5
- data/lib/forgejo/models/edit_issue_comment_option.rb +21 -5
- data/lib/forgejo/models/edit_issue_option.rb +11 -5
- data/lib/forgejo/models/edit_label_option.rb +11 -5
- data/lib/forgejo/models/edit_milestone_option.rb +11 -5
- data/lib/forgejo/models/edit_org_option.rb +11 -5
- data/lib/forgejo/models/edit_pull_request_option.rb +11 -5
- data/lib/forgejo/models/edit_quota_rule_options.rb +234 -0
- data/lib/forgejo/models/edit_reaction_option.rb +11 -5
- data/lib/forgejo/models/edit_release_option.rb +11 -5
- data/lib/forgejo/models/edit_repo_option.rb +22 -6
- data/lib/forgejo/models/edit_tag_protection_option.rb +11 -5
- data/lib/forgejo/models/edit_team_option.rb +21 -5
- data/lib/forgejo/models/edit_user_option.rb +11 -5
- data/lib/forgejo/models/email.rb +11 -5
- data/lib/forgejo/models/external_tracker.rb +11 -5
- data/lib/forgejo/models/external_wiki.rb +11 -5
- data/lib/forgejo/models/file_commit_response.rb +11 -5
- data/lib/forgejo/models/file_delete_response.rb +11 -5
- data/lib/forgejo/models/file_links_response.rb +11 -5
- data/lib/forgejo/models/file_response.rb +11 -5
- data/lib/forgejo/models/files_response.rb +11 -5
- data/lib/forgejo/models/general_api_settings.rb +11 -5
- data/lib/forgejo/models/general_attachment_settings.rb +11 -5
- data/lib/forgejo/models/general_repo_settings.rb +11 -5
- data/lib/forgejo/models/general_ui_settings.rb +11 -5
- data/lib/forgejo/models/generate_repo_option.rb +31 -5
- data/lib/forgejo/models/git_blob_response.rb +11 -5
- data/lib/forgejo/models/git_entry.rb +11 -5
- data/lib/forgejo/models/git_hook.rb +11 -5
- data/lib/forgejo/models/git_object.rb +11 -5
- data/lib/forgejo/models/git_tree_response.rb +11 -5
- data/lib/forgejo/models/gitignore_template_info.rb +11 -5
- data/lib/forgejo/models/gpg_key.rb +11 -5
- data/lib/forgejo/models/gpg_key_email.rb +11 -5
- data/lib/forgejo/models/hook.rb +11 -5
- data/lib/forgejo/models/identity.rb +11 -5
- data/lib/forgejo/models/internal_tracker.rb +11 -5
- data/lib/forgejo/models/issue.rb +11 -5
- data/lib/forgejo/models/issue_config.rb +11 -5
- data/lib/forgejo/models/issue_config_contact_link.rb +11 -5
- data/lib/forgejo/models/issue_config_validation.rb +11 -5
- data/lib/forgejo/models/issue_deadline.rb +11 -5
- data/lib/forgejo/models/issue_form_field.rb +11 -5
- data/lib/forgejo/models/issue_labels_option.rb +11 -5
- data/lib/forgejo/models/issue_meta.rb +11 -5
- data/lib/forgejo/models/issue_template.rb +11 -5
- data/lib/forgejo/models/label.rb +11 -5
- data/lib/forgejo/models/label_template.rb +11 -5
- data/lib/forgejo/models/license_template_info.rb +11 -5
- data/lib/forgejo/models/licenses_template_list_entry.rb +11 -5
- data/lib/forgejo/models/markdown_option.rb +11 -5
- data/lib/forgejo/models/markup_option.rb +22 -6
- data/lib/forgejo/models/merge_pull_request_option.rb +11 -5
- data/lib/forgejo/models/migrate_repo_options.rb +31 -5
- data/lib/forgejo/models/milestone.rb +11 -5
- data/lib/forgejo/models/new_issue_pins_allowed.rb +11 -5
- data/lib/forgejo/models/node_info.rb +11 -5
- data/lib/forgejo/models/node_info_services.rb +11 -5
- data/lib/forgejo/models/node_info_software.rb +11 -5
- data/lib/forgejo/models/node_info_usage.rb +11 -5
- data/lib/forgejo/models/node_info_usage_users.rb +11 -5
- data/lib/forgejo/models/note.rb +11 -5
- data/lib/forgejo/models/note_options.rb +220 -0
- data/lib/forgejo/models/notification_count.rb +11 -5
- data/lib/forgejo/models/notification_subject.rb +11 -5
- data/lib/forgejo/models/notification_thread.rb +11 -5
- data/lib/forgejo/models/o_auth2_application.rb +11 -5
- data/lib/forgejo/models/organization.rb +11 -5
- data/lib/forgejo/models/organization_permissions.rb +11 -5
- data/lib/forgejo/models/package.rb +11 -5
- data/lib/forgejo/models/package_file.rb +11 -5
- data/lib/forgejo/models/payload_commit.rb +11 -5
- data/lib/forgejo/models/payload_commit_verification.rb +11 -5
- data/lib/forgejo/models/payload_user.rb +11 -5
- data/lib/forgejo/models/permission.rb +11 -5
- data/lib/forgejo/models/pr_branch_info.rb +11 -5
- data/lib/forgejo/models/public_key.rb +11 -5
- data/lib/forgejo/models/pull_request.rb +23 -6
- data/lib/forgejo/models/pull_request_meta.rb +11 -5
- data/lib/forgejo/models/pull_review.rb +11 -5
- data/lib/forgejo/models/pull_review_comment.rb +11 -5
- data/lib/forgejo/models/pull_review_request_options.rb +11 -5
- data/lib/forgejo/models/push_mirror.rb +21 -6
- data/lib/forgejo/models/quota_group.rb +234 -0
- data/lib/forgejo/models/quota_info.rb +233 -0
- data/lib/forgejo/models/quota_rule_info.rb +244 -0
- data/lib/forgejo/models/quota_used.rb +221 -0
- data/lib/forgejo/models/quota_used_artifact.rb +242 -0
- data/lib/forgejo/models/quota_used_attachment.rb +251 -0
- data/lib/forgejo/models/quota_used_attachment_contained_in.rb +232 -0
- data/lib/forgejo/models/quota_used_package.rb +262 -0
- data/lib/forgejo/models/quota_used_size.rb +239 -0
- data/lib/forgejo/models/quota_used_size_assets.rb +240 -0
- data/lib/forgejo/models/quota_used_size_assets_attachments.rb +232 -0
- data/lib/forgejo/models/quota_used_size_assets_packages.rb +222 -0
- data/lib/forgejo/models/quota_used_size_git.rb +222 -0
- data/lib/forgejo/models/quota_used_size_repos.rb +232 -0
- data/lib/forgejo/models/reaction.rb +11 -5
- data/lib/forgejo/models/reference.rb +11 -5
- data/lib/forgejo/models/release.rb +11 -5
- data/lib/forgejo/models/rename_user_option.rb +21 -5
- data/lib/forgejo/models/replace_flags_option.rb +11 -5
- data/lib/forgejo/models/repo_collaborator_permission.rb +11 -5
- data/lib/forgejo/models/repo_commit.rb +11 -5
- data/lib/forgejo/models/repo_create_release_attachment_request.rb +26 -10
- data/lib/forgejo/models/repo_topic_options.rb +11 -5
- data/lib/forgejo/models/repo_transfer.rb +11 -5
- data/lib/forgejo/models/repository.rb +21 -6
- data/lib/forgejo/models/repository_meta.rb +11 -5
- data/lib/forgejo/models/search_results.rb +11 -5
- data/lib/forgejo/models/secret.rb +11 -5
- data/lib/forgejo/models/server_version.rb +11 -5
- data/lib/forgejo/models/set_user_quota_groups_options.rb +241 -0
- data/lib/forgejo/models/stop_watch.rb +11 -5
- data/lib/forgejo/models/submit_pull_review_options.rb +11 -5
- data/lib/forgejo/models/tag.rb +11 -5
- data/lib/forgejo/models/tag_archive_download_count.rb +11 -5
- data/lib/forgejo/models/tag_protection.rb +11 -5
- data/lib/forgejo/models/team.rb +11 -5
- data/lib/forgejo/models/team_search200_response.rb +11 -5
- data/lib/forgejo/models/timeline_comment.rb +11 -5
- data/lib/forgejo/models/topic_name.rb +11 -5
- data/lib/forgejo/models/topic_response.rb +11 -5
- data/lib/forgejo/models/tracked_time.rb +11 -5
- data/lib/forgejo/models/transfer_repo_option.rb +21 -5
- data/lib/forgejo/models/update_branch_repo_option.rb +239 -0
- data/lib/forgejo/models/update_file_options.rb +31 -5
- data/lib/forgejo/models/update_repo_avatar_option.rb +11 -5
- data/lib/forgejo/models/update_user_avatar_option.rb +11 -5
- data/lib/forgejo/models/update_variable_option.rb +21 -5
- data/lib/forgejo/models/user.rb +11 -5
- data/lib/forgejo/models/user_heatmap_data.rb +11 -5
- data/lib/forgejo/models/user_search200_response.rb +11 -5
- data/lib/forgejo/models/user_settings.rb +11 -5
- data/lib/forgejo/models/user_settings_options.rb +11 -5
- data/lib/forgejo/models/watch_info.rb +11 -5
- data/lib/forgejo/models/wiki_commit.rb +11 -5
- data/lib/forgejo/models/wiki_commit_list.rb +11 -5
- data/lib/forgejo/models/wiki_page.rb +11 -5
- data/lib/forgejo/models/wiki_page_meta_data.rb +11 -5
- data/lib/forgejo/version.rb +3 -3
- data/lib/forgejo.rb +28 -2
- data/manifest.scm +6 -2
- data/openapi-generator-cli.jar +0 -0
- data/pom.xml~ +22 -0
- data/smoke +1 -1
- data/spec/models/api_forbidden_error_spec.rb +42 -0
- data/spec/models/api_invalid_topics_error_spec.rb +42 -0
- data/spec/models/api_not_found_spec.rb +48 -0
- data/spec/models/api_repo_archived_error_spec.rb +42 -0
- data/spec/models/api_unauthorized_error_spec.rb +42 -0
- data/spec/models/api_validation_error_spec.rb +42 -0
- data/spec/models/create_quota_group_options_spec.rb +42 -0
- data/spec/models/create_quota_rule_options_spec.rb +48 -0
- data/spec/models/edit_quota_rule_options_spec.rb +42 -0
- data/spec/models/note_options_spec.rb +36 -0
- data/spec/models/quota_group_spec.rb +42 -0
- data/spec/models/quota_info_spec.rb +42 -0
- data/spec/models/quota_rule_info_spec.rb +48 -0
- data/spec/models/quota_used_artifact_spec.rb +48 -0
- data/spec/models/quota_used_attachment_contained_in_spec.rb +42 -0
- data/spec/models/quota_used_attachment_spec.rb +54 -0
- data/spec/models/quota_used_package_spec.rb +60 -0
- data/spec/models/quota_used_size_assets_attachments_spec.rb +42 -0
- data/spec/models/quota_used_size_assets_packages_spec.rb +36 -0
- data/spec/models/quota_used_size_assets_spec.rb +48 -0
- data/spec/models/quota_used_size_git_spec.rb +36 -0
- data/spec/models/quota_used_size_repos_spec.rb +42 -0
- data/spec/models/quota_used_size_spec.rb +48 -0
- data/spec/models/quota_used_spec.rb +36 -0
- data/spec/models/set_user_quota_groups_options_spec.rb +36 -0
- data/spec/models/update_branch_repo_option_spec.rb +36 -0
- data/spec/spec_helper.rb +2 -2
- data/swagger.v1.json +2563 -338
- data/swagger.v1.patched.json +1 -1
- metadata +291 -182
- data/LICENSE~ +0 -9
- data/Makefile~ +0 -2
- data/patch~ +0 -1
- data/smoke~ +0 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0f88ecd9e7f88a253580e8b799b58df30392eac02e9dd9a5b3a1ba1c77e994b2
|
4
|
+
data.tar.gz: 0015af2b89849ab8d619e6eacef3f29925623337a376113c05e23389b24cc10f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cfdee96fd78d37f01f277943f8d75d42e66f3ec8da34f6d29726036953545fdd0369062d3842c3668123f5ffdc32130677f031cdb425e7800db638ec06643e8e
|
7
|
+
data.tar.gz: c2461abbee8121f40cef4aeedfb74b2e58c93b6fd40057ad0171faebef1bebd6275fa515a3eb534a8de80f37ba71a3542ead27eb25cba3952b734c56ad6507eb
|
data/CHANGELOG.md
ADDED
data/CHANGELOG.md~
ADDED
data/Makefile
CHANGED
@@ -1,23 +1,23 @@
|
|
1
|
+
OpenAPI-generator = java -jar openapi-generator-cli.jar
|
2
|
+
|
1
3
|
gen: swagger.v1.patched.json
|
2
|
-
|
3
|
-
--input-spec $<
|
4
|
-
--output ${PWD}
|
5
|
-
--generator-name ruby
|
6
|
-
--skip-validate-spec
|
7
|
-
--
|
8
|
-
--additional-properties 'gemAuthorEmail=gemmaro.dev@gmail.com' \
|
9
|
-
--additional-properties 'gemHomepage=https://codeberg.org/gemmaro/forgejo' \
|
10
|
-
--additional-properties 'gemLicense=MIT' \
|
11
|
-
--additional-properties 'gemName=forgejo' \
|
12
|
-
--additional-properties 'gemRequiredRubyVersion=>=3.2' \
|
13
|
-
--additional-properties 'gemSummary=Forgejo REST API client' \
|
14
|
-
--additional-properties 'gemVersion=0.1.0' \
|
15
|
-
--additional-properties 'library=faraday' \
|
16
|
-
--additional-properties 'moduleName=Forgejo'
|
4
|
+
${OpenAPI-generator} generate \
|
5
|
+
--input-spec $< \
|
6
|
+
--output ${PWD} \
|
7
|
+
--generator-name ruby \
|
8
|
+
--skip-validate-spec \
|
9
|
+
--config config.yaml
|
17
10
|
.PHONY: gen
|
18
11
|
|
19
12
|
swagger.v1.patched.json: swagger.v1.json
|
20
13
|
./patch < $< > $@
|
21
14
|
|
22
15
|
swagger.v1.json:
|
23
|
-
|
16
|
+
${MAKE} download
|
17
|
+
|
18
|
+
download:
|
19
|
+
wget --output-document swagger.v1.json 'https://codeberg.org/swagger.v1.json'
|
20
|
+
.PHONY: download
|
21
|
+
|
22
|
+
openapi-generator-cli.jar:
|
23
|
+
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.12.0/openapi-generator-cli-7.12.0.jar -O openapi-generator-cli.jar
|
data/README.md
CHANGED
@@ -6,9 +6,9 @@ This documentation describes the Forgejo API.
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version:
|
10
|
-
- Package version: 0.1
|
11
|
-
- Generator version: 7.
|
9
|
+
- API version: 10.0.0-121-28886cd+gitea-1.22.0
|
10
|
+
- Package version: 0.2.1
|
11
|
+
- Generator version: 7.12.0
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
13
|
|
14
14
|
## Installation
|
@@ -24,16 +24,16 @@ gem build forgejo.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./forgejo-0.1.
|
27
|
+
gem install ./forgejo-0.2.1.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./forgejo-0.1.
|
30
|
+
(for development, run `gem install --dev ./forgejo-0.2.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'forgejo', '~> 0.1
|
36
|
+
gem 'forgejo', '~> 0.2.1'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -68,14 +68,13 @@ Forgejo.configure do |config|
|
|
68
68
|
end
|
69
69
|
|
70
70
|
api_instance = Forgejo::ActivitypubApi.new
|
71
|
-
user_id = 56 # Integer | user ID of the user
|
72
71
|
|
73
72
|
begin
|
74
|
-
#Returns the
|
75
|
-
result = api_instance.
|
73
|
+
#Returns the instance's Actor
|
74
|
+
result = api_instance.activitypub_instance_actor
|
76
75
|
p result
|
77
76
|
rescue Forgejo::ApiError => e
|
78
|
-
puts "Exception when calling ActivitypubApi->
|
77
|
+
puts "Exception when calling ActivitypubApi->activitypub_instance_actor: #{e}"
|
79
78
|
end
|
80
79
|
|
81
80
|
```
|
@@ -86,32 +85,50 @@ All URIs are relative to */api/v1*
|
|
86
85
|
|
87
86
|
Class | Method | HTTP request | Description
|
88
87
|
------------ | ------------- | ------------- | -------------
|
88
|
+
*Forgejo::ActivitypubApi* | [**activitypub_instance_actor**](docs/ActivitypubApi.md#activitypub_instance_actor) | **GET** /activitypub/actor | Returns the instance's Actor
|
89
|
+
*Forgejo::ActivitypubApi* | [**activitypub_instance_actor_inbox**](docs/ActivitypubApi.md#activitypub_instance_actor_inbox) | **POST** /activitypub/actor/inbox | Send to the inbox
|
89
90
|
*Forgejo::ActivitypubApi* | [**activitypub_person**](docs/ActivitypubApi.md#activitypub_person) | **GET** /activitypub/user-id/{user-id} | Returns the Person actor for a user
|
90
91
|
*Forgejo::ActivitypubApi* | [**activitypub_person_inbox**](docs/ActivitypubApi.md#activitypub_person_inbox) | **POST** /activitypub/user-id/{user-id}/inbox | Send to the inbox
|
91
92
|
*Forgejo::ActivitypubApi* | [**activitypub_repository**](docs/ActivitypubApi.md#activitypub_repository) | **GET** /activitypub/repository-id/{repository-id} | Returns the Repository actor for a repo
|
92
93
|
*Forgejo::ActivitypubApi* | [**activitypub_repository_inbox**](docs/ActivitypubApi.md#activitypub_repository_inbox) | **POST** /activitypub/repository-id/{repository-id}/inbox | Send to the inbox
|
94
|
+
*Forgejo::AdminApi* | [**admin_add_rule_to_quota_group**](docs/AdminApi.md#admin_add_rule_to_quota_group) | **PUT** /admin/quota/groups/{quotagroup}/rules/{quotarule} | Adds a rule to a quota group
|
95
|
+
*Forgejo::AdminApi* | [**admin_add_user_to_quota_group**](docs/AdminApi.md#admin_add_user_to_quota_group) | **PUT** /admin/quota/groups/{quotagroup}/users/{username} | Add a user to a quota group
|
93
96
|
*Forgejo::AdminApi* | [**admin_adopt_repository**](docs/AdminApi.md#admin_adopt_repository) | **POST** /admin/unadopted/{owner}/{repo} | Adopt unadopted files as a repository
|
94
97
|
*Forgejo::AdminApi* | [**admin_create_hook**](docs/AdminApi.md#admin_create_hook) | **POST** /admin/hooks | Create a hook
|
95
98
|
*Forgejo::AdminApi* | [**admin_create_org**](docs/AdminApi.md#admin_create_org) | **POST** /admin/users/{username}/orgs | Create an organization
|
96
99
|
*Forgejo::AdminApi* | [**admin_create_public_key**](docs/AdminApi.md#admin_create_public_key) | **POST** /admin/users/{username}/keys | Add a public key on behalf of a user
|
100
|
+
*Forgejo::AdminApi* | [**admin_create_quota_group**](docs/AdminApi.md#admin_create_quota_group) | **POST** /admin/quota/groups | Create a new quota group
|
101
|
+
*Forgejo::AdminApi* | [**admin_create_quota_rule**](docs/AdminApi.md#admin_create_quota_rule) | **POST** /admin/quota/rules | Create a new quota rule
|
97
102
|
*Forgejo::AdminApi* | [**admin_create_repo**](docs/AdminApi.md#admin_create_repo) | **POST** /admin/users/{username}/repos | Create a repository on behalf of a user
|
98
103
|
*Forgejo::AdminApi* | [**admin_create_user**](docs/AdminApi.md#admin_create_user) | **POST** /admin/users | Create a user
|
99
104
|
*Forgejo::AdminApi* | [**admin_cron_list**](docs/AdminApi.md#admin_cron_list) | **GET** /admin/cron | List cron tasks
|
100
105
|
*Forgejo::AdminApi* | [**admin_cron_run**](docs/AdminApi.md#admin_cron_run) | **POST** /admin/cron/{task} | Run cron task
|
106
|
+
*Forgejo::AdminApi* | [**admin_d_elete_quota_rule**](docs/AdminApi.md#admin_d_elete_quota_rule) | **DELETE** /admin/quota/rules/{quotarule} | Deletes a quota rule
|
101
107
|
*Forgejo::AdminApi* | [**admin_delete_hook**](docs/AdminApi.md#admin_delete_hook) | **DELETE** /admin/hooks/{id} | Delete a hook
|
108
|
+
*Forgejo::AdminApi* | [**admin_delete_quota_group**](docs/AdminApi.md#admin_delete_quota_group) | **DELETE** /admin/quota/groups/{quotagroup} | Delete a quota group
|
102
109
|
*Forgejo::AdminApi* | [**admin_delete_unadopted_repository**](docs/AdminApi.md#admin_delete_unadopted_repository) | **DELETE** /admin/unadopted/{owner}/{repo} | Delete unadopted files
|
103
110
|
*Forgejo::AdminApi* | [**admin_delete_user**](docs/AdminApi.md#admin_delete_user) | **DELETE** /admin/users/{username} | Delete a user
|
104
111
|
*Forgejo::AdminApi* | [**admin_delete_user_public_key**](docs/AdminApi.md#admin_delete_user_public_key) | **DELETE** /admin/users/{username}/keys/{id} | Delete a user's public key
|
105
112
|
*Forgejo::AdminApi* | [**admin_edit_hook**](docs/AdminApi.md#admin_edit_hook) | **PATCH** /admin/hooks/{id} | Update a hook
|
113
|
+
*Forgejo::AdminApi* | [**admin_edit_quota_rule**](docs/AdminApi.md#admin_edit_quota_rule) | **PATCH** /admin/quota/rules/{quotarule} | Change an existing quota rule
|
106
114
|
*Forgejo::AdminApi* | [**admin_edit_user**](docs/AdminApi.md#admin_edit_user) | **PATCH** /admin/users/{username} | Edit an existing user
|
107
115
|
*Forgejo::AdminApi* | [**admin_get_all_emails**](docs/AdminApi.md#admin_get_all_emails) | **GET** /admin/emails | List all emails
|
108
116
|
*Forgejo::AdminApi* | [**admin_get_all_orgs**](docs/AdminApi.md#admin_get_all_orgs) | **GET** /admin/orgs | List all organizations
|
109
117
|
*Forgejo::AdminApi* | [**admin_get_hook**](docs/AdminApi.md#admin_get_hook) | **GET** /admin/hooks/{id} | Get a hook
|
118
|
+
*Forgejo::AdminApi* | [**admin_get_quota_group**](docs/AdminApi.md#admin_get_quota_group) | **GET** /admin/quota/groups/{quotagroup} | Get information about the quota group
|
119
|
+
*Forgejo::AdminApi* | [**admin_get_quota_rule**](docs/AdminApi.md#admin_get_quota_rule) | **GET** /admin/quota/rules/{quotarule} | Get information about a quota rule
|
110
120
|
*Forgejo::AdminApi* | [**admin_get_runner_registration_token**](docs/AdminApi.md#admin_get_runner_registration_token) | **GET** /admin/runners/registration-token | Get an global actions runner registration token
|
121
|
+
*Forgejo::AdminApi* | [**admin_get_user_quota**](docs/AdminApi.md#admin_get_user_quota) | **GET** /admin/users/{username}/quota | Get the user's quota info
|
111
122
|
*Forgejo::AdminApi* | [**admin_list_hooks**](docs/AdminApi.md#admin_list_hooks) | **GET** /admin/hooks | List system's webhooks
|
123
|
+
*Forgejo::AdminApi* | [**admin_list_quota_groups**](docs/AdminApi.md#admin_list_quota_groups) | **GET** /admin/quota/groups | List the available quota groups
|
124
|
+
*Forgejo::AdminApi* | [**admin_list_quota_rules**](docs/AdminApi.md#admin_list_quota_rules) | **GET** /admin/quota/rules | List the available quota rules
|
125
|
+
*Forgejo::AdminApi* | [**admin_list_users_in_quota_group**](docs/AdminApi.md#admin_list_users_in_quota_group) | **GET** /admin/quota/groups/{quotagroup}/users | List users in a quota group
|
126
|
+
*Forgejo::AdminApi* | [**admin_remove_rule_from_quota_group**](docs/AdminApi.md#admin_remove_rule_from_quota_group) | **DELETE** /admin/quota/groups/{quotagroup}/rules/{quotarule} | Removes a rule from a quota group
|
127
|
+
*Forgejo::AdminApi* | [**admin_remove_user_from_quota_group**](docs/AdminApi.md#admin_remove_user_from_quota_group) | **DELETE** /admin/quota/groups/{quotagroup}/users/{username} | Remove a user from a quota group
|
112
128
|
*Forgejo::AdminApi* | [**admin_rename_user**](docs/AdminApi.md#admin_rename_user) | **POST** /admin/users/{username}/rename | Rename a user
|
113
129
|
*Forgejo::AdminApi* | [**admin_search_emails**](docs/AdminApi.md#admin_search_emails) | **GET** /admin/emails/search | Search all emails
|
114
130
|
*Forgejo::AdminApi* | [**admin_search_users**](docs/AdminApi.md#admin_search_users) | **GET** /admin/users | Search users according filter conditions
|
131
|
+
*Forgejo::AdminApi* | [**admin_set_user_quota_groups**](docs/AdminApi.md#admin_set_user_quota_groups) | **POST** /admin/users/{username}/quota/groups | Set the user's quota groups to a given list.
|
115
132
|
*Forgejo::AdminApi* | [**admin_unadopted_list**](docs/AdminApi.md#admin_unadopted_list) | **GET** /admin/unadopted | List unadopted repositories
|
116
133
|
*Forgejo::IssueApi* | [**issue_add_label**](docs/IssueApi.md#issue_add_label) | **POST** /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue
|
117
134
|
*Forgejo::IssueApi* | [**issue_add_subscription**](docs/IssueApi.md#issue_add_subscription) | **PUT** /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue
|
@@ -209,6 +226,7 @@ Class | Method | HTTP request | Description
|
|
209
226
|
*Forgejo::OrganizationApi* | [**org_add_team_member**](docs/OrganizationApi.md#org_add_team_member) | **PUT** /teams/{id}/members/{username} | Add a team member
|
210
227
|
*Forgejo::OrganizationApi* | [**org_add_team_repository**](docs/OrganizationApi.md#org_add_team_repository) | **PUT** /teams/{id}/repos/{org}/{repo} | Add a repository to a team
|
211
228
|
*Forgejo::OrganizationApi* | [**org_block_user**](docs/OrganizationApi.md#org_block_user) | **PUT** /orgs/{org}/block/{username} | Blocks a user from the organization
|
229
|
+
*Forgejo::OrganizationApi* | [**org_check_quota**](docs/OrganizationApi.md#org_check_quota) | **GET** /orgs/{org}/quota/check | Check if the organization is over quota for a given subject
|
212
230
|
*Forgejo::OrganizationApi* | [**org_conceal_member**](docs/OrganizationApi.md#org_conceal_member) | **DELETE** /orgs/{org}/public_members/{username} | Conceal a user's membership
|
213
231
|
*Forgejo::OrganizationApi* | [**org_create**](docs/OrganizationApi.md#org_create) | **POST** /orgs | Create an organization
|
214
232
|
*Forgejo::OrganizationApi* | [**org_create_hook**](docs/OrganizationApi.md#org_create_hook) | **POST** /orgs/{org}/hooks | Create a hook
|
@@ -228,6 +246,7 @@ Class | Method | HTTP request | Description
|
|
228
246
|
*Forgejo::OrganizationApi* | [**org_get_all**](docs/OrganizationApi.md#org_get_all) | **GET** /orgs | Get list of organizations
|
229
247
|
*Forgejo::OrganizationApi* | [**org_get_hook**](docs/OrganizationApi.md#org_get_hook) | **GET** /orgs/{org}/hooks/{id} | Get a hook
|
230
248
|
*Forgejo::OrganizationApi* | [**org_get_label**](docs/OrganizationApi.md#org_get_label) | **GET** /orgs/{org}/labels/{id} | Get a single label
|
249
|
+
*Forgejo::OrganizationApi* | [**org_get_quota**](docs/OrganizationApi.md#org_get_quota) | **GET** /orgs/{org}/quota | Get quota information for an organization
|
231
250
|
*Forgejo::OrganizationApi* | [**org_get_runner_registration_token**](docs/OrganizationApi.md#org_get_runner_registration_token) | **GET** /orgs/{org}/actions/runners/registration-token | Get an organization's actions runner registration token
|
232
251
|
*Forgejo::OrganizationApi* | [**org_get_team**](docs/OrganizationApi.md#org_get_team) | **GET** /teams/{id} | Get a team
|
233
252
|
*Forgejo::OrganizationApi* | [**org_get_user_permissions**](docs/OrganizationApi.md#org_get_user_permissions) | **GET** /users/{username}/orgs/{org}/permissions | Get user permissions in organization
|
@@ -241,6 +260,9 @@ Class | Method | HTTP request | Description
|
|
241
260
|
*Forgejo::OrganizationApi* | [**org_list_labels**](docs/OrganizationApi.md#org_list_labels) | **GET** /orgs/{org}/labels | List an organization's labels
|
242
261
|
*Forgejo::OrganizationApi* | [**org_list_members**](docs/OrganizationApi.md#org_list_members) | **GET** /orgs/{org}/members | List an organization's members
|
243
262
|
*Forgejo::OrganizationApi* | [**org_list_public_members**](docs/OrganizationApi.md#org_list_public_members) | **GET** /orgs/{org}/public_members | List an organization's public members
|
263
|
+
*Forgejo::OrganizationApi* | [**org_list_quota_artifacts**](docs/OrganizationApi.md#org_list_quota_artifacts) | **GET** /orgs/{org}/quota/artifacts | List the artifacts affecting the organization's quota
|
264
|
+
*Forgejo::OrganizationApi* | [**org_list_quota_attachments**](docs/OrganizationApi.md#org_list_quota_attachments) | **GET** /orgs/{org}/quota/attachments | List the attachments affecting the organization's quota
|
265
|
+
*Forgejo::OrganizationApi* | [**org_list_quota_packages**](docs/OrganizationApi.md#org_list_quota_packages) | **GET** /orgs/{org}/quota/packages | List the packages affecting the organization's quota
|
244
266
|
*Forgejo::OrganizationApi* | [**org_list_repos**](docs/OrganizationApi.md#org_list_repos) | **GET** /orgs/{org}/repos | List an organization's repos
|
245
267
|
*Forgejo::OrganizationApi* | [**org_list_team_activity_feeds**](docs/OrganizationApi.md#org_list_team_activity_feeds) | **GET** /teams/{id}/activities/feeds | List a team's activity feeds
|
246
268
|
*Forgejo::OrganizationApi* | [**org_list_team_member**](docs/OrganizationApi.md#org_list_team_member) | **GET** /teams/{id}/members/{username} | List a particular member of team
|
@@ -374,7 +396,7 @@ Class | Method | HTTP request | Description
|
|
374
396
|
*Forgejo::RepositoryApi* | [**repo_get_release_by_tag**](docs/RepositoryApi.md#repo_get_release_by_tag) | **GET** /repos/{owner}/{repo}/releases/tags/{tag} | Get a release by tag name
|
375
397
|
*Forgejo::RepositoryApi* | [**repo_get_repo_permissions**](docs/RepositoryApi.md#repo_get_repo_permissions) | **GET** /repos/{owner}/{repo}/collaborators/{collaborator}/permission | Get repository permissions for a user
|
376
398
|
*Forgejo::RepositoryApi* | [**repo_get_reviewers**](docs/RepositoryApi.md#repo_get_reviewers) | **GET** /repos/{owner}/{repo}/reviewers | Return all users that can be requested to review in this repo
|
377
|
-
*Forgejo::RepositoryApi* | [**repo_get_runner_registration_token**](docs/RepositoryApi.md#repo_get_runner_registration_token) | **GET** /repos/{owner}/{repo}/runners/registration-token | Get a repository's actions runner registration token
|
399
|
+
*Forgejo::RepositoryApi* | [**repo_get_runner_registration_token**](docs/RepositoryApi.md#repo_get_runner_registration_token) | **GET** /repos/{owner}/{repo}/actions/runners/registration-token | Get a repository's actions runner registration token
|
378
400
|
*Forgejo::RepositoryApi* | [**repo_get_single_commit**](docs/RepositoryApi.md#repo_get_single_commit) | **GET** /repos/{owner}/{repo}/git/commits/{sha} | Get a single commit from a repository
|
379
401
|
*Forgejo::RepositoryApi* | [**repo_get_tag**](docs/RepositoryApi.md#repo_get_tag) | **GET** /repos/{owner}/{repo}/tags/{tag} | Get the tag of a repository by tag name
|
380
402
|
*Forgejo::RepositoryApi* | [**repo_get_tag_protection**](docs/RepositoryApi.md#repo_get_tag_protection) | **GET** /repos/{owner}/{repo}/tag_protections/{id} | Get a specific tag protection for the repository
|
@@ -413,8 +435,10 @@ Class | Method | HTTP request | Description
|
|
413
435
|
*Forgejo::RepositoryApi* | [**repo_new_pin_allowed**](docs/RepositoryApi.md#repo_new_pin_allowed) | **GET** /repos/{owner}/{repo}/new_pin_allowed | Returns if new Issue Pins are allowed
|
414
436
|
*Forgejo::RepositoryApi* | [**repo_pull_request_is_merged**](docs/RepositoryApi.md#repo_pull_request_is_merged) | **GET** /repos/{owner}/{repo}/pulls/{index}/merge | Check if a pull request has been merged
|
415
437
|
*Forgejo::RepositoryApi* | [**repo_push_mirror_sync**](docs/RepositoryApi.md#repo_push_mirror_sync) | **POST** /repos/{owner}/{repo}/push_mirrors-sync | Sync all push mirrored repository
|
438
|
+
*Forgejo::RepositoryApi* | [**repo_remove_note**](docs/RepositoryApi.md#repo_remove_note) | **DELETE** /repos/{owner}/{repo}/git/notes/{sha} | Removes a note corresponding to a single commit from a repository
|
416
439
|
*Forgejo::RepositoryApi* | [**repo_replace_all_flags**](docs/RepositoryApi.md#repo_replace_all_flags) | **PUT** /repos/{owner}/{repo}/flags | Replace all flags of a repository
|
417
440
|
*Forgejo::RepositoryApi* | [**repo_search**](docs/RepositoryApi.md#repo_search) | **GET** /repos/search | Search for repositories
|
441
|
+
*Forgejo::RepositoryApi* | [**repo_set_note**](docs/RepositoryApi.md#repo_set_note) | **POST** /repos/{owner}/{repo}/git/notes/{sha} | Set a note corresponding to a single commit from a repository
|
418
442
|
*Forgejo::RepositoryApi* | [**repo_signing_key**](docs/RepositoryApi.md#repo_signing_key) | **GET** /repos/{owner}/{repo}/signing-key.gpg | Get signing-key.gpg for given repository
|
419
443
|
*Forgejo::RepositoryApi* | [**repo_submit_pull_review**](docs/RepositoryApi.md#repo_submit_pull_review) | **POST** /repos/{owner}/{repo}/pulls/{index}/reviews/{id} | Submit a pending review to an pull request
|
420
444
|
*Forgejo::RepositoryApi* | [**repo_test_hook**](docs/RepositoryApi.md#repo_test_hook) | **POST** /repos/{owner}/{repo}/hooks/{id}/tests | Test a push webhook
|
@@ -422,6 +446,7 @@ Class | Method | HTTP request | Description
|
|
422
446
|
*Forgejo::RepositoryApi* | [**repo_transfer**](docs/RepositoryApi.md#repo_transfer) | **POST** /repos/{owner}/{repo}/transfer | Transfer a repo ownership
|
423
447
|
*Forgejo::RepositoryApi* | [**repo_un_dismiss_pull_review**](docs/RepositoryApi.md#repo_un_dismiss_pull_review) | **POST** /repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals | Cancel to dismiss a review for a pull request
|
424
448
|
*Forgejo::RepositoryApi* | [**repo_update_avatar**](docs/RepositoryApi.md#repo_update_avatar) | **POST** /repos/{owner}/{repo}/avatar | Update avatar
|
449
|
+
*Forgejo::RepositoryApi* | [**repo_update_branch**](docs/RepositoryApi.md#repo_update_branch) | **PATCH** /repos/{owner}/{repo}/branches/{branch} | Update a branch
|
425
450
|
*Forgejo::RepositoryApi* | [**repo_update_file**](docs/RepositoryApi.md#repo_update_file) | **PUT** /repos/{owner}/{repo}/contents/{filepath} | Update a file in a repository
|
426
451
|
*Forgejo::RepositoryApi* | [**repo_update_pull_request**](docs/RepositoryApi.md#repo_update_pull_request) | **POST** /repos/{owner}/{repo}/pulls/{index}/update | Merge PR's baseBranch into headBranch
|
427
452
|
*Forgejo::RepositoryApi* | [**repo_update_topics**](docs/RepositoryApi.md#repo_update_topics) | **PUT** /repos/{owner}/{repo}/topics | Replace list of topics for a repository
|
@@ -437,7 +462,7 @@ Class | Method | HTTP request | Description
|
|
437
462
|
*Forgejo::SettingsApi* | [**get_general_attachment_settings**](docs/SettingsApi.md#get_general_attachment_settings) | **GET** /settings/attachment | Get instance's global settings for Attachment
|
438
463
|
*Forgejo::SettingsApi* | [**get_general_repository_settings**](docs/SettingsApi.md#get_general_repository_settings) | **GET** /settings/repository | Get instance's global settings for repositories
|
439
464
|
*Forgejo::SettingsApi* | [**get_general_ui_settings**](docs/SettingsApi.md#get_general_ui_settings) | **GET** /settings/ui | Get instance's global settings for ui
|
440
|
-
*Forgejo::UserApi* | [**
|
465
|
+
*Forgejo::UserApi* | [**create_current_user_repo**](docs/UserApi.md#create_current_user_repo) | **POST** /user/repos | Create a repository
|
441
466
|
*Forgejo::UserApi* | [**create_user_variable**](docs/UserApi.md#create_user_variable) | **POST** /user/actions/variables/{variablename} | Create a user-level variable
|
442
467
|
*Forgejo::UserApi* | [**delete_user_secret**](docs/UserApi.md#delete_user_secret) | **DELETE** /user/actions/secrets/{secretname} | Delete a secret in a user scope
|
443
468
|
*Forgejo::UserApi* | [**delete_user_variable**](docs/UserApi.md#delete_user_variable) | **DELETE** /user/actions/variables/{variablename} | Delete a user-level variable which is created by current doer
|
@@ -451,6 +476,7 @@ Class | Method | HTTP request | Description
|
|
451
476
|
*Forgejo::UserApi* | [**user_add_email**](docs/UserApi.md#user_add_email) | **POST** /user/emails | Add email addresses
|
452
477
|
*Forgejo::UserApi* | [**user_block_user**](docs/UserApi.md#user_block_user) | **PUT** /user/block/{username} | Blocks a user from the doer.
|
453
478
|
*Forgejo::UserApi* | [**user_check_following**](docs/UserApi.md#user_check_following) | **GET** /users/{username}/following/{target} | Check if one user is following another user
|
479
|
+
*Forgejo::UserApi* | [**user_check_quota**](docs/UserApi.md#user_check_quota) | **GET** /user/quota/check | Check if the authenticated user is over quota for a given subject
|
454
480
|
*Forgejo::UserApi* | [**user_create_hook**](docs/UserApi.md#user_create_hook) | **POST** /user/hooks | Create a hook
|
455
481
|
*Forgejo::UserApi* | [**user_create_o_auth2_application**](docs/UserApi.md#user_create_o_auth2_application) | **POST** /user/applications/oauth2 | creates a new OAuth2 application
|
456
482
|
*Forgejo::UserApi* | [**user_create_token**](docs/UserApi.md#user_create_token) | **POST** /users/{username}/tokens | Create an access token
|
@@ -486,6 +512,7 @@ Class | Method | HTTP request | Description
|
|
486
512
|
*Forgejo::UserApi* | [**user_get_hook**](docs/UserApi.md#user_get_hook) | **GET** /user/hooks/{id} | Get a hook
|
487
513
|
*Forgejo::UserApi* | [**user_get_o_auth2_application**](docs/UserApi.md#user_get_o_auth2_application) | **GET** /user/applications/oauth2/{id} | get an OAuth2 Application
|
488
514
|
*Forgejo::UserApi* | [**user_get_o_auth2_applications**](docs/UserApi.md#user_get_o_auth2_applications) | **GET** /user/applications/oauth2 | List the authenticated user's oauth2 applications
|
515
|
+
*Forgejo::UserApi* | [**user_get_quota**](docs/UserApi.md#user_get_quota) | **GET** /user/quota | Get quota information for the authenticated user
|
489
516
|
*Forgejo::UserApi* | [**user_get_runner_registration_token**](docs/UserApi.md#user_get_runner_registration_token) | **GET** /user/actions/runners/registration-token | Get an user's actions runner registration token
|
490
517
|
*Forgejo::UserApi* | [**user_get_stop_watches**](docs/UserApi.md#user_get_stop_watches) | **GET** /user/stopwatches | Get list of all existing stopwatches
|
491
518
|
*Forgejo::UserApi* | [**user_get_tokens**](docs/UserApi.md#user_get_tokens) | **GET** /users/{username}/tokens | List the authenticated user's access tokens
|
@@ -497,6 +524,9 @@ Class | Method | HTTP request | Description
|
|
497
524
|
*Forgejo::UserApi* | [**user_list_gpg_keys**](docs/UserApi.md#user_list_gpg_keys) | **GET** /users/{username}/gpg_keys | List the given user's GPG keys
|
498
525
|
*Forgejo::UserApi* | [**user_list_hooks**](docs/UserApi.md#user_list_hooks) | **GET** /user/hooks | List the authenticated user's webhooks
|
499
526
|
*Forgejo::UserApi* | [**user_list_keys**](docs/UserApi.md#user_list_keys) | **GET** /users/{username}/keys | List the given user's public keys
|
527
|
+
*Forgejo::UserApi* | [**user_list_quota_artifacts**](docs/UserApi.md#user_list_quota_artifacts) | **GET** /user/quota/artifacts | List the artifacts affecting the authenticated user's quota
|
528
|
+
*Forgejo::UserApi* | [**user_list_quota_attachments**](docs/UserApi.md#user_list_quota_attachments) | **GET** /user/quota/attachments | List the attachments affecting the authenticated user's quota
|
529
|
+
*Forgejo::UserApi* | [**user_list_quota_packages**](docs/UserApi.md#user_list_quota_packages) | **GET** /user/quota/packages | List the packages affecting the authenticated user's quota
|
500
530
|
*Forgejo::UserApi* | [**user_list_repos**](docs/UserApi.md#user_list_repos) | **GET** /users/{username}/repos | List the repos owned by the given user
|
501
531
|
*Forgejo::UserApi* | [**user_list_starred**](docs/UserApi.md#user_list_starred) | **GET** /users/{username}/starred | The repos that the given user has starred
|
502
532
|
*Forgejo::UserApi* | [**user_list_subscriptions**](docs/UserApi.md#user_list_subscriptions) | **GET** /users/{username}/subscriptions | List the repositories watched by a user
|
@@ -511,6 +541,12 @@ Class | Method | HTTP request | Description
|
|
511
541
|
## Documentation for Models
|
512
542
|
|
513
543
|
- [Forgejo::APIError](docs/APIError.md)
|
544
|
+
- [Forgejo::APIForbiddenError](docs/APIForbiddenError.md)
|
545
|
+
- [Forgejo::APIInvalidTopicsError](docs/APIInvalidTopicsError.md)
|
546
|
+
- [Forgejo::APINotFound](docs/APINotFound.md)
|
547
|
+
- [Forgejo::APIRepoArchivedError](docs/APIRepoArchivedError.md)
|
548
|
+
- [Forgejo::APIUnauthorizedError](docs/APIUnauthorizedError.md)
|
549
|
+
- [Forgejo::APIValidationError](docs/APIValidationError.md)
|
514
550
|
- [Forgejo::AccessToken](docs/AccessToken.md)
|
515
551
|
- [Forgejo::ActionTask](docs/ActionTask.md)
|
516
552
|
- [Forgejo::ActionTaskResponse](docs/ActionTaskResponse.md)
|
@@ -559,6 +595,8 @@ Class | Method | HTTP request | Description
|
|
559
595
|
- [Forgejo::CreatePullReviewComment](docs/CreatePullReviewComment.md)
|
560
596
|
- [Forgejo::CreatePullReviewOptions](docs/CreatePullReviewOptions.md)
|
561
597
|
- [Forgejo::CreatePushMirrorOption](docs/CreatePushMirrorOption.md)
|
598
|
+
- [Forgejo::CreateQuotaGroupOptions](docs/CreateQuotaGroupOptions.md)
|
599
|
+
- [Forgejo::CreateQuotaRuleOptions](docs/CreateQuotaRuleOptions.md)
|
562
600
|
- [Forgejo::CreateReleaseOption](docs/CreateReleaseOption.md)
|
563
601
|
- [Forgejo::CreateRepoOption](docs/CreateRepoOption.md)
|
564
602
|
- [Forgejo::CreateStatusOption](docs/CreateStatusOption.md)
|
@@ -586,6 +624,7 @@ Class | Method | HTTP request | Description
|
|
586
624
|
- [Forgejo::EditMilestoneOption](docs/EditMilestoneOption.md)
|
587
625
|
- [Forgejo::EditOrgOption](docs/EditOrgOption.md)
|
588
626
|
- [Forgejo::EditPullRequestOption](docs/EditPullRequestOption.md)
|
627
|
+
- [Forgejo::EditQuotaRuleOptions](docs/EditQuotaRuleOptions.md)
|
589
628
|
- [Forgejo::EditReactionOption](docs/EditReactionOption.md)
|
590
629
|
- [Forgejo::EditReleaseOption](docs/EditReleaseOption.md)
|
591
630
|
- [Forgejo::EditRepoOption](docs/EditRepoOption.md)
|
@@ -641,6 +680,7 @@ Class | Method | HTTP request | Description
|
|
641
680
|
- [Forgejo::NodeInfoUsage](docs/NodeInfoUsage.md)
|
642
681
|
- [Forgejo::NodeInfoUsageUsers](docs/NodeInfoUsageUsers.md)
|
643
682
|
- [Forgejo::Note](docs/Note.md)
|
683
|
+
- [Forgejo::NoteOptions](docs/NoteOptions.md)
|
644
684
|
- [Forgejo::NotificationCount](docs/NotificationCount.md)
|
645
685
|
- [Forgejo::NotificationSubject](docs/NotificationSubject.md)
|
646
686
|
- [Forgejo::NotificationThread](docs/NotificationThread.md)
|
@@ -661,6 +701,20 @@ Class | Method | HTTP request | Description
|
|
661
701
|
- [Forgejo::PullReviewComment](docs/PullReviewComment.md)
|
662
702
|
- [Forgejo::PullReviewRequestOptions](docs/PullReviewRequestOptions.md)
|
663
703
|
- [Forgejo::PushMirror](docs/PushMirror.md)
|
704
|
+
- [Forgejo::QuotaGroup](docs/QuotaGroup.md)
|
705
|
+
- [Forgejo::QuotaInfo](docs/QuotaInfo.md)
|
706
|
+
- [Forgejo::QuotaRuleInfo](docs/QuotaRuleInfo.md)
|
707
|
+
- [Forgejo::QuotaUsed](docs/QuotaUsed.md)
|
708
|
+
- [Forgejo::QuotaUsedArtifact](docs/QuotaUsedArtifact.md)
|
709
|
+
- [Forgejo::QuotaUsedAttachment](docs/QuotaUsedAttachment.md)
|
710
|
+
- [Forgejo::QuotaUsedAttachmentContainedIn](docs/QuotaUsedAttachmentContainedIn.md)
|
711
|
+
- [Forgejo::QuotaUsedPackage](docs/QuotaUsedPackage.md)
|
712
|
+
- [Forgejo::QuotaUsedSize](docs/QuotaUsedSize.md)
|
713
|
+
- [Forgejo::QuotaUsedSizeAssets](docs/QuotaUsedSizeAssets.md)
|
714
|
+
- [Forgejo::QuotaUsedSizeAssetsAttachments](docs/QuotaUsedSizeAssetsAttachments.md)
|
715
|
+
- [Forgejo::QuotaUsedSizeAssetsPackages](docs/QuotaUsedSizeAssetsPackages.md)
|
716
|
+
- [Forgejo::QuotaUsedSizeGit](docs/QuotaUsedSizeGit.md)
|
717
|
+
- [Forgejo::QuotaUsedSizeRepos](docs/QuotaUsedSizeRepos.md)
|
664
718
|
- [Forgejo::Reaction](docs/Reaction.md)
|
665
719
|
- [Forgejo::Reference](docs/Reference.md)
|
666
720
|
- [Forgejo::Release](docs/Release.md)
|
@@ -676,6 +730,7 @@ Class | Method | HTTP request | Description
|
|
676
730
|
- [Forgejo::SearchResults](docs/SearchResults.md)
|
677
731
|
- [Forgejo::Secret](docs/Secret.md)
|
678
732
|
- [Forgejo::ServerVersion](docs/ServerVersion.md)
|
733
|
+
- [Forgejo::SetUserQuotaGroupsOptions](docs/SetUserQuotaGroupsOptions.md)
|
679
734
|
- [Forgejo::StopWatch](docs/StopWatch.md)
|
680
735
|
- [Forgejo::SubmitPullReviewOptions](docs/SubmitPullReviewOptions.md)
|
681
736
|
- [Forgejo::Tag](docs/Tag.md)
|
@@ -688,6 +743,7 @@ Class | Method | HTTP request | Description
|
|
688
743
|
- [Forgejo::TopicResponse](docs/TopicResponse.md)
|
689
744
|
- [Forgejo::TrackedTime](docs/TrackedTime.md)
|
690
745
|
- [Forgejo::TransferRepoOption](docs/TransferRepoOption.md)
|
746
|
+
- [Forgejo::UpdateBranchRepoOption](docs/UpdateBranchRepoOption.md)
|
691
747
|
- [Forgejo::UpdateFileOptions](docs/UpdateFileOptions.md)
|
692
748
|
- [Forgejo::UpdateRepoAvatarOption](docs/UpdateRepoAvatarOption.md)
|
693
749
|
- [Forgejo::UpdateUserAvatarOption](docs/UpdateUserAvatarOption.md)
|
data/config.yaml
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
gemAuthor: gemmaro
|
2
|
+
gemAuthorEmail: gemmaro.dev@gmail.com
|
3
|
+
gemHomepage: https://codeberg.org/gemmaro/forgejo
|
4
|
+
gemLicense: MIT
|
5
|
+
gemName: forgejo
|
6
|
+
gemRequiredRubyVersion: ">=3.1"
|
7
|
+
gemSummary: Forgejo REST API client
|
8
|
+
gemVersion: 0.2.1
|
9
|
+
gemDescription: >
|
10
|
+
REST API library for Forge. This API is utilized by various services,
|
11
|
+
including Codeberg (codeberg.org) and Disroot (git.disroot.org).
|
12
|
+
library: faraday
|
13
|
+
moduleName: Forgejo
|
14
|
+
gemMetadata: |-
|
15
|
+
{ 'rubygems_mfa_required' => 'true',
|
16
|
+
'bug_tracker_uri' => "https://codeberg.org/gemmaro/forgejo/issues",
|
17
|
+
'changelog_uri' => "https://codeberg.org/gemmaro/forgejo/src/branch/main/CHANGELOG.md",
|
18
|
+
'documentation_uri' => 'https://www.rubydoc.info/gems/forgejo',
|
19
|
+
'homepage_uri' => 'https://codeberg.org/gemmaro/forgejo',
|
20
|
+
'source_code_uri' => 'https://codeberg.org/gemmaro/forgejo',
|
21
|
+
'wiki_uri' => "https://codeberg.org/gemmaro/forgejo/wiki" }
|
data/config.yaml~
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
gemAuthor: gemmaro
|
2
|
+
gemAuthorEmail: gemmaro.dev@gmail.com
|
3
|
+
gemHomepage: https://codeberg.org/gemmaro/forgejo
|
4
|
+
gemLicense: MIT
|
5
|
+
gemName: forgejo
|
6
|
+
gemRequiredRubyVersion: >=3.2
|
7
|
+
gemSummary: Forgejo REST API client
|
8
|
+
gemVersion: 0.1.0
|
9
|
+
gemDescription: >
|
10
|
+
REST API library for Forge. This API is utilized by various services,
|
11
|
+
including Codeberg (codeberg.org) and Disroot (git.disroot.org).
|
12
|
+
library: faraday
|
13
|
+
moduleName: Forgejo
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Forgejo::APIForbiddenError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | [optional] |
|
8
|
+
| **url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'forgejo'
|
14
|
+
|
15
|
+
instance = Forgejo::APIForbiddenError.new(
|
16
|
+
message: null,
|
17
|
+
url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Forgejo::APIInvalidTopicsError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **invalid_topics** | **Array<String>** | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'forgejo'
|
14
|
+
|
15
|
+
instance = Forgejo::APIInvalidTopicsError.new(
|
16
|
+
invalid_topics: null,
|
17
|
+
message: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/APINotFound.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Forgejo::APINotFound
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **errors** | **Array<String>** | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **url** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'forgejo'
|
15
|
+
|
16
|
+
instance = Forgejo::APINotFound.new(
|
17
|
+
errors: null,
|
18
|
+
message: null,
|
19
|
+
url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Forgejo::APIRepoArchivedError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | [optional] |
|
8
|
+
| **url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'forgejo'
|
14
|
+
|
15
|
+
instance = Forgejo::APIRepoArchivedError.new(
|
16
|
+
message: null,
|
17
|
+
url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Forgejo::APIUnauthorizedError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | [optional] |
|
8
|
+
| **url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'forgejo'
|
14
|
+
|
15
|
+
instance = Forgejo::APIUnauthorizedError.new(
|
16
|
+
message: null,
|
17
|
+
url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Forgejo::APIValidationError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | | [optional] |
|
8
|
+
| **url** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'forgejo'
|
14
|
+
|
15
|
+
instance = Forgejo::APIValidationError.new(
|
16
|
+
message: null,
|
17
|
+
url: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|