Documentação

Notificações

Listagem de notificações, atualizações de estado de leitura, exclusão e marcação de tudo como lido.

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

4 endpoints no notifications 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/notifications	notifications.list
colocar	/api/notifications/{id}	notifications.update
excluir	/api/notifications/{id}	notifications.remove
publicar	/api/notifications/mark-all-read	notifications.markAllRead

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

Um bloco por operação (4), 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/notifications

pegar /api/notifications # notifications.list

Requer Authorization: Bearer <token>.

Parâmetros

Nome	Em	Tipo	Obrigatório
limite	consulta	corda \| null	opcional
desvio	consulta	corda \| null	opcional
cursor	consulta	corda \| null	opcional
onlyUnread	consulta	corda \| null	opcional

Respostas

200 objeto application/json

{
  notifications: Array<{
    id: string
    type: "NEW_MESSAGE" | "PROJECT_CREATED" | "COMPONENT_CREATED" | "MEMBER_JOINED" | "ORGANIZATION_INVITATION" | "PR_OPENED" | "PR_MERGED" | "PR_REVIEWED" | "AI_COMMITTED" | "WORKFLOW_FAILED" | "WORKFLOW_PASSED"
    title: string
    content: string
    isRead: boolean
    createdAt: string
    userId: string
    organizationId: string | null
    projectId: string | null
    componentId: string | null
    messageId: string | null
    linkUrl: string | null
  }>
  unreadCount: number | "Infinity" | "-Infinity" | "NaN"
  nextCursor: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Resposta de exemplo capturado · 200

GET /api/notificações

{
  "notifications": [],
  "unreadCount": 0
}

Exemplo de SDK

notifications.list

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

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

// NotificationsListInput
const result = await client.notifications.list({})

curl

GET /api/notificações

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

Experimente

limite consulta desvio consulta cursor consulta onlyUnread consulta

colocar /api/notifications/{id} # notifications.update

Requer Authorization: Bearer <token>.

Parâmetros

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

Corpo da solicitação · obrigatório · aplicação/json

{
  isRead: boolean
}

Respostas

200 objeto application/json

{
  id: string
  type: "NEW_MESSAGE" | "PROJECT_CREATED" | "COMPONENT_CREATED" | "MEMBER_JOINED" | "ORGANIZATION_INVITATION" | "PR_OPENED" | "PR_MERGED" | "PR_REVIEWED" | "AI_COMMITTED" | "WORKFLOW_FAILED" | "WORKFLOW_PASSED"
  title: string
  content: string
  isRead: boolean
  createdAt: string
  userId: string
  organizationId: string | null
  projectId: string | null
  componentId: string | null
  messageId: string | null
  linkUrl: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

notifications.update

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

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

// NotificationsUpdateInput
const result = await client.notifications.update({
  id: "<id>",
  isRead: false
})

curl

PUT /api/notificações/{id}

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

Experimente

eu ia caminho · obrigatório

Solicitar corpo application/json

excluir /api/notifications/{id} # notifications.remove

Requer Authorization: Bearer <token>.

Parâmetros

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

Respostas

200 objeto application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

notifications.remove

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

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

// NotificationsRemoveInput
const result = await client.notifications.remove({
  id: "<id>"
})

curl

DELETE /api/notificações/{id}

curl --request DELETE "${CADCAMFUN_URL}/api/notifications/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

Experimente

eu ia caminho · obrigatório

/api/notifications/mark-all-read

publicar /api/notifications/mark-all-read # notifications.markAllRead

Requer Authorization: Bearer <token>.

Respostas

200 objeto application/json

{
  message: string
  count: number | "Infinity" | "-Infinity" | "NaN"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Exemplo de SDK

notifications.markAllRead

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

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

// no input
const result = await client.notifications.markAllRead()

curl

POST /api/notificações/marcar tudo como lido

curl --request POST "${CADCAMFUN_URL}/api/notifications/mark-all-read" \
  --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.

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

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 notifications.<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.