Документация

История и рабочие процессы

Совместимые с Git проекта коммиты, ветки, восстановления, проверки, зеркалирование GitHub и диспетчеризация рабочих процессов.

Автоматически переведено с английского. Смотреть оригинал на английском

Песочница

Отправьте эти запросы на свою работающую сайдкар. Значения остаются в этом браузере.

Не подключено

Базовый URL Токен на предъявителя необязательный Токен сеанса необязательный

Как это работает

Сайдкар прослушивает порт обратной связи, выбранный при запуске, и печатает его в своем ready линия; используйте этот URL-адрес и CADCAMFUN_TOKEN с этого началось. Запросы идут прямо с этой страницы на этот адрес.

Sidecar отправляет заголовки CORS только источникам Tauri и http://localhost или http://127.0.0.1 в любом порту. Из размещенных документов браузер блокирует ответ, поэтому запускайте документы локально (bun run dev в packages/web), чтобы использовать игровую площадку, или скопируйте запрос как завиток. Чтобы поэкспериментировать, не затрагивая реальные данные, запустите сайдкар с помощью CADCAMFUN_DATA_DIR указал на одноразовый каталог — см. пошаговое руководство по API.

Операции

22 endpoint в vcs группа, созданная на основе собственной сайдкара документ OpenAPI. Защищенные операции занимают Authorization: Bearer $CADCAMFUN_TOKEN; видеть аутентификация. Поведение и ограничения находятся в руководство по подсистеме.

получать	/api/projects/{id}/vcs/status	vcs.status
получать	/api/projects/{id}/vcs/log	vcs.log
почта	/api/projects/{id}/vcs/commit	vcs.commit
получать	/api/projects/{id}/vcs/branches	vcs.branches
почта	/api/projects/{id}/vcs/branches	vcs.createBranch
почта	/api/projects/{id}/vcs/checkout	vcs.checkout
почта	/api/projects/{id}/vcs/restore	vcs.restore
получать	/api/projects/{id}/vcs/diff	vcs.diff
получать	/api/projects/{id}/pulls	vcs.listPullRequests
почта	/api/projects/{id}/pulls	vcs.openPullRequest
получать	/api/projects/{id}/pulls/{number}	vcs.pullRequest
почта	/api/projects/{id}/pulls/{number}/reviews	vcs.review
почта	/api/projects/{id}/pulls/{number}/merge	vcs.mergePullRequest
почта	/api/projects/{id}/pulls/{number}/close	vcs.closePullRequest
получать	/api/projects/{id}/vcs/remote	vcs.remote
помещать	/api/projects/{id}/vcs/remote	vcs.setRemote
почта	/api/projects/{id}/vcs/push	vcs.push
почта	/api/projects/{id}/vcs/pull	vcs.pull
получать	/api/projects/{id}/actions/runs	vcs.runs
почта	/api/projects/{id}/actions/dispatch	vcs.dispatch
получать	/api/projects/{id}/actions/workflows	vcs.listWorkflows
получать	/api/projects/{id}/actions/workflows/{name}	vcs.workflow

История и рабочие процессы в 3D Перетащите на орбиту · прокрутите, чтобы увеличить · перетащите вправо, чтобы панорамировать

Один блок на операцию (22), сгруппированный в каждом разделе ресурсов на этой странице и окрашенный в зависимости от метода: зеленый GET, оранжевый POST, синий PUT, фиолетовый PATCH, красный DELETE. Создается из документа OpenAPI во время сборки.

/api/projects

получать /api/projects/{id}/vcs/status # vcs.status

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 объект application/json

