Documentación

Historia y flujos de trabajo

Confirmaciones, bifurcaciones, restauraciones, revisiones, duplicación de GitHub y distribución de flujo de trabajo compatibles con Project Git.

Traducido automáticamente del inglés. Ver el original en inglés

Área de pruebas

Envíe estas solicitudes a su propio sidecar en funcionamiento. Los valores permanecen en este navegador.

No conectado

URL base ficha al portador opcional token de sesión opcional

¿Cómo funciona esto?

El sidecar escucha en un puerto loopback elegido al inicio y lo imprime en su ready línea; use esa URL y el CADCAMFUN_TOKEN se empezó con. Las solicitudes van directamente desde esta página a esa dirección.

El sidecar envía encabezados CORS solo a los orígenes Tauri y a http://localhost o http://127.0.0.1 en cualquier puerto. Desde los documentos alojados, el navegador bloquea la respuesta, así que ejecute los documentos localmente (bun run dev en packages/web) para usar el área de juegos o copiar la solicitud como curl. Para experimentar sin tocar datos reales, inicie el sidecar con CADCAMFUN_DATA_DIR apuntado a un directorio desechable - ver el tutorial de la API.

Operaciones

22 endpoints en el vcs grupo, generado a partir del propio sidecar Documento OpenAPI. Las operaciones protegidas toman Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticación. El comportamiento y los límites están en la guía del subsistema.

conseguir	/api/projects/{id}/vcs/status	vcs.status
conseguir	/api/projects/{id}/vcs/log	vcs.log
correo	/api/projects/{id}/vcs/commit	vcs.commit
conseguir	/api/projects/{id}/vcs/branches	vcs.branches
correo	/api/projects/{id}/vcs/branches	vcs.createBranch
correo	/api/projects/{id}/vcs/checkout	vcs.checkout
correo	/api/projects/{id}/vcs/restore	vcs.restore
conseguir	/api/projects/{id}/vcs/diff	vcs.diff
conseguir	/api/projects/{id}/pulls	vcs.listPullRequests
correo	/api/projects/{id}/pulls	vcs.openPullRequest
conseguir	/api/projects/{id}/pulls/{number}	vcs.pullRequest
correo	/api/projects/{id}/pulls/{number}/reviews	vcs.review
correo	/api/projects/{id}/pulls/{number}/merge	vcs.mergePullRequest
correo	/api/projects/{id}/pulls/{number}/close	vcs.closePullRequest
conseguir	/api/projects/{id}/vcs/remote	vcs.remote
poner	/api/projects/{id}/vcs/remote	vcs.setRemote
correo	/api/projects/{id}/vcs/push	vcs.push
correo	/api/projects/{id}/vcs/pull	vcs.pull
conseguir	/api/projects/{id}/actions/runs	vcs.runs
correo	/api/projects/{id}/actions/dispatch	vcs.dispatch
conseguir	/api/projects/{id}/actions/workflows	vcs.listWorkflows
conseguir	/api/projects/{id}/actions/workflows/{name}	vcs.workflow

Operaciones de historial y flujos de trabajo en 3D Arrastrar para orbitar · desplazarse para hacer zoom · arrastrar con el botón derecho para desplazarse

Un bloque por operación (22), apilado por sección de recursos de esta página y coloreado por método: GET verde, POST naranja, PUT azul, PATCH violeta, DELETE rojo. Generado a partir del documento OpenAPI en el momento de la compilación.

/api/projects

conseguir /api/projects/{id}/vcs/status # vcs.status

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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

OBTENER /api/projects/{id}/vcs/status

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

Pruébalo

identificación camino · requerido

conseguir /api/projects/{id}/vcs/log # vcs.log

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
rdo	consulta	cadena \| null	opcional
límite	consulta	cadena \| null	opcional
camino	consulta	cadena \| null	opcional

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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

OBTENER /api/projects/{id}/vcs/log

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

Pruébalo

identificación camino · requerido rdo consulta límite consulta camino consulta

correo /api/projects/{id}/vcs/commit # vcs.commit

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

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

Respuestas

201 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

conseguir /api/projects/{id}/vcs/branches # vcs.branches

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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

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

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

Pruébalo

identificación camino · requerido

correo /api/projects/{id}/vcs/branches # vcs.createBranch

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  name: string
  from?: string | null
}

Respuestas

201 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

correo /api/projects/{id}/vcs/checkout # vcs.checkout

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  branch: string
}

Respuestas

200 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

correo /api/projects/{id}/vcs/restore # vcs.restore

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

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

Respuestas

200 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

conseguir /api/projects/{id}/vcs/diff # vcs.diff

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
de	consulta	cadena \| null	opcional
a	consulta	cadena	requerido

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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

OBTENER /api/projects/{id}/vcs/diff

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

Pruébalo

identificación camino · requerido de consulta a consulta · requerido

conseguir /api/projects/{id}/pulls # vcs.listPullRequests

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
estado	consulta	"abierto" \| "fusionado" \| "cerrado" \| null	opcional

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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

