Documentação

Eventos do projeto

Eventos enviados pelo servidor no escopo do projeto para clientes ativos.

Traduzido automaticamente do inglês. Ver o original em inglês

Área de testes

Envie essas solicitações para seu próprio sidecar em execução. Os valores permanecem neste navegador.

Não conectado

URL base Token do portador opcional Token de sessão opcional

Como isso funciona

O sidecar escuta em uma porta de loopback escolhida na inicialização e a imprime em seu ready linha; use esse URL e o CADCAMFUN_TOKEN foi iniciado. As solicitações vão direto desta página para esse endereço.

O sidecar envia cabeçalhos CORS apenas para as origens Tauri e para http://localhost ou http://127.0.0.1 em qualquer porto. Nos documentos hospedados, o navegador bloqueia a resposta, então execute os documentos localmente (bun run dev em packages/web) para usar o playground ou copie a solicitação como curl. Para experimentar sem tocar em dados reais, inicie o sidecar com CADCAMFUN_DATA_DIR apontado para um diretório descartável - veja o passo a passo da API.

Operações

2 endpoints no events grupo, gerado a partir do próprio sidecar Documento OpenAPI. As operações protegidas levam Authorization: Bearer $CADCAMFUN_TOKEN; ver autenticação. Comportamento e limites estão em o guia do subsistema.

pegar	/api/projects/{id}/events	events.subscribe
pegar	/api/events	events.subscribeAll

Operações de eventos do projeto em 3D Arraste para orbitar · role para ampliar · arraste com o botão direito para deslocar

Um bloco por operação (2), empilhado por seção de recursos desta página e colorido por método: verde GET, laranja POST, azul PUT, violeta PATCH, vermelho DELETE. Gerado a partir do documento OpenAPI em tempo de construção.

/api/projects

pegar /api/projects/{id}/events # events.subscribe

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
eu ia	caminho	corda	obrigatório

Respostas

200 objeto text/event-stream

{
  id: string | null
  event: string
  data: string
}

401 Não autorizadoEncoded | Não autorizadoEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

events.subscribe

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

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

// EventsSubscribeInput
const result = await client.events.subscribe({
  id: "<id>"
})

curl

GET /api/projects/{id}/events

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

Experimente

eu ia caminho · obrigatório

/api/events

pegar /api/events # events.subscribeAll

Requer Authorization: Bearer <token>.

Respostas

200 objeto text/event-stream

{
  id: string | null
  event: string
  data: string
}

401 Não autorizadoEncoded | Não autorizadoEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

buscar exemplo

events.subscribeAll

// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/events`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

curl

GET /api/eventos

curl --request GET "${CADCAMFUN_URL}/api/events" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

Esquemas

Esquemas nomeados acessíveis a partir dos parâmetros, corpos e respostas deste grupo. UM ? marca um campo opcional; | null marca um campo que pode estar presente com um valor nulo.

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

Chamando este grupo

Os IDs de operação têm o formato events.<name>. O Promise SDK gerado (@cadcamfun/api/sdk) expõe a maioria deles como client.<namespace>.<method>(input), onde input é um objeto plano de parâmetros de caminho e campos de corpo; o exemplo do SDK de cada cartão mostra o acessador e o tipo de entrada exatos. Multipart uploads, respostas binárias ou JavaScript e webhooks brutos não são gerados; essas cartas mostram fetch em vez disso.

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

Solução de problemas

Sintoma	Causa provável	Consertar
401 em cada chamada	Token de um lançamento anterior ou ausente `Bearer` prefixo	Enviar `Authorization: Bearer <token>` com o token com o qual o sidecar foi iniciado.
400 antes que algo aconteça	O corpo ou parâmetro não corresponde ao esquema	Compare a carga útil com o esquema de solicitação no cartão.
403 ou 404 em um registro que você vê em outro lugar	A conta atuante difere	Envie o certo `x-session-token`ou use o perfil local que possui o registro.
409	Estado conflitante, como um nome duplicado ou um cabeçalho de ramificação obsoleto	Leia novamente o recurso e tente novamente com os dados atuais.
Tente dizer "bloqueado pelo CORS"	Os documentos são veiculados a partir de uma origem sem loopback	Execute os documentos localmente ou copie a solicitação como curl.
Ligação recusada	O sidecar foi reiniciado em uma nova porta	Leia a porta do novo `ready` linha.