Ресурс

Code Repository

Connect and manage code repositories from GitHub, GitLab, and other providers

Модель Code Repository

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
name
Тип
TextОбязательно
Описание
A friendly name for this code repository
Имя
slug
Тип
SlugОбязательно
Описание
Friendly globally unique name for your object
Имя
description
Тип
Long Text
Описание
A description of this code repository
Имя
repositoryHostedAt
Тип
TextОбязательно
Описание
Where is this repository hosted (GitHub, GitLab, etc.)
Имя
organizationName
Тип
TextОбязательно
Описание
GitHub organization or username that owns this repository
Имя
repositoryName
Тип
TextОбязательно
Описание
The name of the repository
Имя
mainBranchName
Тип
Text
Описание
The name of the main/default branch
Имя
repositoryUrl
Тип
URL
Описание
The HTTPS URL to the repository
Имя
gitHubAppInstallationId
Тип
Long Text
Описание
The GitHub App installation ID used to authenticate with this repository
Имя
gitLabProjectId
Тип
Long Text
Описание
The GitLab project ID for this repository
Имя
secretToken
Тип
Very Long Text
Описание
Secret token used to verify incoming webhooks
Имя
createdByUser
Тип
User
Описание
Relation to User who created this object (if this object was created by a User)
Имя
createdByUserId
Тип
Object ID
Описание
User ID who created this object (if this object was created by a User)
Имя
labels
Тип
Label
Описание
Relation to Labels Array where this object is categorized in.

GETorPOST/api/code-repository/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Code Repository». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать Code Repository, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/code-repository/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "organizationName": true,
    "projectId": true,
    "repositoryHostedAt": true,
    "repositoryName": true
  },
  "query": {
    "name": "My Backend API"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376d9a10-28fe-11f1-b591-3fdcef396aba",
      "name": "My Backend API",
      "organizationName": "my-organization",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "repositoryHostedAt": "GitHub",
      "repositoryName": "my-backend-api"
    },
    {
      "_id": "376d9a11-28fe-11f1-b591-3fdcef396aba",
      "name": "My Backend API",
      "organizationName": "my-organization",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "repositoryHostedAt": "GitHub",
      "repositoryName": "my-backend-api"
    },
    {
      "_id": "376d9a12-28fe-11f1-b591-3fdcef396aba",
      "name": "My Backend API",
      "organizationName": "my-organization",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "repositoryHostedAt": "GitHub",
      "repositoryName": "my-backend-api"
    }
  ]
}

GETorPOST/api/code-repository/:id/get-item

Получить по ID

Возвращает объект «Code Repository» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/code-repository/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "organizationName": true,
    "projectId": true,
    "repositoryHostedAt": true,
    "repositoryName": true
  }
}

Ответ

{
  "_id": "376d9a10-28fe-11f1-b591-3fdcef396aba",
  "name": "My Backend API",
  "organizationName": "my-organization",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "repositoryHostedAt": "GitHub",
  "repositoryName": "my-backend-api"
}

POST/api/code-repository/count

Количество

Возвращает количество ваших объектов «Code Repository».

Необязательное тело запроса

query
Чтобы фильтровать Code Repository, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/code-repository/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "My Backend API"
  }
}

Ответ

{
  "count": 107
}

POST/api/code-repository

Создать Code Repository

Создаёт новый объект.

Запрос создания

POST

/api/code-repository

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "My Backend API",
    "organizationName": "my-organization",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "repositoryHostedAt": "GitHub",
    "repositoryName": "my-backend-api"
  }
}

Ответ

{
  "_id": "376d9a10-28fe-11f1-b591-3fdcef396aba",
  "name": "My Backend API",
  "organizationName": "my-organization",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "repositoryHostedAt": "GitHub",
  "repositoryName": "my-backend-api"
}

PUT/api/code-repository/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/code-repository/:id/update-item

GET/api/code-repository/:id/update-item

Запрос обновления

PUT

/api/code-repository/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "My Backend API",
    "description": "Main backend API service for user authentication and data access",
    "mainBranchName": "main"
  }
}

Ответ

{}

DELETE/api/code-repository/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/code-repository/:id/delete-item

GET/api/code-repository/:id/delete-item

Запрос удаления

DELETE

/api/code-repository/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Code Repository

Project Owner
Project Admin
Project Member
Read Code Repository
Read All Project Resources

Права на создание

Нужны для создания Code Repository

Project Owner
Project Admin
Project Member
Create Code Repository

Права на обновление

Нужны для обновления Code Repository

Project Owner
Project Admin
Project Member
Edit Code Repository

Права на удаление

Нужны для удаления Code Repository

Project Owner
Project Admin
Delete Code Repository