OBTENER /api/projects/{id}/pulls

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

Pruébalo

identificación camino · requerido estado consulta

correo /api/projects/{id}/pulls # vcs.openPullRequest

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

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

Respuestas

201 objeto 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

Ejemplo de 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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

conseguir /api/projects/{id}/pulls/{number} # vcs.pullRequest

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
número	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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}"

Pruébalo

identificación camino · requerido número camino · requerido

correo /api/projects/{id}/pulls/{number}/reviews # vcs.review

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
número	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

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

Respuestas

201 objeto 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

Ejemplo de 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

Pruébalo

identificación camino · requerido número camino · requerido

Cuerpo de la solicitud application/json

correo /api/projects/{id}/pulls/{number}/merge # vcs.mergePullRequest

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
número	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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}"

Pruébalo

identificación camino · requerido número camino · requerido

correo /api/projects/{id}/pulls/{number}/close # vcs.closePullRequest

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
número	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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}"

Pruébalo

identificación camino · requerido número camino · requerido

conseguir /api/projects/{id}/vcs/remote # vcs.remote

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 objeto 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

Ejemplo de 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

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

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

Pruébalo

identificación camino · requerido

poner /api/projects/{id}/vcs/remote # vcs.setRemote

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  remote: string | null
}

Respuestas

200 objeto 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

Ejemplo de 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/remoto

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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

correo /api/projects/{id}/vcs/push # vcs.push

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
token-x-github	encabezamiento	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  branch?: string | null
}

Respuestas

200 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido token-x-github encabezado · requerido

Cuerpo de la solicitud application/json

correo /api/projects/{id}/vcs/pull # vcs.pull

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
token-x-github	encabezamiento	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  branch?: string | null
}

Respuestas

200 objeto 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

Ejemplo de 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

ENVIAR /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

Pruébalo

identificación camino · requerido token-x-github encabezado · requerido

Cuerpo de la solicitud application/json

conseguir /api/projects/{id}/actions/runs # vcs.runs

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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

OBTENER /api/projects/{id}/actions/runs

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

Pruébalo

identificación camino · requerido

correo /api/projects/{id}/actions/dispatch # vcs.dispatch

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido

Cuerpo de la solicitud · requerido · aplicación/json

{
  ref?: string | null
}

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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}/acciones/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

Pruébalo

identificación camino · requerido

Cuerpo de la solicitud application/json

conseguir /api/projects/{id}/actions/workflows # vcs.listWorkflows

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
árbitro	consulta	cadena \| null	opcional

Respuestas

200 Matriz<objeto> 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

Ejemplo de 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

OBTENER /api/projects/{id}/acciones/flujos de trabajo

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

Pruébalo

identificación camino · requerido árbitro consulta

conseguir /api/projects/{id}/actions/workflows/{name} # vcs.workflow

Requiere Authorization: Bearer <token>.

Parámetros

Nombre	En	Tipo	Requerido
identificación	camino	cadena	requerido
nombre	camino	cadena	requerido
árbitro	consulta	cadena \| null	opcional

Respuestas

200 objeto 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

Ejemplo de 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}"

Pruébalo

identificación camino · requerido nombre camino · requerido árbitro consulta

esquemas

Esquemas con nombre accesibles desde los parámetros, cuerpos y respuestas de este grupo. A ? marca un campo opcional; | null marca un campo que puede estar presente con un valor nulo.

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
}

Llamando a este grupo

Los identificadores de operación tienen la forma vcs.<name>. El SDK de promesa generado (@cadcamfun/api/sdk) expone la mayoría de ellos como client.<namespace>.<method>(input), dónde input es un objeto plano de parámetros de ruta y campos de cuerpo; El ejemplo de SDK de cada tarjeta muestra el acceso exacto y el tipo de entrada. No se generan cargas de varias partes, respuestas binarias o JavaScript ni webhooks sin formato; esas tarjetas muestran fetch en su lugar.

Errores del SDK de Promise

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
  }
}

Solución de problemas

Síntoma	causa probable	Arreglar
401 en cada llamada	Token de un lanzamiento anterior o faltante `Bearer` prefijo	Enviar `Authorization: Bearer <token>` con la ficha con la que se inició el sidecar.
400 antes de que ocurra algo	El cuerpo o el parámetro no coincide con el esquema	Compare la carga útil con el esquema de solicitud en la tarjeta.
403 o 404 en un registro que puedes ver en otro sitio	La cuenta de actuación difiere.	enviar la derecha `x-session-token`o utilice el perfil local propietario del registro.
409	Estado conflictivo, como un nombre duplicado o un encabezado de sucursal obsoleto	Vuelva a leer el recurso y vuelva a intentarlo con los datos actuales.
Pruébelo, dice "bloqueado por CORS"	Los documentos se entregan desde un origen sin bucle invertido.	Ejecute los documentos localmente o copie la solicitud como curl.
Conexión rechazada	El sidecar se reinició en un nuevo puerto.	Leer el puerto del nuevo `ready` línea.