Dateien

Operationen

2 Endpunkte in der files gruppe, generiert aus der eigenen Gruppe des Sidecars OpenAPI-Dokument. Geschützte Operationen dauern Authorization: Bearer $CADCAMFUN_TOKEN; sehen authentifizierung. Verhalten und Grenzen sind in das Subsystemhandbuch.

/api/upload

{
  fileName?: string | null
  fileType?: string | null
  organizationId?: string | null
  conversationId?: string | null
  fileSize?: number | "Infinity" | "-Infinity" | "NaN" | null
}

{
  upload: {
    id: string
    fileName: string
    s3Key: string
    s3Bucket: string
    s3ContentType: string
    s3Size: number | "Infinity" | "-Infinity" | "NaN"
    objectId: string | null
    objectType: string | null
    ownerId: string
    organizationId: string | null
    createdAt: string
    updatedAt: string
    publicUrl: string
  }
  uploadUrl: string
}

BadRequestEncoded

UnauthorizedEncoded

ForbiddenEncoded

InternalErrorEncoded

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

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

// FilesUploadInput
const result = await client.files.upload({
  fileName: "",
  fileType: "",
  organizationId: "",
  conversationId: "",
  fileSize: 0
})

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

/api/download

string

UnauthorizedEncoded

NotFoundEncoded

InternalErrorEncoded

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

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

Schemata

Benannte Schemata, die über die Parameter, Körper und Antworten dieser Gruppe erreichbar sind. A ? markiert ein optionales Feld; | null markiert ein Feld, das möglicherweise mit einem Nullwert vorhanden ist.

{
  _tag: "BadRequest"
  message: string
}

{
  _tag: "Forbidden"
  message: string
}

{
  _tag: "InternalError"
  message: string
}

{
  _tag: "NotFound"
  message: string
}

{
  _tag: "Unauthorized"
  message: string
}

Ich rufe diese Gruppe an

Vorgangs-IDs haben die Form files.<name>. Das generierte Promise SDK (@cadcamfun/api/sdk) entlarvt die meisten von ihnen als client.<namespace>.<method>(input), wo input ist ein flaches Objekt aus Pfadparametern und Körperfeldern; Das SDK-Beispiel jeder Karte zeigt den genauen Zugriffs- und Eingabetyp. Mehrteilige Uploads, Binär- oder JavaScript-Antworten und unformatierte Webhooks werden nicht generiert; Diese Karten zeigen fetch stattdessen.

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

Fehlerbehebung