Gitea SDK

https://pkg.go.dev/code.gitea.io/sdk/gitea
Admin
Gitea SDK is a Go client library for interacting with Gitea server APIs, providing functionality for...
Tokens:136,412
Snippets:1,635
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GetFile

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a file from a repository.

```APIDOC
## GetFile

### Description
Gets a file from a repository.

### Method
GetFile

### Signature
func (c *Client) GetFile(owner, repo, ref, filepath string, resolveLFS ...bool) ([]byte, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **ref** (string) - Required - Reference (branch, tag, commit)
- **filepath** (string) - Required - Path to the file
- **resolveLFS** (bool) - Optional - Whether to resolve LFS pointers

### Returns
- **[]byte** - File data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetDeployKey

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a deploy key.

```APIDOC
## GetDeployKey

### Description
Gets a deploy key.

### Method
GetDeployKey

### Signature
func (c *Client) GetDeployKey(user, repo string, keyID int64) (*DeployKey, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **keyID** (int64) - Required - ID of the deploy key

### Returns
- **DeployKey** - Deploy key data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetGlobalAPISettings

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets global API settings.

```APIDOC
## GetGlobalAPISettings

### Description
Gets global API settings.

### Method
GetGlobalAPISettings

### Signature
func (c *Client) GetGlobalAPISettings() (*GlobalAPISettings, *Response, error)

### Returns
- **GlobalAPISettings** - Global API settings
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### WatchRepo

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Starts to watch a repository.

```APIDOC
## WatchRepo

### Description
Starts to watch a repository.

### Method
PUT

### Endpoint
/repos/{owner}/{repo}/subscription

### Parameters
#### Path Parameters
- **owner** (string) - Required - The owner of the repository.
- **repo** (string) - Required - The name of the repository.

### Response
#### Success Response (200)
- **Response** - The HTTP response.

#### Error Response
- **error** - An error, if any.
```

--------------------------------

### StartIssueStopWatch

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Starts a stopwatch for an existing issue in a given repository.

```APIDOC
## StartIssueStopWatch

### Description
Starts a stopwatch for an existing issue in a given repository.

### Method
Client method

### Endpoint
`func (c *Client) StartIssueStopWatch(owner, repo string, index int64) (*Response, error)`

### Parameters
- **owner** (string) - Required - Owner of the repository.
- **repo** (string) - Required - Name of the repository.
- **index** (int64) - Required - Index of the issue.

### Response
Returns `*Response` and error.
```

--------------------------------

### GetGlobalUISettings

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets global UI settings.

```APIDOC
## GetGlobalUISettings

### Description
Gets global UI settings.

### Method
GetGlobalUISettings

### Signature
func (c *Client) GetGlobalUISettings() (*GlobalUISettings, *Response, error)

### Returns
- **GlobalUISettings** - Global UI settings
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetGlobalRepoSettings

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets global repository settings.

```APIDOC
## GetGlobalRepoSettings

### Description
Gets global repository settings.

### Method
GetGlobalRepoSettings

### Signature
func (c *Client) GetGlobalRepoSettings() (*GlobalRepoSettings, *Response, error)

### Returns
- **GlobalRepoSettings** - Global repository settings
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetGitignoreTemplateInfo

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets information about a gitignore template.

```APIDOC
## GetGitignoreTemplateInfo

### Description
Gets information about a gitignore template.

### Method
GetGitignoreTemplateInfo

### Signature
func (c *Client) GetGitignoreTemplateInfo(name string) (*GitignoreTemplateInfo, *Response, error)

### Parameters
- **name** (string) - Required - Name of the gitignore template

### Returns
- **GitignoreTemplateInfo** - Template info
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetGlobalAPISettings

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get global API settings exposed by the API.

```APIDOC
## GetGlobalAPISettings

### Description
GetGlobalAPISettings get global api settings witch are exposed by it

### Method
GET

### Endpoint
/global/api/settings

### Response
#### Success Response (200)
- **GlobalAPISettings** (object) - Global API settings

#### Response Example
```json
{
  "GlobalAPISettings": {}
}
```
```

--------------------------------

### GetAdminHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a system webhook by ID.

```APIDOC
## GetAdminHook

### Description
Gets a system webhook by ID.

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
- **id** (int64) - Required - ID of the hook

### Response
- **Hook** - The hook
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### ClientOption

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

ClientOption are functions used to init a new client.

```APIDOC
## ClientOption

### Description
ClientOption are functions used to init a new client.

### Type
func(*Client) error

### Functions
- **SetBasicAuth** - Sets username and password for authentication.
- **SetContext** - Sets the default context.
- **SetDebugMode** - Enables debug mode.
- **SetGiteaVersion** - Configures the client to assume the given version of the Gitea server.
- **SetHTTPClient** - Sets a custom HTTP client.
- **SetOTP** - Sets OTP for 2FA.
```

--------------------------------

### GetMilestone

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a milestone.

```APIDOC
## GetMilestone

### Description
Gets a milestone.

### Method
GetMilestone

### Signature
func (c *Client) GetMilestone(owner, repo string, id int64) (*Milestone, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **id** (int64) - Required - ID of the milestone

### Returns
- **Milestone** - Milestone data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateDeployKey

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a deploy key.

```APIDOC
## CreateDeployKey

### Description
CreateDeployKey creates a deploy key with options.

### Method
CreateDeployKey

### Signature
`func (c *Client) CreateDeployKey(user, repo string, opt CreateKeyOption) (*DeployKey, *Response, error)`

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **opt** (CreateKeyOption) - Required - Options for creating the deploy key

### Returns
- **DeployKey** - The created deploy key
- **Response** - The HTTP response
- **error** - Error if any
```

--------------------------------

### GetIssue

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an issue.

```APIDOC
## GetIssue

### Description
Gets an issue.

### Method
GetIssue

### Signature
func (c *Client) GetIssue(owner, repo string, index int64) (*Issue, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **index** (int64) - Required - Issue index

### Returns
- **Issue** - Issue data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreatePublicKey

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a public key with options.

```APIDOC
## CreatePublicKey

### Description
CreatePublicKey creates a public key with options.

### Method
CreatePublicKey

### Signature
func (c *Client) CreatePublicKey(opt CreateKeyOption) (*PublicKey, *Response, error)

### Parameters
- **opt** (CreateKeyOption) - Required - Options for creating the public key.

### Returns
- **PublicKey** - The created public key.
- **Response** - The HTTP response.
- **error** - An error if the operation failed.
```

--------------------------------

### GetRepoHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a hook of a repository.

```APIDOC
## GetRepoHook

### Description
Gets a hook of a repository.

### Method
GET

### Endpoint
/repos/{user}/{repo}/hooks/{id}

### Parameters
#### Path Parameters
- **user** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **id** (int64) - Required - Hook ID

### Response
#### Success Response (200)
- **Hook** (Hook) - Hook object

#### Response Example
```json
{
  "id": 1,
  "type": "gitea"
}
```
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Initializes a new Gitea API client with the given base URL and optional client options.

```APIDOC
## NewClient

### Description
Initializes and returns a Gitea API client. Usage of all gitea.Client methods is concurrency-safe.

### Method
Function

### Endpoint
NewClient(url string, options ...ClientOption) (*Client, error)

### Parameters
- **url** (string) - Required - The base URL of the Gitea instance.
- **options** (...ClientOption) - Optional - Additional client options.

### Response
- **client** (*Client) - The initialized API client.
- **error** (error) - An error if initialization fails.

```

--------------------------------

### GetLabelTemplate

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get all labels in a template.

```APIDOC
## GetLabelTemplate

### Description
GetLabelTemplate gets all labels in a template

### Method
GET

### Endpoint
/label_templates/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the label template

### Response
#### Success Response (200)
- **LabelTemplate** (array) - List of label templates

#### Response Example
```json
[
  {}
]
```
```

--------------------------------

### AdminCreateRepo

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a repository as an admin.

```APIDOC
## AdminCreateRepo

### Description
Creates a repository as an admin.

### Method
POST

### Endpoint
/admin/users/{user}/repos

### Parameters
#### Path Parameters
- **user** (string) - Required - The username of the user to create the repository for.

#### Request Body
- **opt** (CreateRepoOption) - Required - The repository details.

### Response
#### Success Response (200)
- **Repository** - The created repository.
- **Response** - The HTTP response.
- **error** - An error if the operation failed.

#### Response Example
```json
{
  "repository": {},
  "response": {},
  "error": null
}
```
```

--------------------------------

### GetIssueCommentAttachment

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get a comment attachment.

```APIDOC
## GetIssueCommentAttachment

### Description
GetIssueCommentAttachment gets a comment attachment

### Method
GET

### Endpoint
/repos/{owner}/{repo}/issues/comments/{commentID}/attachments/{attachmentID}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **commentID** (int64) - Required - ID of the comment
- **attachmentID** (int64) - Required - ID of the attachment

### Response
#### Success Response (200)
- **Attachment** (object) - The attachment

#### Response Example
```json
{
  "Attachment": {}
}
```
```

--------------------------------

### AdminCreateRepo

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a repository.

```APIDOC
## AdminCreateRepo

### Description
Creates a repository.

### Method
AdminCreateRepo

### Signature
`func (c *Client) AdminCreateRepo(user string, opt CreateRepoOption) (*Repository, *Response, error)`

### Parameters
- **user** (string) - Required - Username of the user who will own the repository.
- **opt** (CreateRepoOption) - Required - Options for creating a repository.

### Returns
- **Repository** - The created repository.
- **Response** - The HTTP response.
- **error** - An error if any.
```

--------------------------------

### GetIssueAttachment

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get an issue attachment.

```APIDOC
## GetIssueAttachment

### Description
GetIssueAttachment gets an issue attachment.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/issues/{index}/attachments/{attachmentID}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **index** (int64) - Required - Index of the issue
- **attachmentID** (int64) - Required - ID of the attachment

### Response
#### Success Response (200)
- **Attachment** (object) - The attachment

#### Response Example
```json
{
  "Attachment": {}
}
```
```

--------------------------------

### GetMilestoneByName

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a milestone by name.

```APIDOC
## GetMilestoneByName

### Description
Gets a milestone by name.

### Method
GetMilestoneByName

### Signature
func (c *Client) GetMilestoneByName(owner, repo, name string) (*Milestone, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **name** (string) - Required - Name of the milestone

### Returns
- **Milestone** - Milestone data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### PushMirrors

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a push mirror for a repository.

```APIDOC
## PushMirrors

### Description
Creates a push mirror for a repository.

### Method
POST

### Endpoint
/repos/{user}/{repo}/push_mirrors

### Parameters
#### Path Parameters
- **user** (string) - Required - The owner of the repository
- **repo** (string) - Required - The name of the repository

#### Request Body
- **opt** (CreatePushMirrorOption) - Required - Push mirror options

### Response
#### Success Response (201)
- ***PushMirrorResponse** - The created push mirror

#### Response Example
```json
{
  "id": 1
}
```
```

--------------------------------

### CreateDeployKey

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a deploy key for a repository.

```APIDOC
## CreateDeployKey

### Description
Creates a deploy key for a repository.

### Method
POST

### Endpoint
/repos/{user}/{repo}/keys

### Parameters
#### Path Parameters
- **user** (string) - Required - The owner of the repository.
- **repo** (string) - Required - The name of the repository.

#### Request Body
- **opt** (CreateKeyOption) - Required - The options for creating the deploy key.

### Response
#### Success Response (201)
- **DeployKey** - The created deploy key.

#### Error Response
- **Response** - The HTTP response.
- **error** - The error, if any.
```

--------------------------------

### GetLabelTemplate

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a label template.

```APIDOC
## GetLabelTemplate

### Description
Gets a label template.

### Method
GetLabelTemplate

### Signature
func (c *Client) GetLabelTemplate(name string) ([]*LabelTemplate, *Response, error)

### Parameters
- **name** (string) - Required - Name of the label template

### Returns
- **[]*LabelTemplate** - List of label templates
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### Release struct

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Release represents a repository release.

```go
type Release struct {
	ID           int64         `json:"id"`
	TagName      string        `json:"tag_name"`
	Target       string        `json:"target_commitish"`
	Title        string        `json:"name"`
	Note         string        `json:"body"`
	URL          string        `json:"url"`
	HTMLURL      string        `json:"html_url"`
	TarURL       string        `json:"tarball_url"`
	ZipURL       string        `json:"zipball_url"`
	IsDraft      bool          `json:"draft"`
	IsPrerelease bool          `json:"prerelease"`
	CreatedAt    time.Time     `json:"created_at"`
	PublishedAt  time.Time     `json:"published_at"`
	Publisher    *User         `json:"author"`
	Attachments  []*Attachment `json:"assets"`
}
```

--------------------------------

### GetIssueLabels

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets labels of an issue.

```APIDOC
## GetIssueLabels

### Description
Gets labels of an issue.

### Method
GetIssueLabels

### Signature
func (c *Client) GetIssueLabels(owner, repo string, index int64, opts ListLabelsOptions) ([]*Label, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **index** (int64) - Required - Issue index
- **opts** (ListLabelsOptions) - Required - Options for listing labels

### Returns
- **[]*Label** - List of labels
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### ListPackages

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Lists packages for an owner. Returns a slice of Package pointers and a Response.

```APIDOC
## ListPackages

### Description
Lists packages for an owner.

### Method
func (c *Client) ListPackages(owner string, opt ListPackagesOptions) ([]*Package, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the packages.
- **opt** (ListPackagesOptions) - Required - Options for listing packages.

### Response
Returns a slice of *Package and a *Response.
```

--------------------------------

### GetIssueComment

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a comment on an issue.

```APIDOC
## GetIssueComment

### Description
Gets a comment on an issue.

### Method
GetIssueComment

### Signature
func (c *Client) GetIssueComment(owner, repo string, id int64) (*Comment, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **id** (int64) - Required - ID of the comment

### Returns
- **Comment** - Comment data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateAdminHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a system webhook.

```APIDOC
## CreateAdminHook

### Description
CreateAdminHook creates a system webhook.

### Method
CreateAdminHook

### Signature
`func (c *Client) CreateAdminHook(opt CreateHookOption) (*Hook, *Response, error)`

### Parameters
- **opt** (CreateHookOption) - Required - Options for creating the hook

### Returns
- **Hook** - The created hook
- **Response** - The HTTP response
- **error** - Error if any
```

--------------------------------

### GetIssueAttachment

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an attachment of an issue.

```APIDOC
## GetIssueAttachment

### Description
Gets an attachment of an issue.

### Method
GetIssueAttachment

### Signature
func (c *Client) GetIssueAttachment(owner, repo string, index, attachmentID int64) (*Attachment, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **index** (int64) - Required - Issue index
- **attachmentID** (int64) - Required - ID of the attachment

### Returns
- **Attachment** - Attachment data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### ListDeployKeys

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Lists deploy keys for a repository.

```APIDOC
## ListDeployKeys

### Description
Lists deploy keys for a repository.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/keys

### Parameters
#### Path Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository

#### Query Parameters
- **opt** (ListDeployKeysOptions) - Required - Options for listing deploy keys

### Response
#### Success Response (200)
- **[]*DeployKey** ([]*DeployKey) - List of deploy keys
- **Response** (*Response) - HTTP response object

#### Error Response
- **error** (error) - Error if any
```

--------------------------------

### GetGPGKey

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a GPG key.

```APIDOC
## GetGPGKey

### Description
Gets a GPG key.

### Method
GetGPGKey

### Signature
func (c *Client) GetGPGKey(keyID int64) (*GPGKey, *Response, error)

### Parameters
- **keyID** (int64) - Required - ID of the GPG key

### Returns
- **GPGKey** - GPG key data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### Follow

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Sets current user to follow the target.

```APIDOC
## Follow

### Description
Sets current user to follow the target.

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
- **target** (string) - Required - Target user to follow

### Response
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetEditorConfig

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets the editorconfig for a file.

```APIDOC
## GetEditorConfig

### Description
Gets the editorconfig for a file.

### Method
GetEditorConfig

### Signature
func (c *Client) GetEditorConfig(owner, repo, filepath string, ref ...string) ([]byte, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **filepath** (string) - Required - Path to the file
- **ref** (string) - Optional - Reference (branch, tag, commit)

### Returns
- **[]byte** - Editorconfig data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateFile

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a file in a repository.

```APIDOC
## CreateFile

### Description
CreateFile creates a file in a repository.

### Method
CreateFile

### Signature
`func (c *Client) CreateFile(owner, repo, filepath string, opt CreateFileOptions) (*FileResponse, *Response, error)`

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **filepath** (string) - Required - Path of the file to create
- **opt** (CreateFileOptions) - Required - Options for creating the file

### Returns
- **FileResponse** - The response containing file information
- **Response** - The HTTP response
- **error** - Error if any
```

--------------------------------

### GetCommitPatch

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets the patch of a commit.

```APIDOC
## GetCommitPatch

### Description
Gets the patch of a commit.

### Method
GetCommitPatch

### Signature
func (c *Client) GetCommitPatch(user, repo, commitID string) ([]byte, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **commitID** (string) - Required - ID of the commit

### Returns
- **[]byte** - Patch data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetCommitDiff

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets the diff of a commit.

```APIDOC
## GetCommitDiff

### Description
Gets the diff of a commit.

### Method
GetCommitDiff

### Signature
func (c *Client) GetCommitDiff(user, repo, commitID string) ([]byte, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **commitID** (string) - Required - ID of the commit

### Returns
- **[]byte** - Diff data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### AdminCreateOrg

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates an organization as an admin.

```APIDOC
## AdminCreateOrg

### Description
Creates an organization as an admin.

### Method
POST

### Endpoint
/admin/users/{user}/orgs

### Parameters
#### Path Parameters
- **user** (string) - Required - The username of the user to create the organization for.

#### Request Body
- **opt** (CreateOrgOption) - Required - The organization details.

### Response
#### Success Response (200)
- **Organization** - The created organization.
- **Response** - The HTTP response.
- **error** - An error if the operation failed.

#### Response Example
```json
{
  "organization": {},
  "response": {},
  "error": null
}
```
```

--------------------------------

### GetBlob

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a blob from a repository.

```APIDOC
## GetBlob

### Description
Gets a blob from a repository.

### Method
GetBlob

### Signature
func (c *Client) GetBlob(user, repo, sha string) (*GitBlobResponse, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **sha** (string) - Required - SHA of the blob

### Returns
- **GitBlobResponse** - Blob data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### AdminCreateOrg

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates an organization.

```APIDOC
## AdminCreateOrg

### Description
Creates an organization.

### Method
AdminCreateOrg

### Signature
`func (c *Client) AdminCreateOrg(user string, opt CreateOrgOption) (*Organization, *Response, error)`

### Parameters
- **user** (string) - Required - Username of the user who will own the organization.
- **opt** (CreateOrgOption) - Required - Options for creating an organization.

### Returns
- **Organization** - The created organization.
- **Response** - The HTTP response.
- **error** - An error if any.
```

--------------------------------

### GetAssignees

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets assignees for a repository.

```APIDOC
## GetAssignees

### Description
Gets assignees for a repository.

### Method
GetAssignees

### Signature
func (c *Client) GetAssignees(user, repo string) ([]*User, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository

### Returns
- **[]*User** - List of assignees
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateFile

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a new file in a repository.

```APIDOC
## CreateFile

### Description
Creates a new file in a repository.

### Method
POST

### Endpoint
/repos/{owner}/{repo}/contents/{filepath}

### Parameters
#### Path Parameters
- **owner** (string) - Required - The owner of the repository.
- **repo** (string) - Required - The name of the repository.
- **filepath** (string) - Required - The path of the file to create.

#### Request Body
- **opt** (CreateFileOptions) - Required - The options for creating the file.

### Response
#### Success Response (201)
- **FileResponse** - The created file information.

#### Error Response
- **Response** - The HTTP response.
- **error** - The error, if any.
```

--------------------------------

### NewClientWithHTTP

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a new Gitea API client with the given base URL and HTTP client.

```APIDOC
## NewClientWithHTTP

### Description
Creates a new Gitea API client with the given base URL and HTTP client.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **url** (string) - Required - The base URL of the Gitea instance.
- **httpClient** (*http.Client) - Required - The HTTP client to use.

### Response
#### Success Response (200)
- **Client** - The new client.

#### Response Example
```json
{
  "client": {}
}
```
```

--------------------------------

### GetArchive

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an archive of a repository.

```APIDOC
## GetArchive

### Description
Gets an archive of a repository.

### Method
GetArchive

### Signature
func (c *Client) GetArchive(owner, repo, ref string, ext ArchiveType) ([]byte, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **ref** (string) - Required - Reference (branch, tag, commit)
- **ext** (ArchiveType) - Required - Archive type (e.g., zip, tar.gz)

### Returns
- **[]byte** - Archive data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetAnnotatedTag

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an annotated tag.

```APIDOC
## GetAnnotatedTag

### Description
Gets an annotated tag.

### Method
GetAnnotatedTag

### Signature
func (c *Client) GetAnnotatedTag(user, repo, sha string) (*AnnotatedTag, *Response, error)

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **sha** (string) - Required - SHA of the tag

### Returns
- **AnnotatedTag** - Annotated tag data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateWikiPage

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a new wiki page.

```APIDOC
## CreateWikiPage

### Description
Creates a new wiki page.

### Method
CreateWikiPage

### Signature
```go
func (c *Client) CreateWikiPage(owner, repo string, opt CreateWikiPageOptions) (*WikiPage, *Response, error)
```

### Parameters
- **owner** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **opt** (CreateWikiPageOptions) - Required - Options for creating the wiki page

### Returns
- **WikiPage** - The created wiki page
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### CreateRepoFromTemplate

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a repository using a template.

```APIDOC
## CreateRepoFromTemplate

### Description
Creates a repository using a template.

### Method
CreateRepoFromTemplate

### Signature
```go
func (c *Client) CreateRepoFromTemplate(templateOwner, templateRepo string, opt CreateRepoFromTemplateOption) (*Repository, *Response, error)
```

### Parameters
- **templateOwner** (string) - Required - Template repository owner
- **templateRepo** (string) - Required - Template repository name
- **opt** (CreateRepoFromTemplateOption) - Required - Options for creating from template

### Returns
- **Repository** - The created repository
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetAdminHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an admin hook.

```APIDOC
## GetAdminHook

### Description
Gets an admin hook.

### Method
GetAdminHook

### Signature
func (c *Client) GetAdminHook(id int64) (*Hook, *Response, error)

### Parameters
- **id** (int64) - Required - ID of the hook

### Returns
- **Hook** - Hook data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### GetActivityPubPerson

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets an ActivityPub person.

```APIDOC
## GetActivityPubPerson

### Description
Gets an ActivityPub person.

### Method
GetActivityPubPerson

### Signature
func (c *Client) GetActivityPubPerson(userID int64) (ActivityPub, *Response, error)

### Parameters
- **userID** (int64) - Required - ID of the user

### Returns
- **ActivityPub** - ActivityPub person data
- **Response** - HTTP response
- **error** - Error if any
```

--------------------------------

### NewClient

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a new Gitea API client with the given base URL and options.

```APIDOC
## NewClient

### Description
Creates a new Gitea API client with the given base URL and options.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Request Body
- **url** (string) - Required - The base URL of the Gitea instance.
- **options** ([]ClientOption) - Optional - Client options.

### Response
#### Success Response (200)
- **Client** - The new client.
- **error** - An error if the client could not be created.

#### Response Example
```json
{
  "client": {},
  "error": null
}
```
```

--------------------------------

### CreateFork

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Forks a repository.

```APIDOC
## CreateFork

### Description
Forks a repository.

### Method
POST

### Endpoint
/repos/{user}/{repo}/forks

### Parameters
#### Path Parameters
- **user** (string) - Required - The owner of the repository.
- **repo** (string) - Required - The name of the repository.

#### Request Body
- **form** (CreateForkOption) - Required - The options for creating the fork.

### Response
#### Success Response (202)
- **Repository** - The forked repository.

#### Error Response
- **Response** - The HTTP response.
- **error** - The error, if any.
```

--------------------------------

### GetRepoLicenses

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets the detected licenses for a repository.

```APIDOC
## GetRepoLicenses

### Description
Gets the detected licenses for a repository.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/licenses

### Parameters
#### Path Parameters
- **owner** (string) - Required - The owner of the repository.
- **repo** (string) - Required - The name of the repository.

### Response
#### Success Response (200)
- **[]string** - A list of license names.

### Response Example
[
  "MIT",
  "Apache-2.0"
]
```

--------------------------------

### func (c *Client) StartIssueStopWatch(owner, repo string, index int64) (*Response, error)

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Starts a stopwatch for an issue. This method is part of the Gitea SDK for Go and requires the owner, repository name, and issue index.

```APIDOC
## StartIssueStopWatch

### Description
Starts a stopwatch for an issue.

### Method
Client method

### Signature
func (c *Client) StartIssueStopWatch(owner, repo string, index int64) (*Response, error)

### Parameters
- **owner** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **index** (int64) - Required - Index of the issue

### Returns
- **Response** - API response
- **error** - Error if any
```

--------------------------------

### GetRepoGitHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a Git hook of a repository.

```APIDOC
## GetRepoGitHook

### Description
Gets a Git hook of a repository.

### Method
GET

### Endpoint
/repos/{user}/{repo}/hooks/git/{id}

### Parameters
#### Path Parameters
- **user** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **id** (string) - Required - Hook ID

### Response
#### Success Response (200)
- **GitHook** (GitHook) - Git hook object

#### Response Example
```json
{
  "id": "pre-commit",
  "content": "..."
}
```
```

--------------------------------

### GetRepoActionWorkflow

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets one repository workflow.

```APIDOC
## GetRepoActionWorkflow

### Description
Gets one repository workflow.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/actions/workflows/{workflowID}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **workflowID** (string) - Required - Workflow ID

### Response
#### Success Response (200)
- **ActionWorkflow** (ActionWorkflow) - Workflow object

#### Response Example
```json
{
  "id": 1,
  "name": "workflow"
}
```
```

--------------------------------

### Version

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Returns the version of the Gitea API client.

```APIDOC
## Version

### Description
Returns the version of the Gitea API client.

### Method
N/A

### Endpoint
N/A

### Response
#### Success Response (200)
- **string** - The version string.

#### Response Example
```json
{
  "version": "v0.25.1"
}
```
```

--------------------------------

### GetRepoActionArtifact

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets one repository artifact.

```APIDOC
## GetRepoActionArtifact

### Description
Gets one repository artifact.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/actions/artifacts/{artifactID}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **artifactID** (int64) - Required - Artifact ID

### Response
#### Success Response (200)
- **ActionArtifact** (ActionArtifact) - Artifact object

#### Response Example
```json
{
  "id": 1,
  "name": "artifact"
}
```
```

--------------------------------

### func Version() string

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Returns the library version.

```APIDOC
## func Version

### Description
Returns the library version.

### Signature
```go
func Version() string
```

### Parameters
None.

### Returns
- **string** - The library version.
```

--------------------------------

### GetReleaseByTag

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a release of a repository by tag.

```APIDOC
## GetReleaseByTag

### Description
Gets a release of a repository by tag.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/releases/tags/{tag}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **tag** (string) - Required - Tag name

### Response
#### Success Response (200)
- **Release** (Release) - Release object

#### Response Example
```json
{
  "id": 1,
  "tag_name": "v1.0.0"
}
```
```

--------------------------------

### Reference struct

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Reference represents a Git reference.

```go
type Reference struct {
	Ref    string     `json:"ref"`
	URL    string     `json:"url"`
	Object *GitObject `json:"object"`
}
```

--------------------------------

### GetRelease

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Gets a release of a repository by ID.

```APIDOC
## GetRelease

### Description
Gets a release of a repository by ID.

### Method
GET

### Endpoint
/repos/{owner}/{repo}/releases/{id}

### Parameters
#### Path Parameters
- **owner** (string) - Required - Repository owner
- **repo** (string) - Required - Repository name
- **id** (int64) - Required - Release ID

### Response
#### Success Response (200)
- **Release** (Release) - Release object

#### Response Example
```json
{
  "id": 1,
  "tag_name": "v1.0.0"
}
```
```

--------------------------------

### ListMyRepos

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Lists repositories of the authenticated user. Returns a slice of Repository pointers and a Response.

```APIDOC
## ListMyRepos

### Description
Lists repositories of the authenticated user.

### Method
func (c *Client) ListMyRepos(opt ListReposOptions) ([]*Repository, *Response, error)

### Parameters
- **opt** (ListReposOptions) - Required - Options for listing repositories.

### Response
Returns a slice of *Repository and a *Response.
```

--------------------------------

### GetMyHook

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get a hook of the authenticated user.

```APIDOC
## GetMyHook

### Description
GetMyHook get a hook of the authenticated user

### Method
GET

### Endpoint
/user/hooks/{id}

### Parameters
#### Path Parameters
- **id** (int64) - Required - ID of the hook

### Response
#### Success Response (200)
- **Hook** (object) - The hook

#### Response Example
```json
{
  "Hook": {}
}
```
```

--------------------------------

### CreateFork

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates a fork of a repository.

```APIDOC
## CreateFork

### Description
CreateFork creates a fork of a repository.

### Method
CreateFork

### Signature
`func (c *Client) CreateFork(user, repo string, form CreateForkOption) (*Repository, *Response, error)`

### Parameters
- **user** (string) - Required - Owner of the repository
- **repo** (string) - Required - Name of the repository
- **form** (CreateForkOption) - Required - Options for creating the fork

### Returns
- **Repository** - The forked repository
- **Response** - The HTTP response
- **error** - Error if any
```

--------------------------------

### ListPackageFiles

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Lists files of a package version. Returns a slice of PackageFile pointers and a Response.

```APIDOC
## ListPackageFiles

### Description
Lists files of a package version.

### Method
func (c *Client) ListPackageFiles(owner, packageType, name, version string) ([]*PackageFile, *Response, error)

### Parameters
- **owner** (string) - Required - Owner of the package.
- **packageType** (string) - Required - Type of the package.
- **name** (string) - Required - Name of the package.
- **version** (string) - Required - Version of the package.

### Response
Returns a slice of *PackageFile and a *Response.
```

--------------------------------

### GetLicenseTemplateInfo

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Get information about a license template.

```APIDOC
## GetLicenseTemplateInfo

### Description
GetLicenseTemplateInfo gets information about a license template

### Method
GET

### Endpoint
/licenses/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - Name of the license template

### Response
#### Success Response (200)
- **LicenseTemplateInfo** (object) - Information about the license template

#### Response Example
```json
{
  "LicenseTemplateInfo": {}
}
```
```

--------------------------------

### CreateOrg

Source: https://pkg.go.dev/code.gitea.io/sdk/gitea

Creates an organization.

```APIDOC
## CreateOrg

### Description
CreateOrg creates an organization.

### Method
CreateOrg

### Signature
func (c *Client) CreateOrg(opt CreateOrgOption) (*Organization, *Response, error)

### Parameters
- **opt** (CreateOrgOption) - Required - Options for creating the organization.

### Returns
- **Organization** - The created organization.
- **Response** - The HTTP response.
- **error** - An error if the operation failed.
```
Tokens:
Raw