Status200
Ресурс

Service Code Repository

Link code repositories to service items with the path where the service code lives.

Модель Service 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

  • Имя
    service
    Тип
    Service
    Описание

    Relation to Service Resource in which this object belongs

  • Имя
    serviceId
    Тип
    Object IDОбязательно
    Описание

    ID of your Service in which this object belongs

  • Имя
    codeRepository
    Тип
    Code Repository
    Описание

    Relation to Code Repository in which this object belongs

  • Имя
    codeRepositoryId
    Тип
    Object IDОбязательно
    Описание

    ID of your Code Repository in which this object belongs

  • Имя
    servicePathInRepository
    Тип
    Long Text
    Описание

    The path in the repository where the service code lives (e.g., /services/api or /src/backend)

  • Имя
    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)

  • Имя
    enableAutomaticImprovements
    Тип
    Boolean
    Описание

    Enable to automatically create pull requests to improve the code for this service.

  • Имя
    maxOpenPullRequests
    Тип
    Number
    Описание

    Maximum number of open pull requests that can create for this service at any given time.

  • Имя
    restrictedImprovementActions
    Тип
    JSON
    Описание

    Restrict code improvements to only these actions. If empty, all improvement actions are allowed.

GETorPOST/api/service-code-repository/get-list

Список

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

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

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

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

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

POST
/api/service-code-repository/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "codeRepositoryId": true,
    "projectId": true,
    "serviceId": true,
    "codeRepository": true,
    "createdByUser": true
  },
  "query": {
    "servicePathInRepository": "/services/api"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377ab970-28fe-11f1-b591-3fdcef396aba",
      "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
      "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    },
    {
      "_id": "377ab971-28fe-11f1-b591-3fdcef396aba",
      "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
      "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    },
    {
      "_id": "377ab972-28fe-11f1-b591-3fdcef396aba",
      "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
      "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
      "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
    }
  ]
}
GETorPOST/api/service-code-repository/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/service-code-repository/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "codeRepositoryId": true,
    "projectId": true,
    "serviceId": true,
    "codeRepository": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "377ab970-28fe-11f1-b591-3fdcef396aba",
  "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
  "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
  "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
}
POST/api/service-code-repository/count

Количество

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

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

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

POST
/api/service-code-repository/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "servicePathInRepository": "/services/api"
  }
}

Ответ

{
  "count": 107
}
POST/api/service-code-repository

Создать Service Code Repository

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

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

POST
/api/service-code-repository
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
    "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
    "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
  }
}

Ответ

{
  "_id": "377ab970-28fe-11f1-b591-3fdcef396aba",
  "codeRepositoryId": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "serviceId": "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
  "codeRepository": "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
  "createdByUser": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012"
}
PUT/api/service-code-repository/:id

Обновить по ID

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

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

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

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

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

PUT
/api/service-code-repository/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "servicePathInRepository": "/services/api",
    "enableAutomaticImprovements": true,
    "maxOpenPullRequests": 100
  }
}

Ответ

{}
DELETE/api/service-code-repository/:id

Удалить по ID

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

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

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

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

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

DELETE
/api/service-code-repository/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Service Code Repository

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Service Code Repository

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Service Code Repository