Gitea.Net.API 1.0.0

Gitea.Net.API - the C# library for the Gitea API

This documentation describes the Gitea API.

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.22.0
• SDK version: 1.0.0
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

<a id="frameworks-supported"></a>

Frameworks supported

<a id="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 13.0.2 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a id="installation"></a>

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Gitea.Net.Api;
using Gitea.Net.Client;
using Gitea.Net.Model;

<a id="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Gitea.Net.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Gitea.Net.Api;
using Gitea.Net.Client;
using Gitea.Net.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "/api/v1";
            // Configure API key authorization: TOTPHeader
            config.ApiKey.Add("X-GITEA-OTP", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-GITEA-OTP", "Bearer");
            // Configure API key authorization: AuthorizationHeaderToken
            config.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Authorization", "Bearer");
            // Configure API key authorization: SudoHeader
            config.ApiKey.Add("Sudo", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("Sudo", "Bearer");
            // Configure HTTP basic authorization: BasicAuth
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure API key authorization: AccessToken
            config.ApiKey.Add("access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("access_token", "Bearer");
            // Configure API key authorization: SudoParam
            config.ApiKey.Add("sudo", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("sudo", "Bearer");
            // Configure API key authorization: Token
            config.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new ActivitypubApi(config);
            var userId = 56;  // int | user ID of the user

            try
            {
                // Returns the Person actor for a user
                ActivityPub result = apiInstance.ActivitypubPerson(userId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ActivitypubApi.ActivitypubPerson: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to /api/v1

<a id="documentation-for-models"></a>

Documentation for Models

• Model.APIError
• Model.AccessToken
• Model.ActionVariable
• Model.Activity
• Model.ActivityPub
• Model.AddCollaboratorOption
• Model.AddTimeOption
• Model.AnnotatedTag
• Model.AnnotatedTagObject
• Model.Attachment
• Model.Badge
• Model.Branch
• Model.BranchProtection
• Model.ChangeFileOperation
• Model.ChangeFilesOptions
• Model.ChangedFile
• Model.CombinedStatus
• Model.Comment
• Model.Commit
• Model.CommitAffectedFiles
• Model.CommitDateOptions
• Model.CommitMeta
• Model.CommitStats
• Model.CommitStatus
• Model.CommitUser
• Model.Compare
• Model.ContentsResponse
• Model.CreateAccessTokenOption
• Model.CreateBranchProtectionOption
• Model.CreateBranchRepoOption
• Model.CreateEmailOption
• Model.CreateFileOptions
• Model.CreateForkOption
• Model.CreateGPGKeyOption
• Model.CreateHookOption
• Model.CreateIssueCommentOption
• Model.CreateIssueOption
• Model.CreateKeyOption
• Model.CreateLabelOption
• Model.CreateMilestoneOption
• Model.CreateOAuth2ApplicationOptions
• Model.CreateOrUpdateSecretOption
• Model.CreateOrgOption
• Model.CreatePullRequestOption
• Model.CreatePullReviewComment
• Model.CreatePullReviewOptions
• Model.CreatePushMirrorOption
• Model.CreateReleaseOption
• Model.CreateRepoOption
• Model.CreateStatusOption
• Model.CreateTagOption
• Model.CreateTeamOption
• Model.CreateUserOption
• Model.CreateVariableOption
• Model.CreateWikiPageOptions
• Model.Cron
• Model.DeleteEmailOption
• Model.DeleteFileOptions
• Model.DeployKey
• Model.DismissPullReviewOptions
• Model.EditAttachmentOptions
• Model.EditBranchProtectionOption
• Model.EditDeadlineOption
• Model.EditGitHookOption
• Model.EditHookOption
• Model.EditIssueCommentOption
• Model.EditIssueOption
• Model.EditLabelOption
• Model.EditMilestoneOption
• Model.EditOrgOption
• Model.EditPullRequestOption
• Model.EditReactionOption
• Model.EditReleaseOption
• Model.EditRepoOption
• Model.EditTeamOption
• Model.EditUserOption
• Model.Email
• Model.ExternalTracker
• Model.ExternalWiki
• Model.FileCommitResponse
• Model.FileDeleteResponse
• Model.FileLinksResponse
• Model.FileResponse
• Model.FilesResponse
• Model.GPGKey
• Model.GPGKeyEmail
• Model.GeneralAPISettings
• Model.GeneralAttachmentSettings
• Model.GeneralRepoSettings
• Model.GeneralUISettings
• Model.GenerateRepoOption
• Model.GitBlobResponse
• Model.GitEntry
• Model.GitHook
• Model.GitObject
• Model.GitTreeResponse
• Model.GitignoreTemplateInfo
• Model.Hook
• Model.Identity
• Model.InternalTracker
• Model.Issue
• Model.IssueConfig
• Model.IssueConfigContactLink
• Model.IssueConfigValidation
• Model.IssueDeadline
• Model.IssueFormField
• Model.IssueLabelsOption
• Model.IssueMeta
• Model.IssueTemplate
• Model.Label
• Model.LabelTemplate
• Model.LicenseTemplateInfo
• Model.LicensesTemplateListEntry
• Model.MarkdownOption
• Model.MarkupOption
• Model.MergePullRequestOption
• Model.MigrateRepoOptions
• Model.Milestone
• Model.NewIssuePinsAllowed
• Model.NodeInfo
• Model.NodeInfoServices
• Model.NodeInfoSoftware
• Model.NodeInfoUsage
• Model.NodeInfoUsageUsers
• Model.Note
• Model.NotificationCount
• Model.NotificationSubject
• Model.NotificationThread
• Model.OAuth2Application
• Model.Organization
• Model.OrganizationPermissions
• Model.PRBranchInfo
• Model.Package
• Model.PackageFile
• Model.PayloadCommit
• Model.PayloadCommitVerification
• Model.PayloadUser
• Model.Permission
• Model.PublicKey
• Model.PullRequest
• Model.PullRequestMeta
• Model.PullReview
• Model.PullReviewComment
• Model.PullReviewRequestOptions
• Model.PushMirror
• Model.Reaction
• Model.Reference
• Model.Release
• Model.RenameUserOption
• Model.RepoCollaboratorPermission
• Model.RepoCommit
• Model.RepoCreateReleaseAttachmentRequest
• Model.RepoTopicOptions
• Model.RepoTransfer
• Model.Repository
• Model.RepositoryMeta
• Model.SearchResults
• Model.Secret
• Model.ServerVersion
• Model.StopWatch
• Model.SubmitPullReviewOptions
• Model.Tag
• Model.Team
• Model.TeamSearch200Response
• Model.TimelineComment
• Model.TopicName
• Model.TopicResponse
• Model.TrackedTime
• Model.TransferRepoOption
• Model.UpdateFileOptions
• Model.UpdateRepoAvatarOption
• Model.UpdateUserAvatarOption
• Model.UpdateVariableOption
• Model.User
• Model.UserBadgeOption
• Model.UserHeatmapData
• Model.UserSearch200Response
• Model.UserSettings
• Model.UserSettingsOptions
• Model.WatchInfo
• Model.WikiCommit
• Model.WikiCommitList
• Model.WikiPage
• Model.WikiPageMetaData

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="AccessToken"></a>

AccessToken

• Type: API key
• API key parameter name: access_token
• Location: URL query string

<a id="AuthorizationHeaderToken"></a>

AuthorizationHeaderToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

<a id="BasicAuth"></a>

BasicAuth

• Type: HTTP basic authentication

<a id="SudoHeader"></a>

SudoHeader

• Type: API key
• API key parameter name: Sudo
• Location: HTTP header

<a id="SudoParam"></a>

SudoParam

• Type: API key
• API key parameter name: sudo
• Location: URL query string

<a id="TOTPHeader"></a>

TOTPHeader

• Type: API key
• API key parameter name: X-GITEA-OTP
• Location: HTTP header

<a id="Token"></a>

Token

• Type: API key
• API key parameter name: token
• Location: URL query string