GitCode REST API

https://docs.gitcode.com/en/docs/apis
Admin
The GitCode REST API allows developers to programmatically interact with GitCode resources,...
Tokens:256,998
Snippets:717
Trust Score:9.6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Raw File - Node.js Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This Node.js example uses the 'axios' library to fetch raw file content from GitCode. It sends a GET request and logs the response data. Install axios using 'npm install axios'.

```javascript
const axios = require('axios');

async function getRawFile() {
  const owner = ':owner';
  const repo = ':repo';
  const path = ':path';
  const accessToken = '<your_access_token>';
  const url = `https://api.gitcode.com/api/v5/repos/${owner}/${repo}/raw/${path}?access_token=${accessToken}`;

  try {
    const response = await axios.get(url);
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching raw file:', error);
  }
}

getRawFile();
```

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

### HTTP GET Request Example (C#)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-enterprises-enterprise-issues

This C# code snippet demonstrates how to initiate an HTTP GET request to the GitCode API using HttpClient. It sets up the request with the appropriate HTTP method and URL.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/enterprises/:enterprise/issues");

```

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

### Get Repository Settings API Request (C#)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-repo-settings

C# code example using HttpClient to fetch repository settings. It sets up the request, sends it, and reads the JSON response.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/repos/:owner/:repo/repo_settings");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Get Raw File - Go Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This Go program demonstrates fetching raw file content from GitCode using the net/http package. It makes a GET request and prints the response body. Ensure you substitute the placeholder values.

```go
package main

import (
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	url := "https://api.gitcode.com/api/v5/repos/:owner/:repo/raw/:path?access_token=<your_access_token>"
	resp, err := http.Get(url)
	if err != nil {
		fmt.Println("Error making request:", err)
		return
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		fmt.Println("Error reading response body:", err)
		return
	}

	fmt.Println(string(body))
}
```

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

### Get Raw File - C Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This C code snippet illustrates how to retrieve raw file content using libcurl. It sets up a cURL handle, specifies the URL with parameters, and then performs the request, printing the output. Ensure libcurl is installed.

```c
#include <stdio.h>
#include <curl/curl.h>

size_t write_callback(char *ptr, size_t size, size_t nmemb, void *userdata) {
    printf("%s", ptr);
    return size * nmemb;
}

int main() {
    CURL *curl;
    CURLcode res;

    curl_global_init(CURL_GLOBAL_ALL);
    curl = curl_easy_init();

    if(curl) {
        char url[256];
        sprintf(url, "https://api.gitcode.com/api/v5/repos/:owner/:repo/raw/:path?access_token=<your_access_token>");

        curl_easy_setopt(curl, CURLOPT_URL, url);
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_callback);
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);

        res = curl_easy_perform(curl);

        if(res != CURLE_OK)
            fprintf(stderr, "curl_easy_perform() failed: %s\n",
                    curl_easy_strerror(res));

        curl_easy_cleanup(curl);
    }

    curl_global_cleanup();
    return 0;
}
```

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

### Get Raw File - Ruby Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This Ruby code snippet demonstrates fetching raw file content using the Net::HTTP library. It constructs the URL, makes a GET request, and prints the response body. Ensure you replace the placeholder values.

```ruby
require 'net/http'
require 'uri'

def get_raw_file
  owner = ':owner'
  repo = ':repo'
  path = ':path'
  access_token = '<your_access_token>'
  uri = URI.parse("https://api.gitcode.com/api/v5/repos/#{owner}/#{repo}/raw/#{path}?access_token=#{access_token}")

  response = Net::HTTP.get(uri)
  puts response
rescue => e
  puts "Error fetching raw file: #{e.message}"
end

get_raw_file
```

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

### Get Raw File - C# Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This C# code snippet demonstrates how to fetch the raw content of a file using HttpClient. It sends a GET request to the GitCode API and prints the response content. Ensure you replace placeholders like ':owner', ':repo', and ':path' with actual values.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/repos/:owner/:repo/raw/:path");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Successful Token Response Example

Source: https://docs.gitcode.com/en/docs/apis/post-oauth-token-grant-type-authorization-code-code-code-client-id-client-id-client-secret-client-secret

Provides an example of a successful response when obtaining or refreshing an access token. Includes `access_token`, `expires_in`, `refresh_token`, `scope`, and `created_at`.

```json
{
  "access_token": "eyPZPVNfsibj9tap_ibj3t3p",
  "expires_in": 1296000,
  "refresh_token": "b77ced3aee884348852160deab3697a1",
  "scope": "all_user all_key all_groups all_projects all_pr all_issue all_note all_hook all_repository",
  "created_at": "2024-04-20T09:07:59.889Z"
}

```

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

