Refactor API documentation and model attributes for consistency: rename 'isDeleted' to 'delete' and 'encrypted_title'/'encrypted_body' to 'title'/'body'
Despliegue Automático / desplegar (push) Successful in 4m25s

This commit is contained in:
2026-08-15 18:53:09 +02:00
parent ff768cf556
commit f3a0391507
4 changed files with 42 additions and 42 deletions
+21 -21
View File
@@ -170,7 +170,7 @@ Endpoint único de sincronización offline-first.
Autenticación requerida:
- Enviar `Authorization: Bearer <accessToken>` (obligatorio). El servidor ya no acepta `userId` en el body.
- Enviar `Authorization: Bearer <accessToken>` (obligatorio).
#### Request
@@ -185,7 +185,7 @@ Body ejemplo:
"id": "uuid-categoria-1",
"encrypted_name": "texto_cifrado...",
"serverVersion": 1,
"isDeleted": false,
"delete": false,
"updatedAt": "2026-05-18T10:05:00.000Z"
}
],
@@ -193,12 +193,12 @@ Body ejemplo:
{
"id": "uuid-nota-1",
"categoryId": "uuid-categoria-1",
"encrypted_title": "titulo_cifrado...",
"encrypted_body": "cuerpo_cifrado...",
"title": "titulo_cifrado...",
"body": "cuerpo_cifrado...",
"serverVersion": 1,
"position": 2000,
"isDeleted": true,
"isPermanentlyDeleted": false,
"delete": true,
"permanentDelete": false,
"updatedAt": "2026-05-18T10:10:00.000Z"
}
]
@@ -220,7 +220,7 @@ Campos:
"id": "uuid",
"name": "texto_cifrado",
"serverVersion": 1,
"isDeleted": false,
"delete": false,
"isDirty": true,
"colorValue": 4281558681,
"iconCodePoint": 58896,
@@ -233,7 +233,7 @@ Campos:
- `id`: `UUID`, obligatorio.
- `name`: `string` (cifrado), obligatorio. Equivale a `encrypted_name`; ambos contienen el nombre encriptado.
- `serverVersion`: `number` entero >= 0, obligatorio. Es la versión base local con la que se hizo el cambio.
- `isDeleted`: `boolean`, opcional, por defecto `false`.
- `delete`: `boolean`, opcional, por defecto `false`.
- `isDirty`: `boolean`, opcional. El servidor lo ignora en la escritura y devuelve `false` en la respuesta de sync.
- `colorValue`: `number`, opcional.
- `iconCodePoint`: `number`, opcional.
@@ -245,11 +245,11 @@ Campos:
{
"id": "uuid",
"categoryId": "uuid-categoria",
"encrypted_title": "titulo_cifrado",
"encrypted_body": "cuerpo_cifrado",
"title": "titulo_cifrado",
"body": "cuerpo_cifrado",
"serverVersion": 1,
"position": 2000,
"isDeleted": false,
"delete": false,
"updatedAt": "2026-05-18T10:10:00.000Z"
}
```
@@ -258,12 +258,12 @@ Campos:
- `id`: `UUID`, obligatorio.
- `categoryId`: `UUID | null`, opcional.
- `encrypted_title`: `string`, obligatorio.
- `encrypted_body`: `string`, obligatorio.
- `title`: `string`, obligatorio.
- `body`: `string`, obligatorio.
- `serverVersion`: `number` entero >= 0, obligatorio. Es la versión base local con la que se hizo el cambio.
- `position`: `number`, opcional.
- `isDeleted`: `boolean`, opcional, por defecto `false`.
- `isPermanentlyDeleted`: `boolean`, opcional, por defecto `false`. Si llega en `true`, el servidor guarda la nota con `encrypted_title` y `encrypted_body` vacíos, `position` en `0` y `isDeleted` en `true`.
- `delete`: `boolean`, opcional, por defecto `false`.
- `permanentDelete`: `boolean`, opcional, por defecto `false`. Si llega en `true`, el servidor guarda la nota con `title` y `body` vacíos, `position` en `0` y `delete` en `true`.
- `updatedAt`: `ISO date string`, opcional (solo informativo para UI).
#### Response
@@ -280,12 +280,12 @@ Respuesta ejemplo (nuevo contrato):
{
"id": "uuid-nota-2",
"categoryId": null,
"encrypted_title": "titulo_cifrado...",
"encrypted_body": "cuerpo_cifrado...",
"title": "titulo_cifrado...",
"body": "cuerpo_cifrado...",
"serverVersion": 3,
"position": 0,
"isDeleted": false,
"isPermanentlyDeleted": false,
"delete": false,
"permanentDelete": false,
"updatedAt": "2026-05-18T10:15:00.000Z"
}
]
@@ -303,7 +303,7 @@ Campos de salida:
## Reglas de sincronización
- El cliente debe guardar su último `lastSyncAt`.
- Un borrado no elimina el registro localmente: se marca con `isDeleted: true`.
- Un borrado no elimina el registro localmente: se marca con `delete: true`.
- El servidor decide conflictos comparando `serverVersion` (no `updatedAt`).
- En categorías, solo se actualiza si `incoming.serverVersion === serverVersion`. Si no coincide, gana el servidor y no se crea duplicado.
- Si la versión entrante de una nota coincide con la versión actual del servidor, acepta el cambio y sube versión (`v -> v+1`).
@@ -312,4 +312,4 @@ Campos de salida:
## Notas importantes
- Las notas y categorías están pensadas para contenido cifrado del lado del cliente.
- El servidor guarda `encrypted_title`, `encrypted_body` y `encrypted_name`, pero no interpreta el contenido.
- El servidor guarda `title`, `body` y `encrypted_name`, pero no interpreta el contenido.