{
  branch: string
  head: string | null
  dirty: string[]
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.status

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsStatusInput
const result = await client.vcs.status({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/vcs/status

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/vcs/status" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

получать /api/projects/{id}/vcs/log # vcs.log

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
оборот	запрос	нить \| null	необязательный
предел	запрос	нить \| null	необязательный
путь	запрос	нить \| null	необязательный

Ответы

200 Массив<объект> application/json

Array<{
  oid: string
  parents: string[]
  message: string
  author: {
    name: string
    email: string
    time: number | "Infinity" | "-Infinity" | "NaN"
  }
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.log

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsLogInput
const result = await client.vcs.log({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/vcs/log

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/vcs/log" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется оборот запрос предел запрос путь запрос

почта /api/projects/{id}/vcs/commit # vcs.commit

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  message: string
  authorKind?: "user" | "ai" | null
  files?: {
    [key: string]: string
  } | null
}

Ответы

201 объект application/json

{
  oid: string
  parents: string[]
  message: string
  author: {
    name: string
    email: string
    time: number | "Infinity" | "-Infinity" | "NaN"
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.commit

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsCommitInput
const result = await client.vcs.commit({
  id: "<id>",
  message: "",
  authorKind: "user",
  files: {}
})

curl

POST /api/projects/{id}/vcs/commit

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/commit" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

получать /api/projects/{id}/vcs/branches # vcs.branches

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 объект application/json

{
  current: string
  branches: {
    [key: string]: string
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.branches

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsBranchesInput
const result = await client.vcs.branches({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/vcs/branches

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/vcs/branches" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

почта /api/projects/{id}/vcs/branches # vcs.createBranch

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  name: string
  from?: string | null
}

Ответы

201 объект application/json

{
  current: string
  branches: {
    [key: string]: string
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.createBranch

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsCreateBranchInput
const result = await client.vcs.createBranch({
  id: "<id>",
  name: "",
  from: ""
})

curl

POST /api/projects/{id}/vcs/branches

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/branches" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

почта /api/projects/{id}/vcs/checkout # vcs.checkout

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  branch: string
}

Ответы

200 объект application/json

{
  branch: string
  head: string | null
  dirty: string[]
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.checkout

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsCheckoutInput
const result = await client.vcs.checkout({
  id: "<id>",
  branch: ""
})

curl

POST /api/projects/{id}/vcs/checkout

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/checkout" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

почта /api/projects/{id}/vcs/restore # vcs.restore

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  rev: string
  paths?: string[] | null
}

Ответы

200 объект application/json

{
  oid: string
  parents: string[]
  message: string
  author: {
    name: string
    email: string
    time: number | "Infinity" | "-Infinity" | "NaN"
  }
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.restore

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsRestoreInput
const result = await client.vcs.restore({
  id: "<id>",
  rev: "",
  paths: [
    ""
  ]
})

curl

POST /api/projects/{id}/vcs/restore

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/restore" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

получать /api/projects/{id}/vcs/diff # vcs.diff

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
от	запрос	нить \| null	необязательный
до	запрос	нить	необходимый

Ответы

200 Массив<объект> application/json

Array<{
  path: string
  kind: "drawings" | "components" | "toolpaths" | "materials" | "tools" | "machine-configs" | "costs" | "project" | "other"
  id?: string | null
  name?: string | null
  status: "added" | "modified" | "deleted"
  changes: Array<{
    pointer: string
    before?: unknown | null
    after?: unknown | null
  }>
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.diff

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsDiffInput
const result = await client.vcs.diff({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/vcs/diff

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/vcs/diff?to=<to>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется от запрос до запрос · требуется

получать /api/projects/{id}/pulls # vcs.listPullRequests

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
состояние	запрос	"открыть" \| "слился" \| "закрыто" \| null	необязательный

Ответы

200 Массив<объект> application/json

Array<{
  id: string
  projectId: string
  number: number | "Infinity" | "-Infinity" | "NaN"
  title: string
  body: string
  head: string
  base: string
  state: "open" | "merged" | "closed"
  authorId: string
  authorKind: "user" | "ai"
  mergeCommit: string | null
  remoteNumber: number | "Infinity" | "-Infinity" | "NaN" | null
  createdAt: string
  updatedAt: string
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.listPullRequests

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsListPullRequestsInput
const result = await client.vcs.listPullRequests({
  id: "<id>"
})

curl

ПОЛУЧИТЬ /api/projects/{id}/pulls

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/pulls" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется состояние запрос

почта /api/projects/{id}/pulls # vcs.openPullRequest

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  title: string
  body?: string | null
  head: string
  base?: string | null
  authorKind?: "user" | "ai" | null
}

Ответы

201 объект application/json

{
  id: string
  projectId: string
  number: number | "Infinity" | "-Infinity" | "NaN"
  title: string
  body: string
  head: string
  base: string
  state: "open" | "merged" | "closed"
  authorId: string
  authorKind: "user" | "ai"
  mergeCommit: string | null
  remoteNumber: number | "Infinity" | "-Infinity" | "NaN" | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.openPullRequest

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsOpenPullRequestInput
const result = await client.vcs.openPullRequest({
  id: "<id>",
  title: "",
  body: "",
  head: "",
  base: "",
  authorKind: "user"
})

curl

POST /api/projects/{id}/pulls

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/pulls" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

получать /api/projects/{id}/pulls/{number} # vcs.pullRequest

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
число	путь	нить	необходимый

Ответы

200 объект application/json

{
  pullRequest: {
    id: string
    projectId: string
    number: number | "Infinity" | "-Infinity" | "NaN"
    title: string
    body: string
    head: string
    base: string
    state: "open" | "merged" | "closed"
    authorId: string
    authorKind: "user" | "ai"
    mergeCommit: string | null
    remoteNumber: number | "Infinity" | "-Infinity" | "NaN" | null
    createdAt: string
    updatedAt: string
  }
  reviews: Array<{
    id: string
    pullRequestId: string
    reviewerId: string
    verdict: "comment" | "approve" | "request-changes"
    body: string
    path: string | null
    pointer: string | null
    createdAt: string
  }>
  changes: Array<{
    path: string
    kind: "drawings" | "components" | "toolpaths" | "materials" | "tools" | "machine-configs" | "costs" | "project" | "other"
    id?: string | null
    name?: string | null
    status: "added" | "modified" | "deleted"
    changes: Array<{
      pointer: string
      before?: unknown | null
      after?: unknown | null
    }>
  }>
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.pullRequest

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsPullRequestInput
const result = await client.vcs.pullRequest({
  id: "<id>",
  number: "<number>"
})

curl

GET /api/projects/{id}/pulls/{number}

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/pulls/<number>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется число путь · требуется

почта /api/projects/{id}/pulls/{number}/reviews # vcs.review

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
число	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  verdict: "comment" | "approve" | "request-changes"
  body?: string | null
  path?: string | null
  pointer?: string | null
}

Ответы

201 объект application/json

{
  id: string
  pullRequestId: string
  reviewerId: string
  verdict: "comment" | "approve" | "request-changes"
  body: string
  path: string | null
  pointer: string | null
  createdAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.review

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsReviewInput
const result = await client.vcs.review({
  id: "<id>",
  number: "<number>",
  verdict: "comment",
  body: "",
  path: "",
  pointer: ""
})

curl

POST /api/projects/{id}/pulls/{number}/reviews

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/pulls/<number>/reviews" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется число путь · требуется

Тело запроса application/json

почта /api/projects/{id}/pulls/{number}/merge # vcs.mergePullRequest

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
число	путь	нить	необходимый

Ответы

200 объект application/json

{
  id: string
  projectId: string
  number: number | "Infinity" | "-Infinity" | "NaN"
  title: string
  body: string
  head: string
  base: string
  state: "open" | "merged" | "closed"
  authorId: string
  authorKind: "user" | "ai"
  mergeCommit: string | null
  remoteNumber: number | "Infinity" | "-Infinity" | "NaN" | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.mergePullRequest

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsMergePullRequestInput
const result = await client.vcs.mergePullRequest({
  id: "<id>",
  number: "<number>"
})

curl

POST /api/projects/{id}/pulls/{number}/merge

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/pulls/<number>/merge" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется число путь · требуется

почта /api/projects/{id}/pulls/{number}/close # vcs.closePullRequest

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
число	путь	нить	необходимый

Ответы

200 объект application/json

{
  id: string
  projectId: string
  number: number | "Infinity" | "-Infinity" | "NaN"
  title: string
  body: string
  head: string
  base: string
  state: "open" | "merged" | "closed"
  authorId: string
  authorKind: "user" | "ai"
  mergeCommit: string | null
  remoteNumber: number | "Infinity" | "-Infinity" | "NaN" | null
  createdAt: string
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.closePullRequest

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsClosePullRequestInput
const result = await client.vcs.closePullRequest({
  id: "<id>",
  number: "<number>"
})

curl

POST /api/projects/{id}/pulls/{number}/close

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/pulls/<number>/close" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется число путь · требуется

получать /api/projects/{id}/vcs/remote # vcs.remote

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 объект application/json

{
  remote: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.remote

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsRemoteInput
const result = await client.vcs.remote({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/vcs/remote

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/vcs/remote" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

помещать /api/projects/{id}/vcs/remote # vcs.setRemote

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  remote: string | null
}

Ответы

200 объект application/json

{
  remote: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.setRemote

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsSetRemoteInput
const result = await client.vcs.setRemote({
  id: "<id>",
  remote: ""
})

curl

PUT /api/projects/{id}/vcs/remote

curl --request PUT "${CADCAMFUN_URL}/api/projects/<id>/vcs/remote" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

почта /api/projects/{id}/vcs/push # vcs.push

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
x-github-токен	заголовок	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  branch?: string | null
}

Ответы

200 объект application/json

{
  oid: string
  objects: number | "Infinity" | "-Infinity" | "NaN"
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.push

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsPushInput
const result = await client.vcs.push({
  id: "<id>",
  branch: ""
})

curl

POST /api/projects/{id}/vcs/push

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/push" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется x-github-токен заголовок · обязателен

Тело запроса application/json

почта /api/projects/{id}/vcs/pull # vcs.pull

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
x-github-токен	заголовок	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  branch?: string | null
}

Ответы

200 объект application/json

{
  kind: string
  oid: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.pull

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsPullInput
const result = await client.vcs.pull({
  id: "<id>",
  branch: ""
})

curl

POST /api/projects/{id}/vcs/pull

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/vcs/pull" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется x-github-токен заголовок · обязателен

Тело запроса application/json

получать /api/projects/{id}/actions/runs # vcs.runs

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Ответы

200 Массив<объект> application/json

Array<{
  id: string
  projectId: string
  workflow: string
  event: "push" | "pull-request" | "manual"
  ref: string
  sha: string
  status: "queued" | "running" | "success" | "failure"
  events: unknown[]
  startedAt: string
  finishedAt: string | null
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.runs

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsRunsInput
const result = await client.vcs.runs({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/actions/runs

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/actions/runs" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется

почта /api/projects/{id}/actions/dispatch # vcs.dispatch

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый

Тело запроса · обязательно · приложение/json

{
  ref?: string | null
}

Ответы

200 Массив<объект> application/json

Array<{
  id: string
  projectId: string
  workflow: string
  event: "push" | "pull-request" | "manual"
  ref: string
  sha: string
  status: "queued" | "running" | "success" | "failure"
  events: unknown[]
  startedAt: string
  finishedAt: string | null
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.dispatch

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsDispatchInput
const result = await client.vcs.dispatch({
  id: "<id>",
  ref: ""
})

curl

POST/api/projects/{id}/actions/dispatch

curl --request POST "${CADCAMFUN_URL}/api/projects/<id>/actions/dispatch" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

Попробуйте это

идентификатор путь · требуется

Тело запроса application/json

получать /api/projects/{id}/actions/workflows # vcs.listWorkflows

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
ссылка	запрос	нить \| null	необязательный

Ответы

200 Массив<объект> application/json

Array<{
  name: string
  path: string
  content: string
  problem?: string | null
}>

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.listWorkflows

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsListWorkflowsInput
const result = await client.vcs.listWorkflows({
  id: "<id>"
})

curl

ПОЛУЧИТЕ /api/projects/{id}/actions/workflows

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/actions/workflows" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется ссылка запрос

получать /api/projects/{id}/actions/workflows/{name} # vcs.workflow

Требует Authorization: Bearer <token>.

Параметры

Имя	В	Тип	Необходимый
идентификатор	путь	нить	необходимый
имя	путь	нить	необходимый
ссылка	запрос	нить \| null	необязательный

Ответы

200 объект application/json

{
  name: string
  path: string
  content: string
  problem?: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

409 ConflictEncoded application/json

ConflictEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Пример SDK

vcs.workflow

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// VcsWorkflowInput
const result = await client.vcs.workflow({
  id: "<id>",
  name: "<name>"
})

curl

GET /api/projects/{id}/actions/workflows/{name}

curl --request GET "${CADCAMFUN_URL}/api/projects/<id>/actions/workflows/<name>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Попробуйте это

идентификатор путь · требуется имя путь · требуется ссылка запрос

Схемы

Именованные схемы, доступные из параметров, тел и ответов этой группы. А ? отмечает необязательное поле; | null отмечает поле, которое может иметь нулевое значение.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ConflictEncoded

{
  _tag: "Conflict"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Звонок в эту группу

Идентификаторы операций имеют вид vcs.<name>. Сгенерированный Promise SDK (@cadcamfun/api/sdk) выставляет большинство из них как client.<namespace>.<method>(input), где input представляет собой один плоский объект параметров пути и полей тела; В примере SDK каждой карты показаны точный метод доступа и тип ввода. Многочастные загрузки, двоичные ответы или ответы JavaScript, а также необработанные веб-перехватчики не генерируются; эти карты показывают fetch вместо этого.

Ошибки Promise SDK

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

Поиск неисправностей

Симптом	Вероятная причина	Исправить
401 на каждый вызов	Токен от предыдущего запуска или отсутствует `Bearer` префикс	Отправлять `Authorization: Bearer <token>` с жетоном, с которого была запущена сайдкар.
400 до того как что-либо произойдёт	Тело или параметр не соответствует схеме	Сравните полезную нагрузку со схемой запроса на карте.
403 или 404 у записи, которую видно в другом месте	Действующий счет отличается	Отправить право `x-session-token`или используйте локальный профиль, которому принадлежит запись.
409	Конфликтующее состояние, например повторяющееся имя или устаревший заголовок ветки.	Перечитайте ресурс и повторите попытку с текущими данными.
Попробуйте, написано «заблокировано CORS».	Документы подаются из источника без обратной связи.	Запустите документы локально или скопируйте запрос как curl.
В соединении отказано	Сайдкар перезапустилась в новом порту	Прочтите порт из нового `ready` строка.