### Get Raw File - Kotlin Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This Kotlin code snippet demonstrates fetching raw file content using the Ktor client. It sends a GET request to the GitCode API and prints the response. Make sure to add the necessary Ktor dependencies.

```kotlin
import io.ktor.client.request.*
import io.ktor.client.statement.*
import io.ktor.client.*
import kotlinx.coroutines.*

fun main() = runBlocking {
    val client = HttpClient()
    val owner = ":owner"
    val repo = ":repo"
    val path = ":path"
    val accessToken = "<your_access_token>"
    val url = "https://api.gitcode.com/api/v5/repos/$owner/$repo/raw/$path?access_token=$accessToken"

    try {
        val response: String = client.get(url)
        println(response)
    } catch (e: Exception) {
        println("Error: ${e.message}")
    }
    client.close()
}
```

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

### C# HttpClient Example for GitCode API

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-pulls-number

Demonstrates how to initialize an HttpClient in C# for making requests to the GitCode API. This is a foundational snippet for any C# integration.

```csharp
var client = new HttpClient();
```

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

### Get Raw File - Python Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This Python code snippet uses the 'requests' library to get raw file content from GitCode. It sends a GET request and prints the response text. Install 'requests' using 'pip install requests'.

```python
import requests

def get_raw_file():
    owner = ':owner'
    repo = ':repo'
    path = ':path'
    access_token = '<your_access_token>'
    url = f"https://api.gitcode.com/api/v5/repos/{owner}/{repo}/raw/{path}?access_token={access_token}"

    try:
        response = requests.get(url)
        response.raise_for_status()  # Raise an exception for bad status codes
        print(response.text)
    except requests.exceptions.RequestException as e:
        print(f"Error fetching raw file: {e}")

get_raw_file()
```

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

### Create Repository Request (C#)

Source: https://docs.gitcode.com/en/docs/apis/post-api-v-5-orgs-org-repos

Demonstrates how to create a new repository using the GitCode API with C#. It utilizes HttpClient to send a POST request with a JSON payload containing repository details. Ensure you replace placeholder values and provide a valid organization and access token.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.gitcode.com/api/v5/orgs/:org/repos");  
request.Headers.Add("Accept", "application/json");  
var content = new StringContent("{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"homepage\": \"string\",\n  \"has_issues\": true,\n  \"has_wiki\": true,\n  \"can_comment\": true,\n  \"public\": 0,\n  \"private\": true,\n  \"auto_init\": true,\n  \"gitignore_template\": \"string\",\n  \"license_template\": \"string\",\n  \"path\": \"string\",\n  \"default_branch\": \"string\",\n  \"import_url\": \"string\",\n  \"project_template\": \"string\",\n  \"repository_type\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```

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

### Get Repository Collaborators in JavaScript (Node.js)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-collaborators

This Node.js example uses the `axios` library to fetch repository collaborators. It sends a GET request to the GitCode API endpoint and logs the response data. Make sure to install `axios` (`npm install axios`).

```javascript
const axios = require('axios');

async function getCollaborators(owner, repo, accessToken) {
  try {
    const response = await axios.get(`https://api.gitcode.com/api/v5/repos/${owner}/${repo}/collaborators`, {
      params: {
        access_token: accessToken
      },
      headers: {
        'Accept': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching collaborators:', error);
  }
}

// Example usage:
// getCollaborators('owner', 'repo', 'YOUR_ACCESS_TOKEN');
```

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

### Get User Subscriptions using HttpClient in C#

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-user-username-subscriptions

Demonstrates how to fetch a user's subscriptions from the GitCode API using C#'s HttpClient. This involves creating an HttpRequestMessage, setting the accept header, sending the request, ensuring a successful status code, and reading the response content as a string. No external libraries beyond the standard .NET framework are required.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/users/:username/subscriptions");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Get Repository Issue Comment (nodejs)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-issues-comments-id

This Node.js example utilizes the 'axios' library to make a GET request to the GitCode API for fetching an issue comment. It demonstrates setting up the request URL with parameters and handling the response. Ensure you install axios (`npm install axios`) before running.

```nodejs
const axios = require('axios');

