Referencia Rutas HTTP
Rutas HTTP
Bajo la
base del handler, /api/files en estas páginas. Se leen del comentario del principio de packages/server/src/api.ts al construir este sitio, así que están todas las del código; lo que hace cada una va traducido aquí. Los cuerpos son JSON; un rechazo es { error, message } con su estado: el message en inglés, y el drive lo dice en el idioma de cada persona por su error.De alguien con sesión
Cada una pregunta a identify quién pregunta y a authorize si puede.
| Ruta | Qué hace |
|---|---|
GET/entries?folder=… | Lo que hay en una carpeta (ninguna: arriba del todo), y dónde está |
GET/entries/:id | Una entrada, y dónde está |
GET/recent | Los últimos archivos cambiados |
GET/trash | Lo que hay en la papelera |
GET/starred | Lo que destacó quien pregunta, lo último destacado primero |
PUT/entries/:id/star | Destacado, solo para quien pregunta |
DELETE/entries/:id/star | Ya no |
GET/search?q=…&within=…&trashed=1 | Encontrado por nombre |
POST/folders | { name, parent } |
POST/uploads | { name, parent, type, size }, o { file, type, size } para una versión nueva: adónde enviar las partes; o { rendition: { file, version, size, width, height }, type, size }: una imagen más pequeña de una versión |
POST/uploads/finish | { token, parts: [{ number, etag }] }: el archivo, una vez llegados sus bytes |
POST/uploads/resume | { token }: una subida cortada, retomada: lo que llegó, y adónde enviar el resto |
POST/uploads/abort | { token }: una subida abandonada, y lo que llegó de ella, quitado |
PATCH/entries/:id | { name }, { parent }, { color } o { fields }, con { ifTaken: 'keep-both' } para añadir "(2)" |
GET/fields?name=…&value=… | Lo que tiene ese campo con ese valor, de lo que uno puede leer |
POST/entries/:id/copy | { parent }: una copia de un archivo, sus bytes copiados en el almacenamiento; junto a él si no se dice, o en el propio inicio |
POST/entries/:id/trash | A la papelera |
POST/entries/:id/restore | Fuera de ella |
DELETE/entries/:id | Borrado para siempre, desde la papelera |
POST/trash/empty | Vacía la papelera de quien pregunta |
GET/entries/:id/download?version=&inline=1&size= | Una dirección para leerlo, o para mostrarlo en la página; con size, una imagen más pequeña cuando la hay |
POST/entries/:id/versions/:v/restore | Una versión anterior, de nuevo la actual |
POST/zip | { ids }: lo que tendría un archivo .zip de ellos, las carpetas con su contenido, en sus rutas |
POST/urls | { ids, inline, size }: las direcciones de muchos archivos a la vez, para una cuadrícula; hasta cuándo vale cada una |
GET/info | Dónde están los bytes, como lo lee una persona |
GET/usage | Los bytes que guarda quien pregunta, y cuántos puede |
GET/settings | Los ajustes del drive, los de quien pregunta, y si puede cambiar los del drive |
GET/people?q= | Quién coincide con lo escrito, para compartir (con `people`) |
POST/people/names | { ids }: cómo se llama cada uno (con `people.names`) |
PUT/settings | Los del drive, para quien puede 'configure' |
PUT/settings/mine | { language, theme }: los propios |
GET/entries/:id/activity?limit= | Lo que se le hizo, y dentro de ella si es carpeta, lo más nuevo primero |
GET/search/text?q= | Archivos por lo que tienen escrito, con un trozo alrededor de lo encontrado |
PUT/entries/:id/text | { version, text }: lo que tiene escrito un archivo, como lo leyó la página, para encontrarlo |
PUT/entries/:id/placeholder | { version, placeholder }: la imagen diminuta que se muestra borrosa mientras llega una imagen |
POST/duplicates | { hashes }: los archivos que ya tienen esos bytes, de lo que uno puede leer |
GET/shared | Lo que otros compartieron con quien pregunta |
GET/shared/new | Cuántos de esos son nuevos desde la última vez que miró |
POST/shared/seen | Ya miró: ninguno es nuevo |
POST/entries/:id/shares | { with, role, days }: compartido, o con otro rol; por esos días, sin fin con null, como antes si no se dice |
DELETE/entries/:id/shares/:with | Ya no compartido con esa persona |
POST/entries/:id/links | { days, password, once }: un enlace para leerlo sin iniciar sesión, y su dirección |
GET/entries/:id/links/:link | La dirección de un enlace, otra vez |
DELETE/entries/:id/links/:link | Retirado |
GET/entries/:id/comments | what is said of it, each thread with its replies under it |
POST/entries/:id/comments | { text, replyTo }: a comment, or a reply; those it names with @ told (onComment) |
PATCH/entries/:id/comments/:c | { text } by its author, or { resolved: true | false } |
DELETE/entries/:id/comments/:c | by its author, or by who may share the entry |
PUT/entries/:id/hold | { reason }: on hold, for who may 'configure': not to be trashed or deleted |
DELETE/entries/:id/hold | released |
GET/notifications | Lo que se avisó a quien pregunta (compartido con él o un grupo suyo, nombrado en un comentario), lo más nuevo primero, y cuántos son nuevos |
POST/notifications/seen | Ya miró: ninguno es nuevo |
GET/admin/usage | Para quien puede configurar: lo que guarda cada persona (archivos, carpetas, bytes), y todo el drive |
GET/admin/activity?limit= | Para quien puede configurar: lo que se hizo en cualquier parte del drive, lo más nuevo primero |
GET/export?user=… | everything of a person (oneself, or anyone for who may 'configure'), for a .zip |
GET/events | Lo que cambia, en el momento (server-sent events): las carpetas y entradas de cada cambio que uno puede ver |
A través de un enlace
No preguntan a ninguno: el enlace es el permiso. Un enlace con contraseña la pide en cada una.
| Ruta | Qué hace |
|---|---|
GET/links/:token?folder=… | Lo que lee el enlace, o una carpeta dentro de él |
GET/links/:token/download?id=…&inline=1 | Una dirección para leer un archivo del enlace |
GET/links/:token/zip?ids=… | Lo que tiene un .zip de parte de él (todo, si no se dice) |
GET/links/:token/urls?ids=… | Las direcciones de algunos de sus archivos |
POST/links/:token/uploads | { name, folder, type, size }, y /finish, /abort: un archivo puesto en él, de un enlace que recibe archivos ({ uploads }) |
DELETE/links/:token/sent/:receipt | Un archivo recién enviado por él, retirado, durante diez minutos, con el recibo que dio su subida |
PATCH/entries/:id/links/:link | { days, uploads, request, closed }: un enlace cambiado, cerrado o abierto otra vez |
PUT/entries/:id/review | { status: 'accepted' | 'rejected' | null, reason }: un archivo que llegó por una solicitud, revisado |
GET/received | Lo que llegó por las solicitudes de archivos de quien pregunta, lo más nuevo primero |
GET/requests | Las solicitudes de archivos de quien pregunta: cada carpeta, su enlace, su token, lo que llegó |
GET/admin/requests | Para quien puede configurar: cada solicitud de archivos, a quién se envió y lo que falta |
POST/entries/:id/links/:link/remind | A quien se le envió una solicitud, recordado ahora de lo que falta (con `reminders`) |
GET/expiring?days= | Archivos que uno puede leer cuyo campo expires dice que dejan de valer en tantos días |