Pular para o conteúdo principal

kobana kadu files

Comandos de kobana kadu files. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
files listGET /v1/filesLista arquivos
files createPOST /v1/filesInicia upload de arquivo de entrada
files getGET /v1/files/{id}Detalha o arquivo
files confirmPOST /v1/files/{id}/confirmConfirma o upload (pending → uploaded)
files downloadGET /v1/files/{id}/downloadURL temporária de download

files list​

Lista arquivos

kobana kadu files list [OPÇÕES]

GET /v1/files

Parâmetros de consulta

NomeTipoObrigatórioDescrição
cursorstringnão
limitnumbernão
sort_bystringnãoCampo em snake_case: created_at (padrão), updated_at ou um campo filtrável.
sort_orderstringnãoPadrão: desc. Valores: asc, desc.

Respostas

HTTPDescrição
200OK
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

files create​

Inicia upload de arquivo de entrada

kobana kadu files create [OPÇÕES]

POST /v1/files

Fluxo em três passos: (1) este POST cria o arquivo pending e devolve upload_url; (2) PUT dos bytes em upload_url com o mesmo Content-Type; (3) POST /files/{id}/confirm. O id vai em input_file_ids do POST /tasks/{id}/run (a Task precisa aceitar arquivos de entrada). Tamanho máximo: 100 MB.

Corpo da requisição

NomeTipoObrigatórioDescrição
task_idstring (uuid)sim
filenamestringsim
size_bytesintegersim
content_typestringnão

Outros campos e objetos aninhados: kobana schema kadu.files.create.

Respostas

HTTPDescrição
201created
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422TASK_DOES_NOT_ACCEPT_FILES / VALIDATION_ERROR — Task fora da organização
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

files get​

Detalha o arquivo

kobana kadu files get [ID] [OPÇÕES]

GET /v1/files/{id}

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404not found
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

files confirm​

Confirma o upload (pending → uploaded)

kobana kadu files confirm [ID] [OPÇÕES]

POST /v1/files/{id}/confirm

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409CONFLICT — não é um arquivo de entrada pendente / IDEMPOTENCY_KEY_REUSED
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

files download​

URL temporária de download

kobana kadu files download [ID] [OPÇÕES]

GET /v1/files/{id}/download

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409FILE_NOT_UPLOADED
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).