npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/gitea

v3.0.0

Published

DataFire integration for Gitea API.

Downloads

3

Readme

@datafire/gitea

Client library for Gitea API.

Installation and Usage

npm install --save @datafire/gitea
let gitea = require('@datafire/gitea').create({
  AccessToken: "",
  AuthorizationHeaderToken: "",
  username: "",
  password: "",
  SudoHeader: "",
  SudoParam: "",
  TOTPHeader: "",
  Token: ""
});

.then(data => {
  console.log(data);
});

Description

This documentation describes the Gitea API.

Actions

adminCronList

List cron tasks

gitea.adminCronList({}, context)

Input

  • input object
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

adminCronRun

Run cron task

gitea.adminCronRun({
  "task": ""
}, context)

Input

  • input object
    • task required string: task to run

Output

Output schema unknown

adminGetAllOrgs

List all organizations

gitea.adminGetAllOrgs({}, context)

Input

  • input object
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

adminUnadoptedList

List unadopted repositories

gitea.adminUnadoptedList({}, context)

Input

  • input object
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results
    • pattern string: pattern of repositories to search for

Output

  • output array
    • items string

adminDeleteUnadoptedRepository

Delete unadopted files

gitea.adminDeleteUnadoptedRepository({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

Output schema unknown

adminAdoptRepository

Adopt unadopted files as a repository

gitea.adminAdoptRepository({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

Output schema unknown

adminGetAllUsers

List all users

gitea.adminGetAllUsers({}, context)

Input

  • input object
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

adminCreateUser

Create a user

gitea.adminCreateUser({}, context)

Input

Output

adminDeleteUser

Delete a user

gitea.adminDeleteUser({
  "username": ""
}, context)

Input

  • input object
    • username required string: username of user to delete

Output

Output schema unknown

adminEditUser

Edit an existing user

gitea.adminEditUser({
  "username": ""
}, context)

Input

  • input object

Output

adminCreatePublicKey

Add a public key on behalf of a user

gitea.adminCreatePublicKey({
  "username": ""
}, context)

Input

  • input object

Output

adminDeleteUserPublicKey

Delete a user's public key

gitea.adminDeleteUserPublicKey({
  "username": "",
  "id": 0
}, context)

Input

  • input object
    • username required string: username of user
    • id required integer: id of the key to delete

Output

Output schema unknown

adminCreateOrg

Create an organization

gitea.adminCreateOrg({
  "username": "",
  "organization": {
    "username": ""
  }
}, context)

Input

  • input object
    • username required string: username of the user that will own the created organization
    • organization required CreateOrgOption

Output

adminCreateRepo

Create a repository on behalf of a user

gitea.adminCreateRepo({
  "username": "",
  "repository": {
    "name": ""
  }
}, context)

Input

  • input object
    • username required string: username of the user. This user will own the created repository
    • repository required CreateRepoOption

Output

renderMarkdown

Render a markdown document as HTML

gitea.renderMarkdown({}, context)

Input

Output

  • output string

renderMarkdownRaw

Render raw markdown as HTML

gitea.renderMarkdownRaw({
  "body": ""
}, context)

Input

  • input object
    • body required string

Output

  • output string

notifyGetList

List users's notification threads

gitea.notifyGetList({}, context)

Input

  • input object
    • all string: If true, show notifications marked as read. Default value is false
    • status-types array: Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned.
    • since string: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
    • before string: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

notifyReadList

Mark notification threads as read, pinned or unread

gitea.notifyReadList({}, context)

Input

  • input object
    • last_read_at string: Describes the last point that notifications were checked. Anything updated since this time will not be updated.
    • all string: If true, mark all notifications on this repo. Default value is false
    • status-types array: Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.
    • to-status string: Status to mark notifications as, Defaults to read.

Output

Output schema unknown

notifyNewAvailable

Check if unread notifications exist

gitea.notifyNewAvailable(null, context)

Input

This action has no parameters

Output

notifyGetThread

Get notification thread by ID

gitea.notifyGetThread({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of notification thread

Output

notifyReadThread

Mark notification thread as read by ID

gitea.notifyReadThread({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of notification thread
    • to-status string: Status to mark notifications as

Output

Output schema unknown

createOrgRepoDeprecated

Create a repository in an organization

gitea.createOrgRepoDeprecated({
  "org": ""
}, context)

Input

Output

orgGetAll

Get list of organizations

gitea.orgGetAll({}, context)

Input

  • input object
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

orgCreate

Create an organization

gitea.orgCreate({
  "organization": {
    "username": ""
  }
}, context)

Input

Output

orgDelete

Delete an organization

gitea.orgDelete({
  "org": ""
}, context)

Input

  • input object
    • org required string: organization that is to be deleted

Output

Output schema unknown

orgGet

Get an organization

gitea.orgGet({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization to get

Output

orgEdit

Edit an organization

gitea.orgEdit({
  "org": "",
  "body": {}
}, context)

Input

  • input object
    • org required string: name of the organization to edit
    • body required EditOrgOption

Output

orgListHooks

List an organization's webhooks

gitea.orgListHooks({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

orgCreateHook

Create a hook

gitea.orgCreateHook({
  "org": "",
  "body": {
    "type": "",
    "config": {}
  }
}, context)

Input

  • input object

Output

orgDeleteHook

Delete a hook

gitea.orgDeleteHook({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the hook to delete

Output

Output schema unknown

orgGetHook

Get a hook

gitea.orgGetHook({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the hook to get

Output

orgEditHook

Update a hook

gitea.orgEditHook({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the hook to update
    • body EditHookOption

Output

orgListLabels

List an organization's labels

gitea.orgListLabels({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

orgCreateLabel

Create a label for an organization

gitea.orgCreateLabel({
  "org": ""
}, context)

Input

Output

orgDeleteLabel

Delete a label

gitea.orgDeleteLabel({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the label to delete

Output

Output schema unknown

orgGetLabel

Get a single label

gitea.orgGetLabel({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the label to get

Output

orgEditLabel

Update a label

gitea.orgEditLabel({
  "org": "",
  "id": 0
}, context)

Input

  • input object
    • org required string: name of the organization
    • id required integer: id of the label to edit
    • body EditLabelOption

Output

orgListMembers

List an organization's members

gitea.orgListMembers({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

orgDeleteMember

Remove a member from an organization

gitea.orgDeleteMember({
  "org": "",
  "username": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • username required string: username of the user

Output

Output schema unknown

orgIsMember

Check if a user is a member of an organization

gitea.orgIsMember({
  "org": "",
  "username": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • username required string: username of the user

Output

Output schema unknown

orgListPublicMembers

List an organization's public members

gitea.orgListPublicMembers({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

orgConcealMember

Conceal a user's membership

gitea.orgConcealMember({
  "org": "",
  "username": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • username required string: username of the user

Output

Output schema unknown

orgIsPublicMember

Check if a user is a public member of an organization

gitea.orgIsPublicMember({
  "org": "",
  "username": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • username required string: username of the user

Output

Output schema unknown

orgPublicizeMember

Publicize a user's membership

gitea.orgPublicizeMember({
  "org": "",
  "username": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • username required string: username of the user

Output

Output schema unknown

orgListRepos

List an organization's repos

gitea.orgListRepos({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

createOrgRepo

Create a repository in an organization

gitea.createOrgRepo({
  "org": ""
}, context)

Input

Output

orgListTeams

List an organization's teams

gitea.orgListTeams({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

orgCreateTeam

Create a team

gitea.orgCreateTeam({
  "org": ""
}, context)

Input

Output

teamSearch

Search for teams within an organization

gitea.teamSearch({
  "org": ""
}, context)

Input

  • input object
    • org required string: name of the organization
    • q string: keywords to search
    • include_desc boolean: include search within team description (defaults to true)
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output object
    • data array
    • ok boolean

issueSearchIssues

Search for issues across the repositories that the user has access to

gitea.issueSearchIssues({}, context)

Input

  • input object
    • state string: whether issue is open or closed
    • labels string: comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded
    • q string: search string
    • priority_repo_id integer: repository to prioritize in the results
    • type string: filter by type (issues / pulls) if set
    • since string: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
    • before string: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
    • assigned boolean: filter (issues / pulls) assigned to you, default is false
    • created boolean: filter (issues / pulls) created by you, default is false
    • mentioned boolean: filter (issues / pulls) mentioning you, default is false
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

repoMigrate

Migrate a remote git repository

gitea.repoMigrate({}, context)

Input

Output

repoSearch

Search for repositories

gitea.repoSearch({}, context)

Input

  • input object
    • q string: keyword
    • topic boolean: Limit search to repositories with keyword as topic
    • includeDesc boolean: include search of keyword within repository description
    • uid integer: search only for repos that the user with the given id owns or contributes to
    • priority_owner_id integer: repo owner to prioritize in the results
    • starredBy integer: search only for repos that the user with the given id has starred
    • private boolean: include private repositories this user has access to (defaults to true)
    • is_private boolean: show only pubic, private or all repositories (defaults to all)
    • template boolean: include template repositories this user has access to (defaults to true)
    • archived boolean: show only archived, non-archived or all repositories (defaults to all)
    • mode string: type of repository to search for. Supported values are "fork", "source", "mirror" and "collaborative"
    • exclusive boolean: if uid is given, search only for repos that the user owns
    • sort string: sort repos by attribute. Supported values are "alpha", "created", "updated", "size", and "id". Default is "alpha"
    • order string: sort order, either "asc" (ascending) or "desc" (descending). Default is "asc", ignored if "sort" is not specified.
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

repoDelete

Delete a repository

gitea.repoDelete({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo to delete
    • repo required string: name of the repo to delete

Output

Output schema unknown

repoGet

Get a repository

gitea.repoGet({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

repoEdit

Edit a repository's properties. Only fields that are set will be changed.

gitea.repoEdit({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo to edit
    • repo required string: name of the repo to edit
    • body EditRepoOption

Output

repoGetArchive

Get an archive of a repository

gitea.repoGetArchive({
  "owner": "",
  "repo": "",
  "archive": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • archive required string: the git reference for download with attached archive format (e.g. master.zip)

Output

Output schema unknown

repoListBranchProtection

List branch protections for a repository

gitea.repoListBranchProtection({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

repoCreateBranchProtection

Create a branch protections for a repository

gitea.repoCreateBranchProtection({
  "owner": "",
  "repo": ""
}, context)

Input

Output

repoDeleteBranchProtection

Delete a specific branch protection for the repository

gitea.repoDeleteBranchProtection({
  "owner": "",
  "repo": "",
  "name": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • name required string: name of protected branch

Output

Output schema unknown

repoGetBranchProtection

Get a specific branch protection for the repository

gitea.repoGetBranchProtection({
  "owner": "",
  "repo": "",
  "name": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • name required string: name of protected branch

Output

repoEditBranchProtection

Edit a branch protections for a repository. Only fields that are set will be changed

gitea.repoEditBranchProtection({
  "owner": "",
  "repo": "",
  "name": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • name required string: name of protected branch
    • body EditBranchProtectionOption

Output

repoListBranches

List a repository's branches

gitea.repoListBranches({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

repoCreateBranch

Create a branch

gitea.repoCreateBranch({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object

Output

repoDeleteBranch

Delete a specific branch from a repository

gitea.repoDeleteBranch({
  "owner": "",
  "repo": "",
  "branch": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • branch required string: branch to delete

Output

Output schema unknown

repoGetBranch

Retrieve a specific branch from a repository, including its effective branch protection

gitea.repoGetBranch({
  "owner": "",
  "repo": "",
  "branch": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • branch required string: branch to get

Output

repoListCollaborators

List a repository's collaborators

gitea.repoListCollaborators({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

repoDeleteCollaborator

Delete a collaborator from a repository

gitea.repoDeleteCollaborator({
  "owner": "",
  "repo": "",
  "collaborator": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • collaborator required string: username of the collaborator to delete

Output

Output schema unknown

repoCheckCollaborator

Check if a user is a collaborator of a repository

gitea.repoCheckCollaborator({
  "owner": "",
  "repo": "",
  "collaborator": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • collaborator required string: username of the collaborator

Output

Output schema unknown

repoAddCollaborator

Add a collaborator to a repository

gitea.repoAddCollaborator({
  "owner": "",
  "repo": "",
  "collaborator": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • collaborator required string: username of the collaborator to add
    • body AddCollaboratorOption

Output

Output schema unknown

repoGetAllCommits

Get a list of all commits from a repository

gitea.repoGetAllCommits({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • sha string: SHA or branch to start listing commits from (usually 'master')
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

repoGetCombinedStatusByRef

Get a commit's combined status, by branch/tag/commit reference

gitea.repoGetCombinedStatusByRef({
  "owner": "",
  "repo": "",
  "ref": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • ref required string: name of branch/tag/commit
    • page integer: page number of results

Output

repoGetContentsList

Gets the metadata of all the entries of the root dir

gitea.repoGetContentsList({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • ref string: The name of the commit/branch/tag. Default the repository’s default branch (usually master)

Output

repoDeleteFile

Delete a file in a repository

gitea.repoDeleteFile({
  "owner": "",
  "repo": "",
  "filepath": "",
  "body": {
    "sha": ""
  }
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • filepath required string: path of the file to delete
    • body required DeleteFileOptions

Output

repoGetContents

Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir

gitea.repoGetContents({
  "owner": "",
  "repo": "",
  "filepath": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • filepath required string: path of the dir, file, symlink or submodule in the repo
    • ref string: The name of the commit/branch/tag. Default the repository’s default branch (usually master)

Output

repoCreateFile

Create a file in a repository

gitea.repoCreateFile({
  "owner": "",
  "repo": "",
  "filepath": "",
  "body": {
    "content": ""
  }
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • filepath required string: path of the file to create
    • body required CreateFileOptions

Output

repoUpdateFile

Update a file in a repository

gitea.repoUpdateFile({
  "owner": "",
  "repo": "",
  "filepath": "",
  "body": {
    "sha": "",
    "content": ""
  }
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • filepath required string: path of the file to update
    • body required UpdateFileOptions

Output

repoGetEditorConfig

Get the EditorConfig definitions of a file in a repository

gitea.repoGetEditorConfig({
  "owner": "",
  "repo": "",
  "filepath": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • filepath required string: filepath of file to get

Output

Output schema unknown

listForks

List a repository's forks

gitea.listForks({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

createFork

Fork a repository

gitea.createFork({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo to fork
    • repo required string: name of the repo to fork
    • body CreateForkOption

Output

GetBlob

Gets the blob of a repository.

gitea.GetBlob({
  "owner": "",
  "repo": "",
  "sha": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • sha required string: sha of the commit

Output

repoGetSingleCommit

Get a single commit from a repository

gitea.repoGetSingleCommit({
  "owner": "",
  "repo": "",
  "sha": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • sha required string: a git ref or commit sha

Output

repoListAllGitRefs

Get specified ref or filtered repository's refs

gitea.repoListAllGitRefs({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

repoListGitRefs

Get specified ref or filtered repository's refs

gitea.repoListGitRefs({
  "owner": "",
  "repo": "",
  "ref": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • ref required string: part or full name of the ref

Output

GetTag

Gets the tag object of an annotated tag (not lightweight tags)

gitea.GetTag({
  "owner": "",
  "repo": "",
  "sha": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • sha required string: sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.

Output

GetTree

Gets the tree of a repository.

gitea.GetTree({
  "owner": "",
  "repo": "",
  "sha": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • sha required string: sha of the commit
    • recursive boolean: show all directories and files
    • page integer: page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page
    • per_page integer: number of items per page

Output

repoListHooks

List the hooks in a repository

gitea.repoListHooks({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

repoCreateHook

Create a hook

gitea.repoCreateHook({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • body CreateHookOption

Output

repoListGitHooks

List the Git hooks in a repository

gitea.repoListGitHooks({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

repoDeleteGitHook

Delete a Git hook in a repository

gitea.repoDeleteGitHook({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: id of the hook to get

Output

Output schema unknown

repoGetGitHook

Get a Git hook

gitea.repoGetGitHook({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: id of the hook to get

Output

repoEditGitHook

Edit a Git hook in a repository

gitea.repoEditGitHook({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: id of the hook to get
    • body EditGitHookOption

Output

repoDeleteHook

Delete a hook in a repository

gitea.repoDeleteHook({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the hook to delete

Output

Output schema unknown

repoGetHook

Get a hook

gitea.repoGetHook({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the hook to get

Output

repoEditHook

Edit a hook in a repository

gitea.repoEditHook({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: index of the hook
    • body EditHookOption

Output

repoTestHook

Test a push webhook

gitea.repoTestHook({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the hook to test

Output

Output schema unknown

repoGetIssueTemplates

Get available issue templates for a repository

gitea.repoGetIssueTemplates({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

issueListIssues

List a repository's issues

gitea.issueListIssues({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • state string (values: closed, open, all): whether issue is open or closed
    • labels string: comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded
    • q string: search string
    • type string (values: issues, pulls): filter by type (issues / pulls) if set
    • milestones string: comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issueCreateIssue

Create an issue. If using deadline only the date will be taken into account, and time of day ignored.

gitea.issueCreateIssue({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • body CreateIssueOption

Output

issueGetRepoComments

List all comments in a repository

gitea.issueGetRepoComments({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • since string: if provided, only comments updated since the provided time are returned.
    • before string: if provided, only comments updated before the provided time are returned.
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issueDeleteComment

Delete a comment

gitea.issueDeleteComment({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of comment to delete

Output

Output schema unknown

issueGetComment

Get a comment

gitea.issueGetComment({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the comment

Output

issueEditComment

Edit a comment

gitea.issueEditComment({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the comment to edit
    • body EditIssueCommentOption

Output

issueDeleteCommentReaction

Remove a reaction from a comment of an issue

gitea.issueDeleteCommentReaction({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the comment to edit
    • content EditReactionOption

Output

Output schema unknown

issueGetCommentReactions

Get a list of reactions from a comment of an issue

gitea.issueGetCommentReactions({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the comment to edit

Output

issuePostCommentReaction

Add a reaction to a comment of an issue

gitea.issuePostCommentReaction({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the comment to edit
    • content EditReactionOption

Output

issueGetIssue

Get an issue

gitea.issueGetIssue({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to get

Output

issueEditIssue

Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.

gitea.issueEditIssue({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to edit
    • body EditIssueOption

Output

issueGetComments

List all comments on an issue

gitea.issueGetComments({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • since string: if provided, only comments updated since the specified time are returned.
    • before string: if provided, only comments updated before the provided time are returned.

Output

issueCreateComment

Add a comment to an issue

gitea.issueCreateComment({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • body CreateIssueCommentOption

Output

issueDeleteCommentDeprecated

Delete a comment

gitea.issueDeleteCommentDeprecated({
  "owner": "",
  "repo": "",
  "index": 0,
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: this parameter is ignored
    • id required integer: id of comment to delete

Output

Output schema unknown

issueEditCommentDeprecated

Edit a comment

gitea.issueEditCommentDeprecated({
  "owner": "",
  "repo": "",
  "index": 0,
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: this parameter is ignored
    • id required integer: id of the comment to edit
    • body EditIssueCommentOption

Output

issueEditIssueDeadline

Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.

gitea.issueEditIssueDeadline({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to create or update a deadline on
    • body EditDeadlineOption

Output

issueClearLabels

Remove all labels from an issue

gitea.issueClearLabels({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue

Output

Output schema unknown

issueGetLabels

Get an issue's labels

gitea.issueGetLabels({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue

Output

issueAddLabel

Add a label to an issue

gitea.issueAddLabel({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • body IssueLabelsOption

Output

issueReplaceLabels

Replace an issue's labels

gitea.issueReplaceLabels({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • body IssueLabelsOption

Output

issueRemoveLabel

Remove a label from an issue

gitea.issueRemoveLabel({
  "owner": "",
  "repo": "",
  "index": 0,
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • id required integer: id of the label to remove

Output

Output schema unknown

issueDeleteIssueReaction

Remove a reaction from an issue

gitea.issueDeleteIssueReaction({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • content EditReactionOption

Output

Output schema unknown

issueGetIssueReactions

Get a list reactions of an issue

gitea.issueGetIssueReactions({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issuePostIssueReaction

Add a reaction to an issue

gitea.issuePostIssueReaction({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • content EditReactionOption

Output

issueDeleteStopWatch

Delete an issue's existing stopwatch.

gitea.issueDeleteStopWatch({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to stop the stopwatch on

Output

Output schema unknown

issueStartStopWatch

Start stopwatch on an issue.

gitea.issueStartStopWatch({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to create the stopwatch on

Output

Output schema unknown

issueStopStopWatch

Stop an issue's existing stopwatch.

gitea.issueStopStopWatch({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to stop the stopwatch on

Output

Output schema unknown

issueSubscriptions

Get users who subscribed on an issue.

gitea.issueSubscriptions({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

  • output array

issueCheckSubscription

Check if user is subscribed to an issue

gitea.issueCheckSubscription({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue

Output

issueDeleteSubscription

Unsubscribe user from issue

gitea.issueDeleteSubscription({
  "owner": "",
  "repo": "",
  "index": 0,
  "user": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • user required string: user witch unsubscribe

Output

Output schema unknown

issueAddSubscription

Subscribe user to issue

gitea.issueAddSubscription({
  "owner": "",
  "repo": "",
  "index": 0,
  "user": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • user required string: user to subscribe

Output

Output schema unknown

issueResetTime

Reset a tracked time of an issue

gitea.issueResetTime({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue to add tracked time to

Output

Output schema unknown

issueTrackedTimes

List an issue's tracked times

gitea.issueTrackedTimes({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • since string: Only show times updated after the given time. This is a timestamp in RFC 3339 format
    • before string: Only show times updated before the given time. This is a timestamp in RFC 3339 format
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issueAddTime

Add tracked time to a issue

gitea.issueAddTime({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • body AddTimeOption

Output

issueDeleteTime

Delete specific tracked time

gitea.issueDeleteTime({
  "owner": "",
  "repo": "",
  "index": 0,
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the issue
    • id required integer: id of time to delete

Output

Output schema unknown

repoListKeys

List a repository's keys

gitea.repoListKeys({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • key_id integer: the key_id to search for
    • fingerprint string: fingerprint of the key
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

repoCreateKey

Add a key to a repository

gitea.repoCreateKey({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • body CreateKeyOption

Output

repoDeleteKey

Delete a key from a repository

gitea.repoDeleteKey({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the key to delete

Output

Output schema unknown

repoGetKey

Get a repository's key by id

gitea.repoGetKey({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the key to get

Output

issueListLabels

Get all of a repository's labels

gitea.issueListLabels({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issueCreateLabel

Create a label

gitea.issueCreateLabel({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • body CreateLabelOption

Output

issueDeleteLabel

Delete a label

gitea.issueDeleteLabel({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the label to delete

Output

Output schema unknown

issueGetLabel

Get a single label

gitea.issueGetLabel({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the label to get

Output

issueEditLabel

Update a label

gitea.issueEditLabel({
  "owner": "",
  "repo": "",
  "id": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required integer: id of the label to edit
    • body EditLabelOption

Output

repoGetLanguages

Get languages and number of bytes of code written

gitea.repoGetLanguages({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo

Output

  • output object

issueGetMilestonesList

Get all of a repository's opened milestones

gitea.issueGetMilestonesList({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • state string: Milestone state, Recognised values are open, closed and all. Defaults to "open"
    • name string: filter by milestone name
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

issueCreateMilestone

Create a milestone

gitea.issueCreateMilestone({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object

Output

issueDeleteMilestone

Delete a milestone

gitea.issueDeleteMilestone({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: the milestone to delete, identified by ID and if not available by name

Output

Output schema unknown

issueGetMilestone

Get a milestone

gitea.issueGetMilestone({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: the milestone to get, identified by ID and if not available by name

Output

issueEditMilestone

Update a milestone

gitea.issueEditMilestone({
  "owner": "",
  "repo": "",
  "id": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • id required string: the milestone to edit, identified by ID and if not available by name
    • body EditMilestoneOption

Output

repoMirrorSync

Sync a mirrored repository

gitea.repoMirrorSync({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo to sync
    • repo required string: name of the repo to sync

Output

Output schema unknown

notifyGetRepoList

List users's notification threads on a specific repo

gitea.notifyGetRepoList({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • all string: If true, show notifications marked as read. Default value is false
    • status-types array: Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned
    • since string: Only show notifications updated after the given time. This is a timestamp in RFC 3339 format
    • before string: Only show notifications updated before the given time. This is a timestamp in RFC 3339 format
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

notifyReadRepoList

Mark notification threads as read, pinned or unread on a specific repo

gitea.notifyReadRepoList({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • all string: If true, mark all notifications on this repo. Default value is false
    • status-types array: Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.
    • to-status string: Status to mark notifications as. Defaults to read.
    • last_read_at string: Describes the last point that notifications were checked. Anything updated since this time will not be updated.

Output

Output schema unknown

repoListPullRequests

List a repo's pull requests

gitea.repoListPullRequests({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • state string (values: closed, open, all): State of pull request: open or closed (optional)
    • sort string (values: oldest, recentupdate, leastupdate, mostcomment, leastcomment, priority): Type of sort
    • milestone integer: ID of the milestone
    • labels array: Label IDs
    • page integer: page number of results to return (1-based)
    • limit integer: page size of results

Output

repoCreatePullRequest

Create a pull request

gitea.repoCreatePullRequest({
  "owner": "",
  "repo": ""
}, context)

Input

  • input object

Output

repoGetPullRequest

Get a pull request

gitea.repoGetPullRequest({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request to get

Output

repoEditPullRequest

Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.

gitea.repoEditPullRequest({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request to edit
    • body EditPullRequestOption

Output

repoDownloadPullDiff

Get a pull request diff

gitea.repoDownloadPullDiff({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request to get

Output

  • output string

repoDownloadPullPatch

Get a pull request patch file

gitea.repoDownloadPullPatch({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request to get

Output

  • output string

repoPullRequestIsMerged

Check if a pull request has been merged

gitea.repoPullRequestIsMerged({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request

Output

Output schema unknown

repoMergePullRequest

Merge a pull request

gitea.repoMergePullRequest({
  "owner": "",
  "repo": "",
  "index": 0
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request to merge
    • body MergePullRequestOption

Output

Output schema unknown

repoDeletePullReviewRequests

cancel review requests for a pull request

gitea.repoDeletePullReviewRequests({
  "owner": "",
  "repo": "",
  "index": 0,
  "body": {}
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request
    • body required PullReviewRequestOptions

Output

Output schema unknown

repoCreatePullReviewRequests

create review requests for a pull request

gitea.repoCreatePullReviewRequests({
  "owner": "",
  "repo": "",
  "index": 0,
  "body": {}
}, context)

Input

  • input object
    • owner required string: owner of the repo
    • repo required string: name of the repo
    • index required integer: index of the pull request
    • body required PullReviewRequestOptions

Output

repoListPullReviews

List all reviews for a pull request

gitea.repoListPullReviews({
  "owner": "",
  "repo": "",
  "index": 0
}, co