Edit a repository's properties. Only fields that are set will be changed.
const url = 'https://gitea.com/api/v1/repos/example/example';const options = { method: 'PATCH', headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'}, body: '{"allow_fast_forward_only_merge":true,"allow_manual_merge":true,"allow_merge_commits":true,"allow_merge_update":true,"allow_rebase":true,"allow_rebase_explicit":true,"allow_rebase_update":true,"allow_squash_merge":true,"archived":true,"autodetect_manual_merge":true,"default_allow_maintainer_edit":true,"default_branch":"example","default_delete_branch_after_merge":true,"default_merge_style":"example","default_update_style":"example","description":"example","enable_prune":true,"external_tracker":{"external_tracker_format":"example","external_tracker_regexp_pattern":"example","external_tracker_style":"example","external_tracker_url":"https://example.com"},"external_wiki":{"external_wiki_url":"https://example.com"},"has_actions":true,"has_code":true,"has_issues":true,"has_packages":true,"has_projects":true,"has_pull_requests":true,"has_releases":true,"has_wiki":true,"ignore_whitespace_conflicts":true,"internal_tracker":{"allow_only_contributors_to_track_time":true,"enable_issue_dependencies":true,"enable_time_tracker":true},"mirror_interval":"example","mirror_password":"example","mirror_token":"example","mirror_username":"example","name":"example","private":true,"projects_mode":"example","template":true,"website":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://gitea.com/api/v1/repos/example/example \ --header 'Authorization: Basic <credentials>' \ --header 'Content-Type: application/json' \ --data '{ "allow_fast_forward_only_merge": true, "allow_manual_merge": true, "allow_merge_commits": true, "allow_merge_update": true, "allow_rebase": true, "allow_rebase_explicit": true, "allow_rebase_update": true, "allow_squash_merge": true, "archived": true, "autodetect_manual_merge": true, "default_allow_maintainer_edit": true, "default_branch": "example", "default_delete_branch_after_merge": true, "default_merge_style": "example", "default_update_style": "example", "description": "example", "enable_prune": true, "external_tracker": { "external_tracker_format": "example", "external_tracker_regexp_pattern": "example", "external_tracker_style": "example", "external_tracker_url": "https://example.com" }, "external_wiki": { "external_wiki_url": "https://example.com" }, "has_actions": true, "has_code": true, "has_issues": true, "has_packages": true, "has_projects": true, "has_pull_requests": true, "has_releases": true, "has_wiki": true, "ignore_whitespace_conflicts": true, "internal_tracker": { "allow_only_contributors_to_track_time": true, "enable_issue_dependencies": true, "enable_time_tracker": true }, "mirror_interval": "example", "mirror_password": "example", "mirror_token": "example", "mirror_username": "example", "name": "example", "private": true, "projects_mode": "example", "template": true, "website": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Owner of the repo to edit
Name of the repo to edit
Request Body
Section titled “Request Body”Properties of a repo that you can edit
EditRepoOption options when editing a repository’s properties
object
Either true to allow fast-forward-only merging pull requests, or false to prevent fast-forward-only merging.
Either true to allow mark pr as merged manually, or false to prevent it.
Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.
Either true to allow updating pull request branch by merge, or false to prevent it.
Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.
Either true to allow rebase with explicit merge commits (–no-ff), or false to prevent rebase with explicit merge commits.
Either true to allow updating pull request branch by rebase, or false to prevent it.
Either true to allow squash-merging pull requests, or false to prevent squash-merging.
Set to true to archive this repository.
Either true to enable AutodetectManualMerge, or false to prevent it. Note: In some special cases, misjudgments can occur.
Set to true to allow edits from maintainers by default
Sets the default branch for this repository.
Set to true to delete pr branch after merge by default
Set to a merge style to be used by this repository: “merge”, “rebase”, “rebase-merge”, “squash”, or “fast-forward-only”.
Set to an update style to be used by this repository: “merge” or “rebase”.
A short description of the repository.
Enable prune - remove obsolete remote-tracking references when mirroring
ExternalTracker represents settings for external tracker
object
External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.
External Issue Tracker issue regular expression
External Issue Tracker Number Format, either numeric, alphanumeric, or regexp
URL of external issue tracker.
ExternalWiki represents setting for external wiki
object
URL of external wiki.
Either true to enable actions unit, or false to disable them.
Either true to enable code for this repository or false to disable it.
Either true to enable issues for this repository or false to disable them.
Either true to enable packages unit, or false to disable them.
Either true to enable project unit, or false to disable them.
Either true to allow pull requests, or false to prevent pull request.
Either true to enable releases unit, or false to disable them.
Either true to enable the wiki for this repository or false to disable it.
Either true to ignore whitespace for conflicts, or false to not ignore whitespace.
InternalTracker represents settings for internal tracker
object
Let only contributors track time (Built-in issue tracker)
Enable dependencies for issues and pull requests (Built-in issue tracker)
Enable time tracking (Built-in issue tracker)
Set to a string like 8h30m0s to set the mirror interval time
Authentication password for the remote repository (mirrors)
Authentication token for the remote repository (mirrors)
Authentication username for the remote repository (mirrors)
Name of the repository
Either true to make the repository private or false to make it public.
Note: you will get a 422 error if the organization restricts changing repository visibility to organization
owners and a non-owner tries to change the value of private.
repo to only allow repo-level projects, owner to only allow owner projects, all to allow both.
Either true to make this repository a template or false to make it a normal repository
A URL with more information about the repository.
Examplegenerated
{ "allow_fast_forward_only_merge": true, "allow_manual_merge": true, "allow_merge_commits": true, "allow_merge_update": true, "allow_rebase": true, "allow_rebase_explicit": true, "allow_rebase_update": true, "allow_squash_merge": true, "archived": true, "autodetect_manual_merge": true, "default_allow_maintainer_edit": true, "default_branch": "example", "default_delete_branch_after_merge": true, "default_merge_style": "example", "default_update_style": "example", "description": "example", "enable_prune": true, "external_tracker": { "external_tracker_format": "example", "external_tracker_regexp_pattern": "example", "external_tracker_style": "example", "external_tracker_url": "https://example.com" }, "external_wiki": { "external_wiki_url": "https://example.com" }, "has_actions": true, "has_code": true, "has_issues": true, "has_packages": true, "has_projects": true, "has_pull_requests": true, "has_releases": true, "has_wiki": true, "ignore_whitespace_conflicts": true, "internal_tracker": { "allow_only_contributors_to_track_time": true, "enable_issue_dependencies": true, "enable_time_tracker": true }, "mirror_interval": "example", "mirror_password": "example", "mirror_token": "example", "mirror_username": "example", "name": "example", "private": true, "projects_mode": "example", "template": true, "website": "example"}Responses
Section titled “Responses”Repository
Repository represents a repository
object
ExternalTracker represents settings for external tracker
object
External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.
External Issue Tracker issue regular expression
External Issue Tracker Number Format, either numeric, alphanumeric, or regexp
URL of external issue tracker.
ExternalWiki represents setting for external wiki
object
URL of external wiki.
InternalTracker represents settings for internal tracker
object
Let only contributors track time (Built-in issue tracker)
Enable dependencies for issues and pull requests (Built-in issue tracker)
Enable time tracking (Built-in issue tracker)
ObjectFormatName of the underlying git repository
User represents a user
object
Is user active
URL to the user’s avatar
The user’s description
User counts
The user’s full name
URL to the user’s gitea page
The user’s id
Is the user an administrator
User locale
The user’s location
Login of the user, same as username
Identifier of the user, provided by the external authenticator (if configured)
Is user login prohibited
Is user restricted
The ID of the user’s Authentication Source
User visibility level option: public, limited, private
The user’s website
Permission represents a set of permissions
object
RepoTransfer represents a pending repo transfer
object
User represents a user
object
Is user active
URL to the user’s avatar
The user’s description
User counts
The user’s full name
URL to the user’s gitea page
The user’s id
Is the user an administrator
User locale
The user’s location
Login of the user, same as username
Identifier of the user, provided by the external authenticator (if configured)
Is user login prohibited
Is user restricted
The ID of the user’s Authentication Source
User visibility level option: public, limited, private
The user’s website
User represents a user
object
Is user active
URL to the user’s avatar
The user’s description
User counts
The user’s full name
URL to the user’s gitea page
The user’s id
Is the user an administrator
User locale
The user’s location
Login of the user, same as username
Identifier of the user, provided by the external authenticator (if configured)
Is user login prohibited
Is user restricted
The ID of the user’s Authentication Source
User visibility level option: public, limited, private
The user’s website
Team represents a team in an organization
object
Whether the team can create repositories in the organization
The description of the team
The unique identifier of the team
Whether the team has access to all repositories in the organization
The name of the team
Organization represents an organization
object
The URL of the organization’s avatar
The description of the organization
The email address of the organization
The full display name of the organization
The unique identifier of the organization
The location of the organization
The name of the organization
Whether repository administrators can change team access
Username of the organization deprecated
The visibility level of the organization (public, limited, private)
The website URL of the organization
Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.
object
Team visibility within the organization. “private” teams are only listable by members and org owners; “limited” teams are listable by any organization member; “public” teams are listable by any signed-in user.
Example
{ "object_format_name": "sha1", "owner": { "visibility": "public" }, "repo_transfer": { "doer": { "visibility": "public" }, "recipient": { "visibility": "public" }, "teams": [ { "organization": { "visibility": "public" }, "permission": "none", "units": [ "repo.code", "repo.issues", "repo.ext_issues", "repo.wiki", "repo.pulls", "repo.releases", "repo.projects", "repo.ext_wiki" ], "units_map": { "repo.code": "read", "repo.ext_issues": "none", "repo.ext_wiki": "none", "repo.issues": "write", "repo.projects": "none", "repo.pulls": "owner", "repo.releases": "none", "repo.wiki": "admin" }, "visibility": "public" } ] }}APIForbiddenError is a forbidden error response
Headers
Section titled “Headers”APINotFound is a not found empty response
APIValidationError is error format response related to input validation