👁 Image
Gitea.Net.API 25.8.18

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

👁 Nuget

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

<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