async function getIssueComment(owner, repo, id, accessToken) {
  try {
    const response = await axios.get('https://api.gitcode.com/api/v5/repos/:owner/:repo/issues/comments/:id', {
      params: {
        access_token: accessToken
      },
      headers: {
        'Accept': 'application/json'
      }
    });
    console.log(response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching issue comment:', error.response ? error.response.data : error.message);
  }
}

// Example usage:
// getIssueComment('YOUR_OWNER', 'YOUR_REPO', 'YOUR_COMMENT_ID', 'YOUR_ACCESS_TOKEN');
```

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

### List Project Tags using curl

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-tags

This example shows how to fetch project tags using the curl command-line tool. It illustrates constructing the URL with placeholders for owner and repository, and requires an access token for authentication.

```shell
curl -X GET \
  'https://api.gitcode.com/api/v5/repos/:owner/:repo/tags?access_token=YOUR_ACCESS_TOKEN&page=1&per_page=100' \
  -H 'Accept: application/json'
```

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

### Get PR Associated Issue using JavaScript (Node.js)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-pulls-number-issues

This Node.js example uses the `axios` library to make a GET request to the GitCode API for associated issues. It includes error handling and logs the response data. Make sure to install axios (`npm install axios`) and replace the placeholder parameters.

```javascript
const axios = require('axios');

async function getAssociatedIssues(owner, repo, number, accessToken) {
  const url = `https://api.gitcode.com/api/v5/repos/${owner}/${repo}/pulls/${number}/issues?access_token=${accessToken}`;
  try {
    const response = await axios.get(url, {
      headers: {
        'Accept': 'application/json'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching issues:', error);
  }
}

// Example usage:
// getAssociatedIssues('sytest', 'paopao', 1, 'YOUR_ACCESS_TOKEN');
```

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

### Get Pull Requests - C# Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-pulls

This C# code snippet demonstrates how to fetch a list of pull requests from a GitCode repository using HttpClient. It sends a GET request to the API and prints the JSON response. Ensure you have the appropriate permissions and replace placeholders with actual owner and repository names.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/repos/:owner/:repo/pulls");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Get Repository Collaborators using C

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-collaborators

This C code example demonstrates fetching repository collaborators using libcurl. It sets up the URL with parameters and performs a GET request, printing the response. Ensure libcurl is installed and linked.

```c
#include <stdio.h>
#include <curl/curl.h>

size_t write_callback(void *ptr, size_t size, size_t nmemb, void *userdata) {
    return size * nmemb;
}

int main(void) {
    CURL *curl;
    CURLcode res;

    curl_global_init(CURL_GLOBAL_ALL);
    curl = curl_easy_init();

    if(curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gitcode.com/api/v5/repos/:owner/:repo/collaborators?access_token=YOUR_ACCESS_TOKEN");
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_callback);
        
        res = curl_easy_perform(curl);

        if(res != CURLE_OK)
            fprintf(stderr, "curl_easy_perform() failed: %s\n",
                    curl_easy_strerror(res));

        curl_easy_cleanup(curl);
    }
    curl_global_cleanup();
    return 0;
}
```

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

### GitCode API Example Response: printf Repository

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-search-repositories

An example of a successful response from the GitCode API for the 'printf' repository. This JSON object provides a concrete illustration of the data returned for a repository, aiding developers in parsing and utilizing API results.

```JSON
{
  "id": 1401745,
  "full_name": "gh_mirrors/pr/printf",
  "human_name": "GitHub Acceleration Program / pr / printf",
  "url": "https://api.gitcode.com/api/v5/repos/gh_mirrors/pr/printf",
  "namespace": {
    "id": 2192766,
    "type": "enterprise",
    "name": "pr",
    "path": "pr",
    "html_url": "https://gitcode.com/pr"
  },
  "path": "printf",
  "name": "printf",
  "description": "Tiny, fast, non-dependent and fully loaded printf implementation for embedded systems. Extensive test suite passing.",
  "status": "start",
  "ssh_url_to_repo": "git@gitcode.com:gh_mirrors/pr/printf.git",
  "http_url_to_repo": "https://gitcode.com/gh_mirrors/pr/printf.git",
  "web_url": "https://gitcode.com/gh_mirrors/pr/printf"
}
```

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

### Get Raw File - R Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This R code snippet uses the 'httr' package to retrieve raw file content from GitCode. It constructs the URL and makes a GET request, then prints the content. Install 'httr' using 'install.packages("httr")'.

```r
library(httr)

get_raw_file <- function() {
  owner <- ":owner"
  repo <- ":repo"
  path <- ":path"
  accessToken <- "<your_access_token>"
  url <- paste0("https://api.gitcode.com/api/v5/repos/", owner, "/", repo, "/raw/", path, "?access_token=", accessToken)

  response <- GET(url)

  if (status_code(response) == 200) {
    content(response, "text")
  } else {
    stop(paste("Failed to retrieve file. Status code:", status_code(response)))
  }
}

raw_content <- get_raw_file()
print(raw_content)
```

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

### C# HttpClient Example for GitCode API

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-orgs-org-issues

This C# code snippet demonstrates how to use HttpClient to fetch issues from the GitCode API. It sends a GET request and handles the response, ensuring success and printing the content.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v5/orgs/:org/issues");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

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

### Get Raw File - PHP Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This PHP code snippet demonstrates fetching raw file content using cURL. It sets the URL, executes the request, and outputs the response. Ensure the cURL extension is enabled in your PHP installation.

```php
<?php

$owner = ':owner';
$repo = ':repo';
$path = ':path';
$accessToken = '<your_access_token>';
$url = "https://api.gitcode.com/api/v5/repos/{$owner}/{$repo}/raw/{$path}?access_token={$accessToken}";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
city_setopt($ch, CURLOPT_HEADER, 0);

$output = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Curl error: ' . curl_error($ch);
}

city_close($ch);

echo $output;

?>
```

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

### GitCode API Example Response: allure2 Repository

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-search-repositories

An example of a successful response from the GitCode API for the 'allure2' repository. This JSON object illustrates the populated fields and their typical values, useful for understanding API output.

```JSON
{
  "id": 1431191,
  "full_name": "gh_mirrors/al/allure2",
  "human_name": "GitHub Acceleration Program / al / allure2",
  "url": "https://api.gitcode.com/api/v5/repos/gh_mirrors/al/allure2",
  "namespace": {
    "id": 2192652,
    "type": "enterprise",
    "name": "al",
    "path": "al",
    "html_url": "https://gitcode.com/al"
  },
  "path": "allure2",
  "name": "allure2",
  "description": "Allure Report is a flexible, lightweight multi-language test reporting tool. It provides clear graphical reports and allows everyone involved in the development process to extract the maximum of information from the everyday testing process",
  "status": "start",
  "ssh_url_to_repo": "git@gitcode.com:gh_mirrors/al/allure2.git",
  "http_url_to_repo": "https://gitcode.com/gh_mirrors/al/allure2.git",
  "web_url": "https://gitcode.com/gh_mirrors/al/allure2",
  "created_at": "2023-12-18T00:42:15.557+08:00",
  "updated_at": "2024-11-05T10:54:59.948+08:00",
  "homepage": "https://gitcode.com/gh_mirrors/al/allure2",
  "members": [
    "Gitcode-Assistant",
    "coco_gitcode",
    "gitshumei"
  ],
  "forks_count": 0,
  "stargazers_count": 9,
  "relation": "",
  "permission": {
    "push": false
  },
  "internal": false,
  "open_issues_count": 0,
  "has_issue": false,
  "watchers_count": 4,
  "enterprise": {
    "id": 2192652,
    "path": "al",
    "html_url": "https://gitcode.com/al",
    "type": "enterprise"
  },
  "default_branch": "main",
  "fork": false,
  "pushed_at": "2024-08-06T23:34:38.476+08:00",
  "owner": {
    "id": "69090",
    "login": "coco_gitcode",
    "name": "GitCode high-quality project",
    "type": "User"
  },
  "issue_template_source": "project",
  "private": false,
  "public": true
}
```

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

### Get Raw File - HTTP Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This is a basic HTTP GET request example for retrieving raw file content from GitCode. It outlines the necessary components of the request, including the URL and required parameters.

```http
GET /api/v5/repos/:owner/:repo/raw/:path?access_token=<your_access_token> HTTP/1.1
Host: api.gitcode.com
Accept: application/json
```

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

### Basic GitCode API Request Example

Source: https://docs.gitcode.com/en/docs/apis/index

This example demonstrates a basic GET request to the GitCode API to retrieve user information. It requires specifying the API path and version (currently /api/v5). The placeholder '{username}' should be replaced with the actual username.

```curl
curl "https://api.gitcode.com/api/v5/users/{username}"
```

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

### Get Repository Issue Comment (python)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-issues-comments-id

This Python code uses the 'requests' library to get a repository issue comment from the GitCode API. It constructs the URL with the access token and sends a GET request. The JSON response is then printed. Ensure you have 'requests' installed (`pip install requests`).

```python
import requests

def get_issue_comment(owner, repo, id, access_token):
    url = f"https://api.gitcode.com/api/v5/repos/{owner}/{repo}/issues/comments/{id}"
    params = {
        'access_token': access_token
    }
    headers = {
        'Accept': 'application/json'
    }

    try:
        response = requests.get(url, params=params, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Error fetching issue comment: {e}")
        return None

# Example usage:
# owner = "YOUR_OWNER"
# repo = "YOUR_REPO"
# comment_id = "YOUR_COMMENT_ID"
# access_token = "YOUR_ACCESS_TOKEN"
# comment_data = get_issue_comment(owner, repo, comment_id, access_token)
# if comment_data:
#     print(comment_data)

```

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

### Example Role and Permission Data (Owner)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-collaborators-self-permission

Provides an example JSON payload representing an 'Owner' role with specific permissions across different resources like 'repo', 'code', 'wiki', and 'member'. This illustrates a real-world application of the defined schema, showing assigned actions and selected permissions for a user.

```json
{
  "role_info": {
    "role_uuid": "45a9-276d8e546f1b05f9f98ce1ffdc6",
    "name": "Owner",
    "cn_name": "Administrator",
    "roles_type": 1,
    "access_level": 50
  },
  "resource_trees": [
    {
      "resource_id": 2,
      "name": "repo",
      "cn_name": "Project",
      "scope": "repo",
      "actions": [
        {
          "permission_id": 5,
          "action": "fork",
          "name": "fork",
          "cn_name": "fork",
          "selected": true
        },
        {
          "permission_id": 6,
          "action": "update",
          "name": "update",
          "cn_name": "Update",
          "selected": true
        },
        {
          "permission_id": 7,
          "action": "delete",
          "name": "delete",
          "cn_name": "Please professionally translate the following content into English, keeping the format unchanged. If the content is empty, do not translate it. Do not output anything else or any prompts!! Delete",
          "selected": true
        },
        {
          "permission_id": 8,
          "action": "setting",
          "name": "setting",
          "cn_name": "Set",
          "selected": true
        },
        {
          "permission_id": 9,
          "action": "archive",
          "name": "archive",
          "cn_name": "Archive",
          "selected": true
        },
        {
          "permission_id": 10,
          "action": "transfer",
          "name": "transfer",
          "cn_name": "Transfer",
          "selected": true
        }
      ]
    },
    {
      "resource_id": 4,
      "name": "code",
      "cn_name": "```code\n```",
      "scope": "code",
      "actions": [
        {
          "permission_id": 14,
          "action": "push",
          "name": "push",
          "cn_name": "Push notification",
          "selected": true
        },
        {
          "permission_id": 15,
          "action": "download",
          "name": "download",
          "cn_name": "Download",
          "selected": true
        }
      ]
    },
    {
      "resource_id": 14,
      "name": "wiki",
      "cn_name": "Wiki",
      "scope": "wiki",
      "actions": [
        {
          "permission_id": 48,
          "action": "push",
          "name": "push",
          "cn_name": "Push notification",
          "selected": true
        },
        {
          "permission_id": 49,
          "action": "download",
          "name": "download",
          "cn_name": "Download",
          "selected": true
        }
      ]
    },
    {
      "resource_id": 5,
      "name": "member",
      "cn_name": "member",
      "scope": "member",
      "actions": [
        {
          "permission_id": 16,
          "action": "create",
          "name": "create",
          "cn_name": "Invitation",
          "selected": true
        },
        {
          "permission_id": 17,
          "action": "update",
          "name": "update",
          "cn_name": "Update",
          "selected": true
        },
        {
          "permission_id": 18,
          "action": "delete",
          "name": "delete",
          "cn_name": "Delete",
          "selected": true
        }
      ]
    }
  ]
}
```

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

### Get Raw File - JavaScript Example

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-raw-path

This JavaScript example uses the fetch API to retrieve raw file content from GitCode. It sends a GET request and logs the response body to the console. Replace the placeholder parameters with your actual values.

```javascript
async function getRawFile() {
  const owner = ':owner';
  const repo = ':repo';
  const path = ':path';
  const accessToken = '<your_access_token>';
  const url = `https://api.gitcode.com/api/v5/repos/${owner}/${repo}/raw/${path}?access_token=${accessToken}`;

  try {
    const response = await fetch(url);
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const data = await response.text();
    console.log(data);
  } catch (error) {
    console.error('Error fetching raw file:', error);
  }
}

getRawFile();
```

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

### Get User Starred Repositories (Java)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-user-username-starred

Illustrates how to fetch starred repositories using Java's `HttpClient`. This example demonstrates creating an HTTP GET request, setting headers, sending the request, and processing the response.

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;

public class GitCodeAPI {

    public static void main(String[] args) {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.gitcode.com/api/v5/users/:username/starred"))
                .header("Accept", "application/json")
                .GET()
                .build();

        try {
            HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
            System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}
```

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

### Get Enterprise Custom Roles API Request Examples

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-8-enterprise-enterprise-id-customized-roles

Demonstrates how to make a GET request to retrieve custom roles for an enterprise. Includes examples for various programming languages and tools, showing how to specify the enterprise ID and optional access token.

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gitcode.com/api/v8/enterprise/:enterprise_id/customized_roles");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```curl
curl --request GET \
  --url 'https://api.gitcode.com/api/v8/enterprise/:enterprise_id/customized_roles?access_token=YOUR_ACCESS_TOKEN'
  --header 'Accept: application/json'
```

```javascript
fetch('https://api.gitcode.com/api/v8/enterprise/:enterprise_id/customized_roles', {
  method: 'GET',
  headers: {
    'Accept': 'application/json'
  }
})
  .then(response => {
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json();
  })
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```python
import requests

enterprise_id = "YOUR_ENTERPRISE_ID"
access_token = "YOUR_ACCESS_TOKEN" # Optional

url = f"https://api.gitcode.com/api/v8/enterprise/{enterprise_id}/customized_roles"
params = {
    "access_token": access_token
}
headers = {
    "Accept": "application/json"
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
```

```http
GET /api/v8/enterprise/:enterprise_id/customized_roles HTTP/1.1
Host: api.gitcode.com
Accept: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
```

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

### POST /api/v5/orgs/:org/repos

Source: https://docs.gitcode.com/en/docs/apis/post-api-v-5-orgs-org-repos

Creates a new repository for a specified organization. This includes setting repository name, description, visibility, and various other configurations.

```APIDOC
## POST /api/v5/orgs/:org/repos

### Description
Creates a new repository for a specified organization. This includes setting repository name, description, visibility, and various other configurations.

### Method
POST

### Endpoint
/api/v5/orgs/:org/repos

### Parameters
#### Path Parameters
- **org** (string) - Required - Organization's path (path/login)

#### Query Parameters
- **access_token** (string) - Required - User authorization code

#### Request Body
- **name** (string) - Required - Repository name
- **description** (string) - Optional - Repository description
- **homepage** (string) - Optional - Home page URL
- **has_issues** (boolean) - Optional - Allow issues to be raised. Default: true
- **has_wiki** (boolean) - Optional - Provide Wiki or not. Default: true
- **can_comment** (boolean) - Optional - Allows users to comment on the repository. Default: true
- **public** (integer) - Optional - Repository open-source type. 0 (private), 1 (external open source), 2 (internal open source). Note: Mutually exclusive with private, takes public as the priority.
- **private** (boolean) - Optional - Repository is public or private. Default: false. Note: Mutually exclusive with public, with public taking precedence.
- **auto_init** (boolean) - Optional - When true, the repository will be initialized with a README. Default: false.
- **gitignore_template** (string) - Optional - Git Ignore Template name.
- **license_template** (string) - Optional - License template name.
- **path** (string) - Optional - Repository path.
- **default_branch** (string) - Optional - Default branch name when initializing the project. Default: main.
- **import_url** (string) - Optional - The git address of the imported project. `import_url` and `project_template` parameters can only be passed in one.
- **project_template** (string) - Optional - The path for the template project. `import_url` and `project_template` parameters can only be passed in one.
- **repository_type** (string) - Optional - Repository type. code, model, dataset, space. Default: code.

### Request Example
```json
{
  "name": "my-new-repo",
  "description": "This is a sample repository.",
  "private": false,
  "auto_init": true
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the repository.
- **name** (string) - The name of the repository.
- **full_name** (string) - The full name of the repository (organization/name).
- **private** (boolean) - Indicates if the repository is private.
- **html_url** (string) - The URL to the repository on the GitCode website.

#### Response Example
```json
{
  "id": 12345,
  "name": "my-new-repo",
  "full_name": "my-org/my-new-repo",
  "private": false,
  "html_url": "https://gitcode.com/my-org/my-new-repo"
}
```
```

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

### Get Repository Collaborators using Python

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-collaborators

This Python code snippet uses the `requests` library to fetch repository collaborators. It constructs the API URL, sends a GET request, and prints the JSON response. Ensure you have `requests` installed (`pip install requests`).

```python
import requests

def get_collaborators(owner, repo, access_token):
    url = f"https://api.gitcode.com/api/v5/repos/{owner}/{repo}/collaborators"
    params = {
        'access_token': access_token
    }
    headers = {
        'Accept': 'application/json'
    }
    
    response = requests.get(url, params=params, headers=headers)
    
    if response.status_code == 200:
        return response.json()
    else:
        print(f"Request failed with status code: {response.status_code}")
        return None

# Example usage:
# collaborators = get_collaborators('owner', 'repo', 'YOUR_ACCESS_TOKEN')
# if collaborators:
#     print(collaborators)
```

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

### Get Repository Commit Comments (HTTP Request Example)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-comments

This example shows a basic HTTP GET request to retrieve commit comments from a GitCode repository. It includes the base URL and the necessary path parameters. This format is useful for understanding the request structure and can be adapted for various HTTP clients.

```http
GET https://api.gitcode.com/api/v5/repos/:owner/:repo/comments
```

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

### Successful Repository Response Example - JSON

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-user-username-subscriptions

This is an example of a successful API response for a repository. It demonstrates the expected JSON structure and data types for various repository attributes, including owner information, timestamps, and counts.

```json
{
  "id": 777621,
  "full_name": "xiaogang/private-new2",
  "human_name": "xiaogang / private-new2",
  "url": "https://api.gitcode.com/api/v5/repos/xiaogang/private-new2",
  "namespace": {
    "id": 137117,
    "type": "user",
    "name": "xiaogang",
    "path": "xiaogang",
    "html_url": "https://gitcode.com/xiaogang"
  },
  "path": "private-new2",
  "name": "private-new2",
  "parentfull_name": "xiaogang_test/private-new",
  "description": "Trump",
  "status": "start",
  "ssh_url_to_repo": "ssh://git@gitcode.com:2222/xiaogang/private-new2.git",
  "http_url_to_repo": "https://gitcode.com/xiaogang/private-new2.git",
  "web_url": "https://gitcode.com/xiaogang/private-new2",
  "created_at": "2024-12-11T17:41:14.536+08:00",
  "updated_at": "2024-12-11T17:41:14.536+08:00",
  "homepage": "https://gitcode.com/xiaogang/private-new2",
  "members": [
    "xiaogang"
  ],
  "parent": {
    "full_name": "xiaogang_test/private-new",
    "human_name": "xiaogang_test / private-new"
  },
  "forks_count": 0,
  "stargazers_count": 1,
  "relation": "master",
  "permission": {
    "pull": true,
    "push": true,
    "admin": true
  },
  "internal": false,
  "open_issues_count": 0,
  "has_issue": false,
  "has_issues": false,
  "watchers_count": 0,
  "enterprise": {
    "id": 137117,
    "path": "xiaogang",
    "html_url": "https://gitcode.com/xiaogang",
    "type": "user"
  },
  "default_branch": "main",
  "fork": 0,
  "pushed_at": "2024-12-11T17:41:14.536+08:00",
  "owner": {
    "id": "137117",
    "login": "xiaogang",
    "name": "xiaogang",
    "type": "user"
  },
  "issue_template_source": null,
  "project_creator": "xiaogang",
  "private": 1,
  "public": 0
}
```

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

### List Repository Subscribers (Successful Example)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-subscribers

This is an example of a successful JSON response for a single user watching a repository. It includes sample data for the user's ID, login, name, avatar URL, and the specific time they started watching the repository.

```json
{
  "id": 496,
  "login": "xiaogang",
  "name": "xiaogang",
  "avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/bc/cd/6bc422546cdf276c147f267030d83a43e927fec67ca66f0b22f7e03556206fa3.jpg",
  "watch_at": "2024-11-13T16:15:53.287+08:00"
}
```

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

### Get PR Associated Issue using Python

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-pulls-number-issues

This Python script uses the `requests` library to make a GET request to the GitCode API for associated issues. It handles potential errors and prints the JSON response. Ensure you install the library (`pip install requests`) and replace the placeholder parameters.

```python
import requests

def get_associated_issues(owner, repo, number, access_token):
    url = f"https://api.gitcode.com/api/v5/repos/{owner}/{repo}/pulls/{number}/issues?access_token={access_token}"
    headers = {
        "Accept": "application/json"
    }
    
    try:
        response = requests.get(url, headers=headers)
        response.raise_for_status()  # Raise an exception for bad status codes
        print(response.json())
    except requests.exceptions.RequestException as e:
        print(f"Error fetching issues: {e}")

# Example usage:
# get_associated_issues('sytest', 'paopao', 1, 'YOUR_ACCESS_TOKEN')
```

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

### Get Organization Information - Python Requests

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-orgs-org

This Python code snippet uses the 'requests' library to fetch organization details from the GitCode API. It constructs the URL with parameters and prints the JSON response. Ensure you have the 'requests' library installed (`pip install requests`).

```python
import requests

org_name = ":org"  # Replace with the actual organization path
access_token = "YOUR_ACCESS_TOKEN"  # Replace with your access token

url = f"https://api.gitcode.com/api/v5/orgs/{org_name}"
params = {
    "access_token": access_token
}
headers = {
    "Accept": "application/json"
}

try:
    response = requests.get(url, params=params, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    organization_data = response.json()
    print(organization_data)
except requests.exceptions.RequestException as e:
    print(f"Error fetching organization data: {e}")
```

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

### Example GitCode API Issue Response (JSON)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-repos-owner-repo-issues-number

This JSON object represents an example of a successful response from the GitCode API for an issue. It demonstrates the actual data returned for fields such as ID, URL, title, state, user details, and repository information, showcasing a real-world application of the schema.

```json
{
  "id": 152212,
  "html_url": "https://test.gitcode.net/dengmengmian/test01/issues/3",
  "number": 3,
  "state": "opened",
  "title": "Inspector Gold Film",
  "body": "abcabcabc",
  "user": {
    "avatar_url": "https://gitcode-img.obs.cn-south-1.myhuaweicloud.com:443/fa/fe/f32a9fecc53e890afbd48fd098b0f6c5f20f062581400c76c85e5baab3f0d5b2.png",
    "events_url": null,
    "followers_url": null,
    "following_url": null,
    "gists_url": null,
    "html_url": "https://test.gitcode.net/dengmengmian",
    "id": "661ce4eab470b1430d456154",
    "login": "dengmengmian",
    "member_role": null,
    "name": "MaFan_",
    "organizations_url": null,
    "received_events_url": null,
    "remark": null,
    "repos_url": null,
    "starred_url": null,
    "subscriptions_url": null,
    "type": null,
    "url": null
  },
  "assignee": null,
  "repository": {
    "id": 280713,
    "full_name": "dengmengmian / test01",
    "path": "test01",
    "name": "test01",
    "description": "",
    "created_at": "2024-04-15T16:27:45.090+08:00",
    "updated_at": "2024-04-15T16:27:45.090+08:00",
    "assigner": null,
    "pushed_at": null,
    "paas": null,
    "assignees_number": null,
    "testers_number": null,
    "assignee": null,
    "testers": null
  },
  "created_at": "2024-04-15T21:58:21.188+08:00",
  "updated_at": "2024-04-15T21:58:21.188+08:00",
  "finished_at": null,
  "labels": [],
  "priority": null,
  "issue_type": null,
  "issue_state": "opened",
  "issue_state_detail": null,
  "stage": "New",
  "severity": "Major"
}
```

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

### Get Issue Extended Configuration (JavaScript)

Source: https://docs.gitcode.com/en/docs/apis/get-api-v-5-orgs-org-issue-extend-settings

This JavaScript example uses the `fetch` API to retrieve extended issue configuration from GitCode. It makes a GET request and processes the JSON response.

```javascript
fetch('https://api.gitcode.com/api/v5/orgs/:org/issue/extend/settings?access_token=YOUR_ACCESS_TOKEN', {
  method: 'GET',
  headers: {
    'Accept': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

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

### Create Repository using C# HttpClient

Source: https://docs.gitcode.com/en/docs/apis/post-api-v-5-user-repos

Demonstrates how to create a personal project repository using C#'s HttpClient. This snippet sends a POST request to the GitCode API with the necessary authentication and repository details in the JSON body. Ensure the 'access_token' is valid and repository parameters are correctly formatted.

```csharp
var client = new HttpClient();  
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.gitcode.com/api/v5/user/repos");  
request.Headers.Add("Accept", "application/json");  
var content = new StringContent("{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"has_issues\": true,\n  \"has_wiki\": true,\n  \"can_comment\": true,\n  \"auto_init\": true,\n  \"gitignore_template\": \"string\",\n  \"license_template\": \"string\",\n  \"path\": \"string\",\n  \"private\": true,\n  \"default_branch\": \"string\",\n  \"import_url\": \"string\",\n  \"project_template\": \"string\",\n  \"repository_type\": \"string\"\n}", null, "application/json");  
request.Content = content;  
var response = await client.SendAsync(request);  
response.EnsureSuccessStatusCode();  
Console.WriteLine(await response.Content.ReadAsStringAsync());  
```
Tokens:
Raw