@cosmicdrift/kumiko-bundled-features 0.411.0 → 0.412.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent-tools/agent-doc-lint.d.ts +9 -0
- package/dist/agent-tools/agent-doc-lint.js +42 -5
- package/dist/agent-tools/agent-manifest.d.ts +0 -1
- package/dist/agent-tools/agent-manifest.js +9 -99
- package/dist/agent-tools/api-docs/anchors.d.ts +14 -0
- package/dist/agent-tools/api-docs/anchors.js +49 -0
- package/dist/agent-tools/api-docs/check.d.ts +7 -0
- package/dist/agent-tools/api-docs/check.js +15 -0
- package/dist/agent-tools/api-docs/collect-events.d.ts +10 -0
- package/dist/agent-tools/api-docs/collect-events.js +90 -0
- package/dist/agent-tools/api-docs/collect.d.ts +15 -0
- package/dist/agent-tools/api-docs/collect.js +108 -0
- package/dist/agent-tools/api-docs/curl.d.ts +5 -0
- package/dist/agent-tools/api-docs/curl.js +24 -0
- package/dist/agent-tools/api-docs/error-table.d.ts +9 -0
- package/dist/agent-tools/api-docs/error-table.js +31 -0
- package/dist/agent-tools/api-docs/examples.d.ts +16 -0
- package/dist/agent-tools/api-docs/examples.js +25 -0
- package/dist/agent-tools/api-docs/generate.d.ts +19 -0
- package/dist/agent-tools/api-docs/generate.js +104 -0
- package/dist/agent-tools/api-docs/index-json.d.ts +15 -0
- package/dist/agent-tools/api-docs/index-json.js +6 -0
- package/dist/agent-tools/api-docs/index.d.ts +9 -0
- package/dist/agent-tools/api-docs/index.js +6 -0
- package/dist/agent-tools/api-docs/list-parameters.d.ts +61 -0
- package/dist/agent-tools/api-docs/list-parameters.js +28 -0
- package/dist/agent-tools/api-docs/markdown.d.ts +29 -0
- package/dist/agent-tools/api-docs/markdown.js +48 -0
- package/dist/agent-tools/api-docs/menu-path.d.ts +8 -0
- package/dist/agent-tools/api-docs/menu-path.js +60 -0
- package/dist/agent-tools/api-docs/model.d.ts +76 -0
- package/dist/agent-tools/api-docs/model.js +1 -0
- package/dist/agent-tools/api-docs/problems.d.ts +32 -0
- package/dist/agent-tools/api-docs/problems.js +28 -0
- package/dist/agent-tools/api-docs/render-events.d.ts +12 -0
- package/dist/agent-tools/api-docs/render-events.js +55 -0
- package/dist/agent-tools/api-docs/render-openapi.d.ts +10 -0
- package/dist/agent-tools/api-docs/render-openapi.js +170 -0
- package/dist/agent-tools/api-docs/render-overview.d.ts +11 -0
- package/dist/agent-tools/api-docs/render-overview.js +60 -0
- package/dist/agent-tools/api-docs/render-reference.d.ts +14 -0
- package/dist/agent-tools/api-docs/render-reference.js +50 -0
- package/dist/agent-tools/api-docs/render-tokens.d.ts +12 -0
- package/dist/agent-tools/api-docs/render-tokens.js +101 -0
- package/dist/agent-tools/api-docs/schema-fields.d.ts +16 -0
- package/dist/agent-tools/api-docs/schema-fields.js +141 -0
- package/dist/agent-tools/api-docs/section-ids.d.ts +25 -0
- package/dist/agent-tools/api-docs/section-ids.js +26 -0
- package/dist/agent-tools/api-docs/system-only.d.ts +5 -0
- package/dist/agent-tools/api-docs/system-only.js +7 -0
- package/dist/agent-tools/api-docs/texts/de.d.ts +123 -0
- package/dist/agent-tools/api-docs/texts/de.js +123 -0
- package/dist/agent-tools/api-docs/texts/en.d.ts +123 -0
- package/dist/agent-tools/api-docs/texts/en.js +123 -0
- package/dist/agent-tools/api-docs/texts/es.d.ts +123 -0
- package/dist/agent-tools/api-docs/texts/es.js +123 -0
- package/dist/agent-tools/api-docs/texts/fr.d.ts +123 -0
- package/dist/agent-tools/api-docs/texts/fr.js +123 -0
- package/dist/agent-tools/api-docs/texts/index.d.ts +14 -0
- package/dist/agent-tools/api-docs/texts/index.js +55 -0
- package/dist/agent-tools/api-docs/texts/it.d.ts +123 -0
- package/dist/agent-tools/api-docs/texts/it.js +123 -0
- package/dist/agent-tools/api-docs/texts/types.d.ts +18 -0
- package/dist/agent-tools/api-docs/texts/types.js +104 -0
- package/dist/agent-tools/api-docs/ui-writes.d.ts +12 -0
- package/dist/agent-tools/api-docs/ui-writes.js +73 -0
- package/dist/agent-tools/handler-schema.d.ts +5 -0
- package/dist/agent-tools/handler-schema.js +37 -0
- package/dist/agent-tools/index.d.ts +2 -1
- package/dist/agent-tools/index.js +2 -1
- package/dist/agent-tools/labels.d.ts +26 -0
- package/dist/agent-tools/labels.js +131 -0
- package/dist/inbound-mail-foundation/entities.d.ts +84 -0
- package/dist/inbound-mail-foundation/entities.js +96 -71
- package/dist/inbound-mail-foundation/feature.js +2 -2
- package/dist/personal-access-tokens/feature.d.ts +1 -0
- package/dist/personal-access-tokens/feature.js +4 -2
- package/dist/personal-access-tokens/handlers/create.write.js +2 -2
- package/dist/personal-access-tokens/i18n.js +5 -1
- package/dist/personal-access-tokens/index.d.ts +4 -2
- package/dist/personal-access-tokens/index.js +29 -2
- package/dist/personal-access-tokens/scope-events-check.d.ts +3 -0
- package/dist/personal-access-tokens/scope-events-check.js +18 -0
- package/dist/personal-access-tokens/screens.js +8 -2
- package/dist/personal-access-tokens/web/constants.d.ts +1 -0
- package/dist/personal-access-tokens/web/constants.js +1 -0
- package/dist/personal-access-tokens/web/scopes.d.ts +2 -0
- package/dist/personal-access-tokens/web/scopes.js +12 -0
- package/package.json +11 -11
- package/src/agent-tools/changes.json +24 -0
- package/src/inbound-mail-foundation/changes.json +6 -0
- package/src/personal-access-tokens/changes.json +6 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
export declare const esApiDocsTexts: {
|
|
2
|
+
readonly text: {
|
|
3
|
+
readonly "overview.title": "API HTTP";
|
|
4
|
+
readonly "overview.description": "Endpoints, cuerpo de la petición, respuestas, códigos de error, listas y lotes de la API HTTP.";
|
|
5
|
+
readonly "overview.intro": "Cada llamada es un POST con cuerpo JSON. El campo `type` nombra el handler y `payload` contiene sus campos. Las páginas de referencia listan cada handler con sus campos.";
|
|
6
|
+
readonly "overview.endpoints.heading": "Endpoints";
|
|
7
|
+
readonly "overview.endpoints.query": "Lee datos. Nunca cambia nada.";
|
|
8
|
+
readonly "overview.endpoints.write": "Cambia datos: crear, actualizar, eliminar o una acción concreta.";
|
|
9
|
+
readonly "overview.endpoints.batch": "Ejecuta varias llamadas de escritura en una transacción.";
|
|
10
|
+
readonly "overview.auth.heading": "Autenticación";
|
|
11
|
+
readonly "overview.auth.body": "Envía un token de API en la cabecera `Authorization` como `Bearer <token>`. Las peticiones con token no necesitan cookie ni token CSRF. El token también fija la cuenta en la que se ejecuta la petición, así que nunca envías un ID de cuenta o de tenant.";
|
|
12
|
+
readonly "overview.body.heading": "Cuerpo de la petición";
|
|
13
|
+
readonly "overview.body.body": "`type` es el nombre del handler, por ejemplo `{exampleType}`. `payload` contiene los campos de la referencia. `requestId` es opcional, ver más abajo. El payload puede anidarse como máximo {maxDepth} niveles.";
|
|
14
|
+
readonly "overview.responses.heading": "Respuestas";
|
|
15
|
+
readonly "overview.responses.success": "Una lectura correcta devuelve `data`. Una escritura correcta devuelve `isSuccess: true` y `data`.";
|
|
16
|
+
readonly "overview.responses.error": "Si falla, el estado HTTP es 4xx o 5xx y el cuerpo contiene `error`. Las llamadas de escritura devuelven además `isSuccess: false`. Decide según `error.code` y el estado. `message` está pensado para personas y puede cambiar.";
|
|
17
|
+
readonly "overview.errors.heading": "Códigos de error";
|
|
18
|
+
readonly "overview.errors.columns": "Código | Estado HTTP | Significado";
|
|
19
|
+
readonly "overview.versions.heading": "Versiones y conflictos";
|
|
20
|
+
readonly "overview.versions.body": "Cada registro tiene una `version`. Una actualización usa la `version` que leíste por última vez. Si alguien cambió el registro entretanto, la llamada falla con 409 `version_conflict`. Vuelve a leer el registro, revisa el cambio y envíalo con la nueva versión.";
|
|
21
|
+
readonly "overview.lists.heading": "Listas";
|
|
22
|
+
readonly "overview.lists.intro": "Los handlers de lista terminan en `:list` y aceptan estos campos:";
|
|
23
|
+
readonly "overview.lists.columns": "Campo | Tipo | Descripción";
|
|
24
|
+
readonly "overview.lists.response": "La respuesta contiene `rows` y `nextCursor`. Para la página siguiente envía `nextCursor` como `cursor`. En la última página `nextCursor` es `null`.";
|
|
25
|
+
readonly "overview.batch.heading": "Lotes";
|
|
26
|
+
readonly "overview.batch.body": "`POST /api/batch` recibe `commands`, una lista de llamadas de escritura `{ type, payload }`. Se ejecutan en una transacción: si una falla, ninguna surte efecto. La respuesta tiene entonces `isSuccess: false`, el `error` y `failedIndex`, la posición del comando fallido contada desde 0.";
|
|
27
|
+
readonly "overview.retry.heading": "Reintentos seguros";
|
|
28
|
+
readonly "overview.retry.body": "Envía un `requestId` en las llamadas de escritura y de lote, cualquier cadena única por cambio. Si se corta la conexión y vuelves a enviar la misma llamada con el mismo `requestId`, recibes el primer resultado y el cambio no se ejecuta dos veces.";
|
|
29
|
+
readonly "tokens.title": "Tokens de API";
|
|
30
|
+
readonly "tokens.description": "Crea un token de API para {appName}, elige sus scopes y envíalo con tus peticiones.";
|
|
31
|
+
readonly "tokens.intro": "Un token de API permite que un script u otro servicio llame a la API de {appName} en tu nombre. Sus scopes deciden qué datos puede leer o cambiar.";
|
|
32
|
+
readonly "tokens.create.heading": "Crear un token";
|
|
33
|
+
readonly "tokens.create.step1": "Abre {menuPath}.";
|
|
34
|
+
readonly "tokens.create.step2": "Elige **{createLabel}**.";
|
|
35
|
+
readonly "tokens.create.step3": "Introduce un nombre, elige los scopes y la caducidad, y confirma con tu contraseña.";
|
|
36
|
+
readonly "tokens.create.step4": "Copia el token. Empieza por `kpat_` y se muestra una sola vez.";
|
|
37
|
+
readonly "tokens.expiry": "Un token caduca a los {defaultDays} días si no eliges otra caducidad. La caducidad máxima posible es de {maxDays} días.";
|
|
38
|
+
readonly "tokens.use.heading": "Usar el token";
|
|
39
|
+
readonly "tokens.use.body": "Envía el token en la cabecera `Authorization`. Las peticiones con token no necesitan cookie ni token CSRF.";
|
|
40
|
+
readonly "tokens.scopes.heading": "Scopes";
|
|
41
|
+
readonly "tokens.scopes.intro": "Cada scope tiene dos niveles. `read` permite los handlers de lectura. `write` permite todo lo que permite `read` y además los handlers de escritura.";
|
|
42
|
+
readonly "tokens.scopes.columns": "Scope | Permiso | Handlers";
|
|
43
|
+
readonly "tokens.rateLimit.heading": "Límite de peticiones";
|
|
44
|
+
readonly "tokens.rateLimit": "Cada token puede enviar {max} peticiones cada {windowSeconds} segundos. Por encima, la API responde 429 `pat_rate_limited`.";
|
|
45
|
+
readonly "tokens.errors.heading": "Errores";
|
|
46
|
+
readonly "tokens.errors.columns": "Estado HTTP | Código | Causa";
|
|
47
|
+
readonly "tokens.errors.missing": "Falta la cabecera `Authorization`.";
|
|
48
|
+
readonly "tokens.errors.invalid": "El token es desconocido, está revocado o ha caducado.";
|
|
49
|
+
readonly "tokens.errors.scope": "Al token le falta el scope para este handler.";
|
|
50
|
+
readonly "tokens.errors.route": "El endpoint no acepta tokens. Los tokens solo funcionan en los endpoints de la API.";
|
|
51
|
+
readonly "tokens.errors.rate": "Demasiadas peticiones con este token.";
|
|
52
|
+
readonly "tokens.errors.disabled": "Los tokens de API no forman parte de tu plan.";
|
|
53
|
+
readonly "tokens.revoke.heading": "Revocar un token";
|
|
54
|
+
readonly "tokens.revoke.body": "Revoca un token en {menuPath} en cuanto dejes de usarlo. Al cambiar tu contraseña se revocan todos tus tokens. Un token actúa siempre con tus roles actuales. Si abandonas la cuenta o se elimina tu usuario, deja de funcionar.";
|
|
55
|
+
readonly "tokens.security.heading": "Seguridad";
|
|
56
|
+
readonly "tokens.security.item1": "Trata un token como una contraseña. Guárdalo en un almacén de secretos, nunca en el código, en un repositorio, en una app o página web ni en un log.";
|
|
57
|
+
readonly "tokens.security.item2": "Da a cada script su propio token, solo con los scopes que necesita.";
|
|
58
|
+
readonly "tokens.security.item3": "Revoca los tokens que ya no uses. Revoca un token de inmediato si puede haberse filtrado.";
|
|
59
|
+
readonly "reference.description": "Referencia de la API para {scopeLabel}: cada handler con sus campos y un ejemplo.";
|
|
60
|
+
readonly "reference.requiredScope": "Scope necesario";
|
|
61
|
+
readonly "reference.endpoint": "Endpoint";
|
|
62
|
+
readonly "reference.fields.columns": "Campo | Tipo | Obligatorio | Descripción";
|
|
63
|
+
readonly "reference.yes": "sí";
|
|
64
|
+
readonly "reference.no": "no";
|
|
65
|
+
readonly "reference.noFields": "Este handler no recibe campos.";
|
|
66
|
+
readonly "reference.excluded": "No se pueden establecer mediante la API: {fields}.";
|
|
67
|
+
readonly "reference.exampleRequest": "Petición de ejemplo";
|
|
68
|
+
readonly "reference.exampleResponse": "Respuesta de ejemplo";
|
|
69
|
+
readonly "reference.status": "Estado: {status}";
|
|
70
|
+
readonly "events.title": "Eventos de webhook";
|
|
71
|
+
readonly "events.description": "Eventos de webhook: cuándo se envían, qué scope necesitan y qué contiene su carga.";
|
|
72
|
+
readonly "events.intro": "Un evento de webhook avisa a tu sistema de que algo ha cambiado. Cada evento tiene un nombre, una versión y una carga. El scope indicado en un evento es el scope de token que permite suscribirse a él.";
|
|
73
|
+
readonly "events.delivery.heading": "Entrega";
|
|
74
|
+
readonly "events.versions.heading": "Versiones";
|
|
75
|
+
readonly "events.versions.body": "Añadir un campo opcional mantiene la versión. Un cambio incompatible, como quitar o renombrar un campo o cambiar su tipo, recibe una versión nueva.";
|
|
76
|
+
readonly "events.list.heading": "Eventos";
|
|
77
|
+
readonly "events.version": "Versión";
|
|
78
|
+
readonly "events.requiredScope": "Scope necesario";
|
|
79
|
+
readonly "events.example": "Carga de ejemplo";
|
|
80
|
+
readonly "events.noFields": "Este evento no contiene campos.";
|
|
81
|
+
readonly "events.entity.created": "Se creó un registro de tipo {entity}.";
|
|
82
|
+
readonly "events.entity.updated": "Se actualizó un registro de tipo {entity}.";
|
|
83
|
+
readonly "events.entity.deleted": "Se eliminó un registro de tipo {entity}.";
|
|
84
|
+
};
|
|
85
|
+
readonly errorMeanings: {
|
|
86
|
+
readonly validation_error: "El payload no coincide con los campos del handler. `details` nombra los campos.";
|
|
87
|
+
readonly unauthenticated: "No se enviaron credenciales válidas.";
|
|
88
|
+
readonly missing_token: "Falta la cabecera `Authorization`.";
|
|
89
|
+
readonly invalid_token: "El token es desconocido, está revocado o ha caducado.";
|
|
90
|
+
readonly ambiguous_auth: "La petición llevaba cookie de sesión y token. Envía solo uno de los dos.";
|
|
91
|
+
readonly access_denied: "Al token le falta el scope para este handler, o el endpoint no acepta tokens.";
|
|
92
|
+
readonly feature_disabled: "Esta función está desactivada o no forma parte de tu plan.";
|
|
93
|
+
readonly not_found: "El registro no existe o no puedes verlo.";
|
|
94
|
+
readonly conflict: "El cambio entra en conflicto con el estado actual de los datos.";
|
|
95
|
+
readonly version_conflict: "El registro cambió después de leerlo. Léelo de nuevo y reintenta con la nueva `version`.";
|
|
96
|
+
readonly precondition_failed: "Un campo del registro ya no tiene el valor que esperaba el cambio. Vuelve a leer el registro y reintenta.";
|
|
97
|
+
readonly record_locked: "Otro cambio bloquea el registro. Reintenta en un momento.";
|
|
98
|
+
readonly idempotent_replay: "Este cambio ya se aplicó con la misma clave de idempotencia. El primer intento tuvo éxito, así que no lo envíes otra vez.";
|
|
99
|
+
readonly unique_violation: "Ya existe un registro con este valor.";
|
|
100
|
+
readonly unprocessable: "Los datos son válidos, pero una regla de negocio rechaza el cambio. `details.reason` nombra la regla.";
|
|
101
|
+
readonly unconfigured: "Un ajuste que necesita esta función sigue vacío. Configúralo primero en la app y reintenta.";
|
|
102
|
+
readonly internal_error: "Error inesperado del servidor. Reintenta más tarde.";
|
|
103
|
+
readonly member_read_timeout: "Una lectura en el servidor tardó demasiado y se detuvo. Reintenta más tarde.";
|
|
104
|
+
readonly rate_limited: "Demasiadas peticiones. Espera los segundos que indica la cabecera `Retry-After`.";
|
|
105
|
+
readonly rate_limit_unavailable: "El límite de frecuencia no está disponible temporalmente y se rechazó la petición. Reintenta en un momento.";
|
|
106
|
+
readonly pat_rate_limited: "Este token envió demasiadas peticiones en poco tiempo. Espera un momento y reintenta.";
|
|
107
|
+
};
|
|
108
|
+
readonly listParameters: {
|
|
109
|
+
readonly cursor: "Posición de `nextCursor` de la página anterior.";
|
|
110
|
+
readonly limit: "Filas por página, {default} por defecto, como máximo {max}.";
|
|
111
|
+
readonly search: "Búsqueda de texto completo en los campos con búsqueda.";
|
|
112
|
+
readonly sort: "Campo por el que ordenar.";
|
|
113
|
+
readonly sortDirection: "`asc` o `desc`.";
|
|
114
|
+
readonly offset: "Número de filas que se omiten. Para paginar es mejor `cursor`.";
|
|
115
|
+
readonly totalCount: "Con `true` recibes además `total`, el número de filas que coinciden.";
|
|
116
|
+
readonly includeDeleted: "Con `true` se incluyen las filas eliminadas. Solo para entidades con borrado lógico.";
|
|
117
|
+
readonly onlyDeleted: "Con `true` solo se devuelven las filas eliminadas. Solo para entidades con borrado lógico, no junto con `includeDeleted`.";
|
|
118
|
+
readonly filter: "Un filtro de campo con `field`, `op` y `value`. `op` es uno de {ops}.";
|
|
119
|
+
readonly filters: "Varios filtros de campo, cada uno con `field`, `op` y `value`. `op` es uno de {ops}.";
|
|
120
|
+
readonly namedFilter: "Nombre de un filtro predefinido de la entidad, por ejemplo una cola de trabajo.";
|
|
121
|
+
readonly aggregate: "Devuelve valores agregados en lugar de filas.";
|
|
122
|
+
};
|
|
123
|
+
};
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
export const esApiDocsTexts = {
|
|
2
|
+
text: {
|
|
3
|
+
"overview.title": "API HTTP",
|
|
4
|
+
"overview.description": "Endpoints, cuerpo de la petición, respuestas, códigos de error, listas y lotes de la API HTTP.",
|
|
5
|
+
"overview.intro": "Cada llamada es un POST con cuerpo JSON. El campo `type` nombra el handler y `payload` contiene sus campos. Las páginas de referencia listan cada handler con sus campos.",
|
|
6
|
+
"overview.endpoints.heading": "Endpoints",
|
|
7
|
+
"overview.endpoints.query": "Lee datos. Nunca cambia nada.",
|
|
8
|
+
"overview.endpoints.write": "Cambia datos: crear, actualizar, eliminar o una acción concreta.",
|
|
9
|
+
"overview.endpoints.batch": "Ejecuta varias llamadas de escritura en una transacción.",
|
|
10
|
+
"overview.auth.heading": "Autenticación",
|
|
11
|
+
"overview.auth.body": "Envía un token de API en la cabecera `Authorization` como `Bearer <token>`. Las peticiones con token no necesitan cookie ni token CSRF. El token también fija la cuenta en la que se ejecuta la petición, así que nunca envías un ID de cuenta o de tenant.",
|
|
12
|
+
"overview.body.heading": "Cuerpo de la petición",
|
|
13
|
+
"overview.body.body": "`type` es el nombre del handler, por ejemplo `{exampleType}`. `payload` contiene los campos de la referencia. `requestId` es opcional, ver más abajo. El payload puede anidarse como máximo {maxDepth} niveles.",
|
|
14
|
+
"overview.responses.heading": "Respuestas",
|
|
15
|
+
"overview.responses.success": "Una lectura correcta devuelve `data`. Una escritura correcta devuelve `isSuccess: true` y `data`.",
|
|
16
|
+
"overview.responses.error": "Si falla, el estado HTTP es 4xx o 5xx y el cuerpo contiene `error`. Las llamadas de escritura devuelven además `isSuccess: false`. Decide según `error.code` y el estado. `message` está pensado para personas y puede cambiar.",
|
|
17
|
+
"overview.errors.heading": "Códigos de error",
|
|
18
|
+
"overview.errors.columns": "Código | Estado HTTP | Significado",
|
|
19
|
+
"overview.versions.heading": "Versiones y conflictos",
|
|
20
|
+
"overview.versions.body": "Cada registro tiene una `version`. Una actualización usa la `version` que leíste por última vez. Si alguien cambió el registro entretanto, la llamada falla con 409 `version_conflict`. Vuelve a leer el registro, revisa el cambio y envíalo con la nueva versión.",
|
|
21
|
+
"overview.lists.heading": "Listas",
|
|
22
|
+
"overview.lists.intro": "Los handlers de lista terminan en `:list` y aceptan estos campos:",
|
|
23
|
+
"overview.lists.columns": "Campo | Tipo | Descripción",
|
|
24
|
+
"overview.lists.response": "La respuesta contiene `rows` y `nextCursor`. Para la página siguiente envía `nextCursor` como `cursor`. En la última página `nextCursor` es `null`.",
|
|
25
|
+
"overview.batch.heading": "Lotes",
|
|
26
|
+
"overview.batch.body": "`POST /api/batch` recibe `commands`, una lista de llamadas de escritura `{ type, payload }`. Se ejecutan en una transacción: si una falla, ninguna surte efecto. La respuesta tiene entonces `isSuccess: false`, el `error` y `failedIndex`, la posición del comando fallido contada desde 0.",
|
|
27
|
+
"overview.retry.heading": "Reintentos seguros",
|
|
28
|
+
"overview.retry.body": "Envía un `requestId` en las llamadas de escritura y de lote, cualquier cadena única por cambio. Si se corta la conexión y vuelves a enviar la misma llamada con el mismo `requestId`, recibes el primer resultado y el cambio no se ejecuta dos veces.",
|
|
29
|
+
"tokens.title": "Tokens de API",
|
|
30
|
+
"tokens.description": "Crea un token de API para {appName}, elige sus scopes y envíalo con tus peticiones.",
|
|
31
|
+
"tokens.intro": "Un token de API permite que un script u otro servicio llame a la API de {appName} en tu nombre. Sus scopes deciden qué datos puede leer o cambiar.",
|
|
32
|
+
"tokens.create.heading": "Crear un token",
|
|
33
|
+
"tokens.create.step1": "Abre {menuPath}.",
|
|
34
|
+
"tokens.create.step2": "Elige **{createLabel}**.",
|
|
35
|
+
"tokens.create.step3": "Introduce un nombre, elige los scopes y la caducidad, y confirma con tu contraseña.",
|
|
36
|
+
"tokens.create.step4": "Copia el token. Empieza por `kpat_` y se muestra una sola vez.",
|
|
37
|
+
"tokens.expiry": "Un token caduca a los {defaultDays} días si no eliges otra caducidad. La caducidad máxima posible es de {maxDays} días.",
|
|
38
|
+
"tokens.use.heading": "Usar el token",
|
|
39
|
+
"tokens.use.body": "Envía el token en la cabecera `Authorization`. Las peticiones con token no necesitan cookie ni token CSRF.",
|
|
40
|
+
"tokens.scopes.heading": "Scopes",
|
|
41
|
+
"tokens.scopes.intro": "Cada scope tiene dos niveles. `read` permite los handlers de lectura. `write` permite todo lo que permite `read` y además los handlers de escritura.",
|
|
42
|
+
"tokens.scopes.columns": "Scope | Permiso | Handlers",
|
|
43
|
+
"tokens.rateLimit.heading": "Límite de peticiones",
|
|
44
|
+
"tokens.rateLimit": "Cada token puede enviar {max} peticiones cada {windowSeconds} segundos. Por encima, la API responde 429 `pat_rate_limited`.",
|
|
45
|
+
"tokens.errors.heading": "Errores",
|
|
46
|
+
"tokens.errors.columns": "Estado HTTP | Código | Causa",
|
|
47
|
+
"tokens.errors.missing": "Falta la cabecera `Authorization`.",
|
|
48
|
+
"tokens.errors.invalid": "El token es desconocido, está revocado o ha caducado.",
|
|
49
|
+
"tokens.errors.scope": "Al token le falta el scope para este handler.",
|
|
50
|
+
"tokens.errors.route": "El endpoint no acepta tokens. Los tokens solo funcionan en los endpoints de la API.",
|
|
51
|
+
"tokens.errors.rate": "Demasiadas peticiones con este token.",
|
|
52
|
+
"tokens.errors.disabled": "Los tokens de API no forman parte de tu plan.",
|
|
53
|
+
"tokens.revoke.heading": "Revocar un token",
|
|
54
|
+
"tokens.revoke.body": "Revoca un token en {menuPath} en cuanto dejes de usarlo. Al cambiar tu contraseña se revocan todos tus tokens. Un token actúa siempre con tus roles actuales. Si abandonas la cuenta o se elimina tu usuario, deja de funcionar.",
|
|
55
|
+
"tokens.security.heading": "Seguridad",
|
|
56
|
+
"tokens.security.item1": "Trata un token como una contraseña. Guárdalo en un almacén de secretos, nunca en el código, en un repositorio, en una app o página web ni en un log.",
|
|
57
|
+
"tokens.security.item2": "Da a cada script su propio token, solo con los scopes que necesita.",
|
|
58
|
+
"tokens.security.item3": "Revoca los tokens que ya no uses. Revoca un token de inmediato si puede haberse filtrado.",
|
|
59
|
+
"reference.description": "Referencia de la API para {scopeLabel}: cada handler con sus campos y un ejemplo.",
|
|
60
|
+
"reference.requiredScope": "Scope necesario",
|
|
61
|
+
"reference.endpoint": "Endpoint",
|
|
62
|
+
"reference.fields.columns": "Campo | Tipo | Obligatorio | Descripción",
|
|
63
|
+
"reference.yes": "sí",
|
|
64
|
+
"reference.no": "no",
|
|
65
|
+
"reference.noFields": "Este handler no recibe campos.",
|
|
66
|
+
"reference.excluded": "No se pueden establecer mediante la API: {fields}.",
|
|
67
|
+
"reference.exampleRequest": "Petición de ejemplo",
|
|
68
|
+
"reference.exampleResponse": "Respuesta de ejemplo",
|
|
69
|
+
"reference.status": "Estado: {status}",
|
|
70
|
+
"events.title": "Eventos de webhook",
|
|
71
|
+
"events.description": "Eventos de webhook: cuándo se envían, qué scope necesitan y qué contiene su carga.",
|
|
72
|
+
"events.intro": "Un evento de webhook avisa a tu sistema de que algo ha cambiado. Cada evento tiene un nombre, una versión y una carga. El scope indicado en un evento es el scope de token que permite suscribirse a él.",
|
|
73
|
+
"events.delivery.heading": "Entrega",
|
|
74
|
+
"events.versions.heading": "Versiones",
|
|
75
|
+
"events.versions.body": "Añadir un campo opcional mantiene la versión. Un cambio incompatible, como quitar o renombrar un campo o cambiar su tipo, recibe una versión nueva.",
|
|
76
|
+
"events.list.heading": "Eventos",
|
|
77
|
+
"events.version": "Versión",
|
|
78
|
+
"events.requiredScope": "Scope necesario",
|
|
79
|
+
"events.example": "Carga de ejemplo",
|
|
80
|
+
"events.noFields": "Este evento no contiene campos.",
|
|
81
|
+
"events.entity.created": "Se creó un registro de tipo {entity}.",
|
|
82
|
+
"events.entity.updated": "Se actualizó un registro de tipo {entity}.",
|
|
83
|
+
"events.entity.deleted": "Se eliminó un registro de tipo {entity}.",
|
|
84
|
+
},
|
|
85
|
+
errorMeanings: {
|
|
86
|
+
validation_error: "El payload no coincide con los campos del handler. `details` nombra los campos.",
|
|
87
|
+
unauthenticated: "No se enviaron credenciales válidas.",
|
|
88
|
+
missing_token: "Falta la cabecera `Authorization`.",
|
|
89
|
+
invalid_token: "El token es desconocido, está revocado o ha caducado.",
|
|
90
|
+
ambiguous_auth: "La petición llevaba cookie de sesión y token. Envía solo uno de los dos.",
|
|
91
|
+
access_denied: "Al token le falta el scope para este handler, o el endpoint no acepta tokens.",
|
|
92
|
+
feature_disabled: "Esta función está desactivada o no forma parte de tu plan.",
|
|
93
|
+
not_found: "El registro no existe o no puedes verlo.",
|
|
94
|
+
conflict: "El cambio entra en conflicto con el estado actual de los datos.",
|
|
95
|
+
version_conflict: "El registro cambió después de leerlo. Léelo de nuevo y reintenta con la nueva `version`.",
|
|
96
|
+
precondition_failed: "Un campo del registro ya no tiene el valor que esperaba el cambio. Vuelve a leer el registro y reintenta.",
|
|
97
|
+
record_locked: "Otro cambio bloquea el registro. Reintenta en un momento.",
|
|
98
|
+
idempotent_replay: "Este cambio ya se aplicó con la misma clave de idempotencia. El primer intento tuvo éxito, así que no lo envíes otra vez.",
|
|
99
|
+
unique_violation: "Ya existe un registro con este valor.",
|
|
100
|
+
unprocessable: "Los datos son válidos, pero una regla de negocio rechaza el cambio. `details.reason` nombra la regla.",
|
|
101
|
+
unconfigured: "Un ajuste que necesita esta función sigue vacío. Configúralo primero en la app y reintenta.",
|
|
102
|
+
internal_error: "Error inesperado del servidor. Reintenta más tarde.",
|
|
103
|
+
member_read_timeout: "Una lectura en el servidor tardó demasiado y se detuvo. Reintenta más tarde.",
|
|
104
|
+
rate_limited: "Demasiadas peticiones. Espera los segundos que indica la cabecera `Retry-After`.",
|
|
105
|
+
rate_limit_unavailable: "El límite de frecuencia no está disponible temporalmente y se rechazó la petición. Reintenta en un momento.",
|
|
106
|
+
pat_rate_limited: "Este token envió demasiadas peticiones en poco tiempo. Espera un momento y reintenta.",
|
|
107
|
+
},
|
|
108
|
+
listParameters: {
|
|
109
|
+
cursor: "Posición de `nextCursor` de la página anterior.",
|
|
110
|
+
limit: "Filas por página, {default} por defecto, como máximo {max}.",
|
|
111
|
+
search: "Búsqueda de texto completo en los campos con búsqueda.",
|
|
112
|
+
sort: "Campo por el que ordenar.",
|
|
113
|
+
sortDirection: "`asc` o `desc`.",
|
|
114
|
+
offset: "Número de filas que se omiten. Para paginar es mejor `cursor`.",
|
|
115
|
+
totalCount: "Con `true` recibes además `total`, el número de filas que coinciden.",
|
|
116
|
+
includeDeleted: "Con `true` se incluyen las filas eliminadas. Solo para entidades con borrado lógico.",
|
|
117
|
+
onlyDeleted: "Con `true` solo se devuelven las filas eliminadas. Solo para entidades con borrado lógico, no junto con `includeDeleted`.",
|
|
118
|
+
filter: "Un filtro de campo con `field`, `op` y `value`. `op` es uno de {ops}.",
|
|
119
|
+
filters: "Varios filtros de campo, cada uno con `field`, `op` y `value`. `op` es uno de {ops}.",
|
|
120
|
+
namedFilter: "Nombre de un filtro predefinido de la entidad, por ejemplo una cola de trabajo.",
|
|
121
|
+
aggregate: "Devuelve valores agregados en lugar de filas.",
|
|
122
|
+
},
|
|
123
|
+
};
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
export declare const frApiDocsTexts: {
|
|
2
|
+
readonly text: {
|
|
3
|
+
readonly "overview.title": "API HTTP";
|
|
4
|
+
readonly "overview.description": "Endpoints, corps de la requête, réponses, codes d'erreur, listes et lots de l'API HTTP.";
|
|
5
|
+
readonly "overview.intro": "Chaque appel est un POST avec un corps JSON. Le champ `type` nomme le handler, `payload` contient ses champs. Les pages de référence listent chaque handler avec ses champs.";
|
|
6
|
+
readonly "overview.endpoints.heading": "Endpoints";
|
|
7
|
+
readonly "overview.endpoints.query": "Lit des données. Ne modifie jamais rien.";
|
|
8
|
+
readonly "overview.endpoints.write": "Modifie des données : créer, mettre à jour, supprimer ou une action précise.";
|
|
9
|
+
readonly "overview.endpoints.batch": "Exécute plusieurs appels d'écriture dans une transaction.";
|
|
10
|
+
readonly "overview.auth.heading": "Authentification";
|
|
11
|
+
readonly "overview.auth.body": "Envoie un jeton d'API dans l'en-tête `Authorization` sous la forme `Bearer <token>`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF. Le jeton fixe aussi le compte dans lequel la requête s'exécute, tu n'envoies donc jamais d'ID de compte ou de tenant.";
|
|
12
|
+
readonly "overview.body.heading": "Corps de la requête";
|
|
13
|
+
readonly "overview.body.body": "`type` est le nom du handler, par exemple `{exampleType}`. `payload` contient les champs de la référence. `requestId` est facultatif, voir plus bas. Le payload peut être imbriqué sur {maxDepth} niveaux au maximum.";
|
|
14
|
+
readonly "overview.responses.heading": "Réponses";
|
|
15
|
+
readonly "overview.responses.success": "Une lecture réussie renvoie `data`. Une écriture réussie renvoie `isSuccess: true` et `data`.";
|
|
16
|
+
readonly "overview.responses.error": "En cas d'échec, le statut HTTP est 4xx ou 5xx et le corps contient `error`. Les appels d'écriture renvoient aussi `isSuccess: false`. Appuie-toi sur `error.code` et le statut. `message` s'adresse aux personnes et peut changer.";
|
|
17
|
+
readonly "overview.errors.heading": "Codes d'erreur";
|
|
18
|
+
readonly "overview.errors.columns": "Code | Statut HTTP | Signification";
|
|
19
|
+
readonly "overview.versions.heading": "Versions et conflits";
|
|
20
|
+
readonly "overview.versions.body": "Chaque enregistrement a une `version`. Une mise à jour utilise la `version` que tu as lue en dernier. Si quelqu'un a modifié l'enregistrement entre-temps, l'appel échoue avec 409 `version_conflict`. Relis l'enregistrement, vérifie la modification et envoie-la avec la nouvelle version.";
|
|
21
|
+
readonly "overview.lists.heading": "Listes";
|
|
22
|
+
readonly "overview.lists.intro": "Les handlers de liste se terminent par `:list` et acceptent ces champs :";
|
|
23
|
+
readonly "overview.lists.columns": "Champ | Type | Description";
|
|
24
|
+
readonly "overview.lists.response": "La réponse contient `rows` et `nextCursor`. Pour la page suivante, envoie `nextCursor` comme `cursor`. Sur la dernière page, `nextCursor` vaut `null`.";
|
|
25
|
+
readonly "overview.batch.heading": "Lots";
|
|
26
|
+
readonly "overview.batch.body": "`POST /api/batch` prend `commands`, une liste d'appels d'écriture `{ type, payload }`. Ils s'exécutent dans une transaction : si l'un échoue, aucun n'a d'effet. La réponse contient alors `isSuccess: false`, l'`error` et `failedIndex`, la position de la commande en échec comptée à partir de 0.";
|
|
27
|
+
readonly "overview.retry.heading": "Réessayer sans risque";
|
|
28
|
+
readonly "overview.retry.body": "Envoie un `requestId` avec les appels d'écriture et de lot, une chaîne quelconque unique par modification. Si la connexion coupe et que tu renvoies le même appel avec le même `requestId`, tu reçois le premier résultat et la modification ne s'exécute pas deux fois.";
|
|
29
|
+
readonly "tokens.title": "Jetons d'API";
|
|
30
|
+
readonly "tokens.description": "Crée un jeton d'API pour {appName}, choisis ses scopes et envoie-le avec tes requêtes.";
|
|
31
|
+
readonly "tokens.intro": "Un jeton d'API permet à un script ou à un autre service d'appeler l'API de {appName} en ton nom. Ses scopes décident des données qu'il peut lire ou modifier.";
|
|
32
|
+
readonly "tokens.create.heading": "Créer un jeton";
|
|
33
|
+
readonly "tokens.create.step1": "Ouvre {menuPath}.";
|
|
34
|
+
readonly "tokens.create.step2": "Choisis **{createLabel}**.";
|
|
35
|
+
readonly "tokens.create.step3": "Saisis un nom, choisis les scopes et l'expiration, puis confirme avec ton mot de passe.";
|
|
36
|
+
readonly "tokens.create.step4": "Copie le jeton. Il commence par `kpat_` et n'est affiché qu'une seule fois.";
|
|
37
|
+
readonly "tokens.expiry": "Un jeton expire après {defaultDays} jours si tu ne choisis pas une autre expiration. L'expiration la plus longue possible est de {maxDays} jours.";
|
|
38
|
+
readonly "tokens.use.heading": "Utiliser le jeton";
|
|
39
|
+
readonly "tokens.use.body": "Envoie le jeton dans l'en-tête `Authorization`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF.";
|
|
40
|
+
readonly "tokens.scopes.heading": "Scopes";
|
|
41
|
+
readonly "tokens.scopes.intro": "Chaque scope a deux niveaux. `read` autorise les handlers de lecture. `write` autorise tout ce que `read` autorise, plus les handlers d'écriture.";
|
|
42
|
+
readonly "tokens.scopes.columns": "Scope | Droit | Handlers";
|
|
43
|
+
readonly "tokens.rateLimit.heading": "Limite de requêtes";
|
|
44
|
+
readonly "tokens.rateLimit": "Chaque jeton peut envoyer {max} requêtes par tranche de {windowSeconds} secondes. Au-delà, l'API répond 429 `pat_rate_limited`.";
|
|
45
|
+
readonly "tokens.errors.heading": "Erreurs";
|
|
46
|
+
readonly "tokens.errors.columns": "Statut HTTP | Code | Cause";
|
|
47
|
+
readonly "tokens.errors.missing": "L'en-tête `Authorization` est absent.";
|
|
48
|
+
readonly "tokens.errors.invalid": "Le jeton est inconnu, révoqué ou expiré.";
|
|
49
|
+
readonly "tokens.errors.scope": "Il manque au jeton le scope pour ce handler.";
|
|
50
|
+
readonly "tokens.errors.route": "L'endpoint n'accepte pas les jetons. Les jetons ne fonctionnent que sur les endpoints de l'API.";
|
|
51
|
+
readonly "tokens.errors.rate": "Trop de requêtes avec ce jeton.";
|
|
52
|
+
readonly "tokens.errors.disabled": "Les jetons d'API ne font pas partie de ton offre.";
|
|
53
|
+
readonly "tokens.revoke.heading": "Révoquer un jeton";
|
|
54
|
+
readonly "tokens.revoke.body": "Révoque un jeton dans {menuPath} dès que tu ne l'utilises plus. Changer ton mot de passe révoque tous tes jetons. Un jeton agit toujours avec tes rôles actuels. Si tu quittes le compte ou si ton utilisateur est supprimé, il cesse de fonctionner.";
|
|
55
|
+
readonly "tokens.security.heading": "Sécurité";
|
|
56
|
+
readonly "tokens.security.item1": "Traite un jeton comme un mot de passe. Garde-le dans un coffre à secrets, jamais dans le code, un dépôt, une app ou une page web, ni dans un log.";
|
|
57
|
+
readonly "tokens.security.item2": "Donne à chaque script son propre jeton, avec seulement les scopes dont il a besoin.";
|
|
58
|
+
readonly "tokens.security.item3": "Révoque les jetons que tu n'utilises plus. Révoque un jeton immédiatement s'il a pu fuiter.";
|
|
59
|
+
readonly "reference.description": "Référence de l'API pour {scopeLabel} : chaque handler avec ses champs et un exemple.";
|
|
60
|
+
readonly "reference.requiredScope": "Scope requis";
|
|
61
|
+
readonly "reference.endpoint": "Endpoint";
|
|
62
|
+
readonly "reference.fields.columns": "Champ | Type | Obligatoire | Description";
|
|
63
|
+
readonly "reference.yes": "oui";
|
|
64
|
+
readonly "reference.no": "non";
|
|
65
|
+
readonly "reference.noFields": "Ce handler ne prend aucun champ.";
|
|
66
|
+
readonly "reference.excluded": "Non modifiables via l'API : {fields}.";
|
|
67
|
+
readonly "reference.exampleRequest": "Exemple de requête";
|
|
68
|
+
readonly "reference.exampleResponse": "Exemple de réponse";
|
|
69
|
+
readonly "reference.status": "Statut : {status}";
|
|
70
|
+
readonly "events.title": "Événements webhook";
|
|
71
|
+
readonly "events.description": "Événements webhook : quand ils sont envoyés, quel scope ils exigent et ce que contient leur charge utile.";
|
|
72
|
+
readonly "events.intro": "Un événement webhook informe votre système qu'une chose a changé. Chaque événement a un nom, une version et une charge utile. Le scope indiqué pour un événement est le scope de jeton qui permet de s'y abonner.";
|
|
73
|
+
readonly "events.delivery.heading": "Livraison";
|
|
74
|
+
readonly "events.versions.heading": "Versions";
|
|
75
|
+
readonly "events.versions.body": "Ajouter un champ facultatif conserve la version. Un changement incompatible, comme la suppression ou le renommage d'un champ ou le changement de son type, reçoit une nouvelle version.";
|
|
76
|
+
readonly "events.list.heading": "Événements";
|
|
77
|
+
readonly "events.version": "Version";
|
|
78
|
+
readonly "events.requiredScope": "Scope requis";
|
|
79
|
+
readonly "events.example": "Exemple de charge utile";
|
|
80
|
+
readonly "events.noFields": "Cet événement ne contient aucun champ.";
|
|
81
|
+
readonly "events.entity.created": "Un enregistrement de type {entity} a été créé.";
|
|
82
|
+
readonly "events.entity.updated": "Un enregistrement de type {entity} a été modifié.";
|
|
83
|
+
readonly "events.entity.deleted": "Un enregistrement de type {entity} a été supprimé.";
|
|
84
|
+
};
|
|
85
|
+
readonly errorMeanings: {
|
|
86
|
+
readonly validation_error: "Le payload ne correspond pas aux champs du handler. `details` nomme les champs.";
|
|
87
|
+
readonly unauthenticated: "Aucun identifiant valide n'a été envoyé.";
|
|
88
|
+
readonly missing_token: "L'en-tête `Authorization` est absent.";
|
|
89
|
+
readonly invalid_token: "Le jeton est inconnu, révoqué ou expiré.";
|
|
90
|
+
readonly ambiguous_auth: "La requête contenait un cookie de session et un jeton. N'envoie que l'un des deux.";
|
|
91
|
+
readonly access_denied: "Il manque au jeton le scope pour ce handler, ou l'endpoint n'accepte pas les jetons.";
|
|
92
|
+
readonly feature_disabled: "Cette fonction est désactivée ou ne fait pas partie de ton offre.";
|
|
93
|
+
readonly not_found: "L'enregistrement n'existe pas ou tu ne peux pas le voir.";
|
|
94
|
+
readonly conflict: "La modification est en conflit avec l'état actuel des données.";
|
|
95
|
+
readonly version_conflict: "L'enregistrement a changé après ta lecture. Relis-le et réessaie avec la nouvelle `version`.";
|
|
96
|
+
readonly precondition_failed: "Un champ de l'enregistrement n'a plus la valeur attendue par la modification. Relis l'enregistrement et réessaie.";
|
|
97
|
+
readonly record_locked: "Une autre modification verrouille l'enregistrement. Réessaie dans un instant.";
|
|
98
|
+
readonly idempotent_replay: "Cette modification a déjà été appliquée avec la même clé d'idempotence. La première tentative a réussi, ne l'envoie donc pas de nouveau.";
|
|
99
|
+
readonly unique_violation: "Un enregistrement avec cette valeur existe déjà.";
|
|
100
|
+
readonly unprocessable: "Les données sont valides, mais une règle métier refuse la modification. `details.reason` nomme la règle.";
|
|
101
|
+
readonly unconfigured: "Un réglage nécessaire à cette fonction est encore vide. Configure-le d'abord dans l'app, puis réessaie.";
|
|
102
|
+
readonly internal_error: "Erreur serveur inattendue. Réessaie plus tard.";
|
|
103
|
+
readonly member_read_timeout: "Une lecture sur le serveur a pris trop de temps et a été interrompue. Réessaie plus tard.";
|
|
104
|
+
readonly rate_limited: "Trop de requêtes. Attends le nombre de secondes indiqué par l'en-tête `Retry-After`.";
|
|
105
|
+
readonly rate_limit_unavailable: "La limitation de débit est temporairement indisponible, la requête a été refusée. Réessaie dans un instant.";
|
|
106
|
+
readonly pat_rate_limited: "Ce jeton a envoyé trop de requêtes en peu de temps. Attends un instant et réessaie.";
|
|
107
|
+
};
|
|
108
|
+
readonly listParameters: {
|
|
109
|
+
readonly cursor: "Position issue de `nextCursor` de la page précédente.";
|
|
110
|
+
readonly limit: "Lignes par page, {default} par défaut, au maximum {max}.";
|
|
111
|
+
readonly search: "Recherche plein texte dans les champs interrogeables.";
|
|
112
|
+
readonly sort: "Champ servant au tri.";
|
|
113
|
+
readonly sortDirection: "`asc` ou `desc`.";
|
|
114
|
+
readonly offset: "Nombre de lignes à ignorer. Pour paginer, préfère `cursor`.";
|
|
115
|
+
readonly totalCount: "Avec `true`, tu reçois aussi `total`, le nombre de lignes correspondantes.";
|
|
116
|
+
readonly includeDeleted: "Avec `true`, les lignes supprimées sont incluses. Uniquement pour les entités avec suppression logique.";
|
|
117
|
+
readonly onlyDeleted: "Avec `true`, seules les lignes supprimées sont renvoyées. Uniquement pour les entités avec suppression logique, pas avec `includeDeleted`.";
|
|
118
|
+
readonly filter: "Un filtre de champ avec `field`, `op` et `value`. `op` est l'un de {ops}.";
|
|
119
|
+
readonly filters: "Plusieurs filtres de champ, chacun avec `field`, `op` et `value`. `op` est l'un de {ops}.";
|
|
120
|
+
readonly namedFilter: "Nom d'un filtre prédéfini de l'entité, par exemple une file de travail.";
|
|
121
|
+
readonly aggregate: "Renvoie des valeurs agrégées au lieu de lignes.";
|
|
122
|
+
};
|
|
123
|
+
};
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
export const frApiDocsTexts = {
|
|
2
|
+
text: {
|
|
3
|
+
"overview.title": "API HTTP",
|
|
4
|
+
"overview.description": "Endpoints, corps de la requête, réponses, codes d'erreur, listes et lots de l'API HTTP.",
|
|
5
|
+
"overview.intro": "Chaque appel est un POST avec un corps JSON. Le champ `type` nomme le handler, `payload` contient ses champs. Les pages de référence listent chaque handler avec ses champs.",
|
|
6
|
+
"overview.endpoints.heading": "Endpoints",
|
|
7
|
+
"overview.endpoints.query": "Lit des données. Ne modifie jamais rien.",
|
|
8
|
+
"overview.endpoints.write": "Modifie des données : créer, mettre à jour, supprimer ou une action précise.",
|
|
9
|
+
"overview.endpoints.batch": "Exécute plusieurs appels d'écriture dans une transaction.",
|
|
10
|
+
"overview.auth.heading": "Authentification",
|
|
11
|
+
"overview.auth.body": "Envoie un jeton d'API dans l'en-tête `Authorization` sous la forme `Bearer <token>`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF. Le jeton fixe aussi le compte dans lequel la requête s'exécute, tu n'envoies donc jamais d'ID de compte ou de tenant.",
|
|
12
|
+
"overview.body.heading": "Corps de la requête",
|
|
13
|
+
"overview.body.body": "`type` est le nom du handler, par exemple `{exampleType}`. `payload` contient les champs de la référence. `requestId` est facultatif, voir plus bas. Le payload peut être imbriqué sur {maxDepth} niveaux au maximum.",
|
|
14
|
+
"overview.responses.heading": "Réponses",
|
|
15
|
+
"overview.responses.success": "Une lecture réussie renvoie `data`. Une écriture réussie renvoie `isSuccess: true` et `data`.",
|
|
16
|
+
"overview.responses.error": "En cas d'échec, le statut HTTP est 4xx ou 5xx et le corps contient `error`. Les appels d'écriture renvoient aussi `isSuccess: false`. Appuie-toi sur `error.code` et le statut. `message` s'adresse aux personnes et peut changer.",
|
|
17
|
+
"overview.errors.heading": "Codes d'erreur",
|
|
18
|
+
"overview.errors.columns": "Code | Statut HTTP | Signification",
|
|
19
|
+
"overview.versions.heading": "Versions et conflits",
|
|
20
|
+
"overview.versions.body": "Chaque enregistrement a une `version`. Une mise à jour utilise la `version` que tu as lue en dernier. Si quelqu'un a modifié l'enregistrement entre-temps, l'appel échoue avec 409 `version_conflict`. Relis l'enregistrement, vérifie la modification et envoie-la avec la nouvelle version.",
|
|
21
|
+
"overview.lists.heading": "Listes",
|
|
22
|
+
"overview.lists.intro": "Les handlers de liste se terminent par `:list` et acceptent ces champs :",
|
|
23
|
+
"overview.lists.columns": "Champ | Type | Description",
|
|
24
|
+
"overview.lists.response": "La réponse contient `rows` et `nextCursor`. Pour la page suivante, envoie `nextCursor` comme `cursor`. Sur la dernière page, `nextCursor` vaut `null`.",
|
|
25
|
+
"overview.batch.heading": "Lots",
|
|
26
|
+
"overview.batch.body": "`POST /api/batch` prend `commands`, une liste d'appels d'écriture `{ type, payload }`. Ils s'exécutent dans une transaction : si l'un échoue, aucun n'a d'effet. La réponse contient alors `isSuccess: false`, l'`error` et `failedIndex`, la position de la commande en échec comptée à partir de 0.",
|
|
27
|
+
"overview.retry.heading": "Réessayer sans risque",
|
|
28
|
+
"overview.retry.body": "Envoie un `requestId` avec les appels d'écriture et de lot, une chaîne quelconque unique par modification. Si la connexion coupe et que tu renvoies le même appel avec le même `requestId`, tu reçois le premier résultat et la modification ne s'exécute pas deux fois.",
|
|
29
|
+
"tokens.title": "Jetons d'API",
|
|
30
|
+
"tokens.description": "Crée un jeton d'API pour {appName}, choisis ses scopes et envoie-le avec tes requêtes.",
|
|
31
|
+
"tokens.intro": "Un jeton d'API permet à un script ou à un autre service d'appeler l'API de {appName} en ton nom. Ses scopes décident des données qu'il peut lire ou modifier.",
|
|
32
|
+
"tokens.create.heading": "Créer un jeton",
|
|
33
|
+
"tokens.create.step1": "Ouvre {menuPath}.",
|
|
34
|
+
"tokens.create.step2": "Choisis **{createLabel}**.",
|
|
35
|
+
"tokens.create.step3": "Saisis un nom, choisis les scopes et l'expiration, puis confirme avec ton mot de passe.",
|
|
36
|
+
"tokens.create.step4": "Copie le jeton. Il commence par `kpat_` et n'est affiché qu'une seule fois.",
|
|
37
|
+
"tokens.expiry": "Un jeton expire après {defaultDays} jours si tu ne choisis pas une autre expiration. L'expiration la plus longue possible est de {maxDays} jours.",
|
|
38
|
+
"tokens.use.heading": "Utiliser le jeton",
|
|
39
|
+
"tokens.use.body": "Envoie le jeton dans l'en-tête `Authorization`. Les requêtes avec jeton n'ont besoin ni de cookie ni de jeton CSRF.",
|
|
40
|
+
"tokens.scopes.heading": "Scopes",
|
|
41
|
+
"tokens.scopes.intro": "Chaque scope a deux niveaux. `read` autorise les handlers de lecture. `write` autorise tout ce que `read` autorise, plus les handlers d'écriture.",
|
|
42
|
+
"tokens.scopes.columns": "Scope | Droit | Handlers",
|
|
43
|
+
"tokens.rateLimit.heading": "Limite de requêtes",
|
|
44
|
+
"tokens.rateLimit": "Chaque jeton peut envoyer {max} requêtes par tranche de {windowSeconds} secondes. Au-delà, l'API répond 429 `pat_rate_limited`.",
|
|
45
|
+
"tokens.errors.heading": "Erreurs",
|
|
46
|
+
"tokens.errors.columns": "Statut HTTP | Code | Cause",
|
|
47
|
+
"tokens.errors.missing": "L'en-tête `Authorization` est absent.",
|
|
48
|
+
"tokens.errors.invalid": "Le jeton est inconnu, révoqué ou expiré.",
|
|
49
|
+
"tokens.errors.scope": "Il manque au jeton le scope pour ce handler.",
|
|
50
|
+
"tokens.errors.route": "L'endpoint n'accepte pas les jetons. Les jetons ne fonctionnent que sur les endpoints de l'API.",
|
|
51
|
+
"tokens.errors.rate": "Trop de requêtes avec ce jeton.",
|
|
52
|
+
"tokens.errors.disabled": "Les jetons d'API ne font pas partie de ton offre.",
|
|
53
|
+
"tokens.revoke.heading": "Révoquer un jeton",
|
|
54
|
+
"tokens.revoke.body": "Révoque un jeton dans {menuPath} dès que tu ne l'utilises plus. Changer ton mot de passe révoque tous tes jetons. Un jeton agit toujours avec tes rôles actuels. Si tu quittes le compte ou si ton utilisateur est supprimé, il cesse de fonctionner.",
|
|
55
|
+
"tokens.security.heading": "Sécurité",
|
|
56
|
+
"tokens.security.item1": "Traite un jeton comme un mot de passe. Garde-le dans un coffre à secrets, jamais dans le code, un dépôt, une app ou une page web, ni dans un log.",
|
|
57
|
+
"tokens.security.item2": "Donne à chaque script son propre jeton, avec seulement les scopes dont il a besoin.",
|
|
58
|
+
"tokens.security.item3": "Révoque les jetons que tu n'utilises plus. Révoque un jeton immédiatement s'il a pu fuiter.",
|
|
59
|
+
"reference.description": "Référence de l'API pour {scopeLabel} : chaque handler avec ses champs et un exemple.",
|
|
60
|
+
"reference.requiredScope": "Scope requis",
|
|
61
|
+
"reference.endpoint": "Endpoint",
|
|
62
|
+
"reference.fields.columns": "Champ | Type | Obligatoire | Description",
|
|
63
|
+
"reference.yes": "oui",
|
|
64
|
+
"reference.no": "non",
|
|
65
|
+
"reference.noFields": "Ce handler ne prend aucun champ.",
|
|
66
|
+
"reference.excluded": "Non modifiables via l'API : {fields}.",
|
|
67
|
+
"reference.exampleRequest": "Exemple de requête",
|
|
68
|
+
"reference.exampleResponse": "Exemple de réponse",
|
|
69
|
+
"reference.status": "Statut : {status}",
|
|
70
|
+
"events.title": "Événements webhook",
|
|
71
|
+
"events.description": "Événements webhook : quand ils sont envoyés, quel scope ils exigent et ce que contient leur charge utile.",
|
|
72
|
+
"events.intro": "Un événement webhook informe votre système qu'une chose a changé. Chaque événement a un nom, une version et une charge utile. Le scope indiqué pour un événement est le scope de jeton qui permet de s'y abonner.",
|
|
73
|
+
"events.delivery.heading": "Livraison",
|
|
74
|
+
"events.versions.heading": "Versions",
|
|
75
|
+
"events.versions.body": "Ajouter un champ facultatif conserve la version. Un changement incompatible, comme la suppression ou le renommage d'un champ ou le changement de son type, reçoit une nouvelle version.",
|
|
76
|
+
"events.list.heading": "Événements",
|
|
77
|
+
"events.version": "Version",
|
|
78
|
+
"events.requiredScope": "Scope requis",
|
|
79
|
+
"events.example": "Exemple de charge utile",
|
|
80
|
+
"events.noFields": "Cet événement ne contient aucun champ.",
|
|
81
|
+
"events.entity.created": "Un enregistrement de type {entity} a été créé.",
|
|
82
|
+
"events.entity.updated": "Un enregistrement de type {entity} a été modifié.",
|
|
83
|
+
"events.entity.deleted": "Un enregistrement de type {entity} a été supprimé.",
|
|
84
|
+
},
|
|
85
|
+
errorMeanings: {
|
|
86
|
+
validation_error: "Le payload ne correspond pas aux champs du handler. `details` nomme les champs.",
|
|
87
|
+
unauthenticated: "Aucun identifiant valide n'a été envoyé.",
|
|
88
|
+
missing_token: "L'en-tête `Authorization` est absent.",
|
|
89
|
+
invalid_token: "Le jeton est inconnu, révoqué ou expiré.",
|
|
90
|
+
ambiguous_auth: "La requête contenait un cookie de session et un jeton. N'envoie que l'un des deux.",
|
|
91
|
+
access_denied: "Il manque au jeton le scope pour ce handler, ou l'endpoint n'accepte pas les jetons.",
|
|
92
|
+
feature_disabled: "Cette fonction est désactivée ou ne fait pas partie de ton offre.",
|
|
93
|
+
not_found: "L'enregistrement n'existe pas ou tu ne peux pas le voir.",
|
|
94
|
+
conflict: "La modification est en conflit avec l'état actuel des données.",
|
|
95
|
+
version_conflict: "L'enregistrement a changé après ta lecture. Relis-le et réessaie avec la nouvelle `version`.",
|
|
96
|
+
precondition_failed: "Un champ de l'enregistrement n'a plus la valeur attendue par la modification. Relis l'enregistrement et réessaie.",
|
|
97
|
+
record_locked: "Une autre modification verrouille l'enregistrement. Réessaie dans un instant.",
|
|
98
|
+
idempotent_replay: "Cette modification a déjà été appliquée avec la même clé d'idempotence. La première tentative a réussi, ne l'envoie donc pas de nouveau.",
|
|
99
|
+
unique_violation: "Un enregistrement avec cette valeur existe déjà.",
|
|
100
|
+
unprocessable: "Les données sont valides, mais une règle métier refuse la modification. `details.reason` nomme la règle.",
|
|
101
|
+
unconfigured: "Un réglage nécessaire à cette fonction est encore vide. Configure-le d'abord dans l'app, puis réessaie.",
|
|
102
|
+
internal_error: "Erreur serveur inattendue. Réessaie plus tard.",
|
|
103
|
+
member_read_timeout: "Une lecture sur le serveur a pris trop de temps et a été interrompue. Réessaie plus tard.",
|
|
104
|
+
rate_limited: "Trop de requêtes. Attends le nombre de secondes indiqué par l'en-tête `Retry-After`.",
|
|
105
|
+
rate_limit_unavailable: "La limitation de débit est temporairement indisponible, la requête a été refusée. Réessaie dans un instant.",
|
|
106
|
+
pat_rate_limited: "Ce jeton a envoyé trop de requêtes en peu de temps. Attends un instant et réessaie.",
|
|
107
|
+
},
|
|
108
|
+
listParameters: {
|
|
109
|
+
cursor: "Position issue de `nextCursor` de la page précédente.",
|
|
110
|
+
limit: "Lignes par page, {default} par défaut, au maximum {max}.",
|
|
111
|
+
search: "Recherche plein texte dans les champs interrogeables.",
|
|
112
|
+
sort: "Champ servant au tri.",
|
|
113
|
+
sortDirection: "`asc` ou `desc`.",
|
|
114
|
+
offset: "Nombre de lignes à ignorer. Pour paginer, préfère `cursor`.",
|
|
115
|
+
totalCount: "Avec `true`, tu reçois aussi `total`, le nombre de lignes correspondantes.",
|
|
116
|
+
includeDeleted: "Avec `true`, les lignes supprimées sont incluses. Uniquement pour les entités avec suppression logique.",
|
|
117
|
+
onlyDeleted: "Avec `true`, seules les lignes supprimées sont renvoyées. Uniquement pour les entités avec suppression logique, pas avec `includeDeleted`.",
|
|
118
|
+
filter: "Un filtre de champ avec `field`, `op` et `value`. `op` est l'un de {ops}.",
|
|
119
|
+
filters: "Plusieurs filtres de champ, chacun avec `field`, `op` et `value`. `op` est l'un de {ops}.",
|
|
120
|
+
namedFilter: "Nom d'un filtre prédéfini de l'entité, par exemple une file de travail.",
|
|
121
|
+
aggregate: "Renvoie des valeurs agrégées au lieu de lignes.",
|
|
122
|
+
},
|
|
123
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { ApiDocsProblem } from "../problems.ts";
|
|
2
|
+
import { type ApiDocsTexts } from "./types.ts";
|
|
3
|
+
export declare const apiDocsLocales: readonly ["en", "de", "es", "fr", "it"];
|
|
4
|
+
export type ApiDocsLocale = (typeof apiDocsLocales)[number];
|
|
5
|
+
export declare function isApiDocsLocale(value: string): value is ApiDocsLocale;
|
|
6
|
+
export declare function apiDocsTextsFor(locale: ApiDocsLocale): ApiDocsTexts;
|
|
7
|
+
/** Applies the app's paragraph overrides. A bad override is reported and skipped,
|
|
8
|
+
* never half applied, so the page keeps its shipped wording. */
|
|
9
|
+
export declare function resolveApiDocsTexts(locale: ApiDocsLocale, overrides: Readonly<Record<string, string>> | undefined): {
|
|
10
|
+
readonly texts: ApiDocsTexts;
|
|
11
|
+
readonly problems: readonly ApiDocsProblem[];
|
|
12
|
+
};
|
|
13
|
+
export type { ApiDocsTextKey, ApiDocsTexts, DocumentedErrorCode } from "./types.ts";
|
|
14
|
+
export { formatApiDocsText } from "./types.ts";
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { isOneOf } from "@cosmicdrift/kumiko-types/type-guards";
|
|
2
|
+
import { deApiDocsTexts } from "./de.js";
|
|
3
|
+
import { enApiDocsTexts } from "./en.js";
|
|
4
|
+
import { esApiDocsTexts } from "./es.js";
|
|
5
|
+
import { frApiDocsTexts } from "./fr.js";
|
|
6
|
+
import { itApiDocsTexts } from "./it.js";
|
|
7
|
+
import { isParagraphTextKey, placeholdersOf } from "./types.js";
|
|
8
|
+
export const apiDocsLocales = ["en", "de", "es", "fr", "it"];
|
|
9
|
+
export function isApiDocsLocale(value) {
|
|
10
|
+
return isOneOf(apiDocsLocales, value);
|
|
11
|
+
}
|
|
12
|
+
const textsByLocale = {
|
|
13
|
+
en: enApiDocsTexts,
|
|
14
|
+
de: deApiDocsTexts,
|
|
15
|
+
es: esApiDocsTexts,
|
|
16
|
+
fr: frApiDocsTexts,
|
|
17
|
+
it: itApiDocsTexts,
|
|
18
|
+
};
|
|
19
|
+
export function apiDocsTextsFor(locale) {
|
|
20
|
+
return textsByLocale[locale];
|
|
21
|
+
}
|
|
22
|
+
/** Applies the app's paragraph overrides. A bad override is reported and skipped,
|
|
23
|
+
* never half applied, so the page keeps its shipped wording. */
|
|
24
|
+
export function resolveApiDocsTexts(locale, overrides) {
|
|
25
|
+
const base = textsByLocale[locale];
|
|
26
|
+
if (overrides === undefined)
|
|
27
|
+
return { texts: base, problems: [] };
|
|
28
|
+
const problems = [];
|
|
29
|
+
const text = { ...base.text };
|
|
30
|
+
for (const [key, value] of Object.entries(overrides)) {
|
|
31
|
+
if (!isParagraphTextKey(key)) {
|
|
32
|
+
problems.push({
|
|
33
|
+
kind: "invalidTextOverride",
|
|
34
|
+
locale,
|
|
35
|
+
key,
|
|
36
|
+
cause: "Not an overridable paragraph key.",
|
|
37
|
+
});
|
|
38
|
+
continue;
|
|
39
|
+
}
|
|
40
|
+
const allowed = placeholdersOf(base.text[key]);
|
|
41
|
+
const unknown = [...placeholdersOf(value)].filter((name) => !allowed.has(name));
|
|
42
|
+
if (unknown.length > 0) {
|
|
43
|
+
problems.push({
|
|
44
|
+
kind: "invalidTextOverride",
|
|
45
|
+
locale,
|
|
46
|
+
key,
|
|
47
|
+
cause: `Unknown placeholders: ${unknown.map((name) => `{${name}}`).join(", ")}. Allowed: ${[...allowed].map((name) => `{${name}}`).join(", ") || "none"}.`,
|
|
48
|
+
});
|
|
49
|
+
continue;
|
|
50
|
+
}
|
|
51
|
+
text[key] = value;
|
|
52
|
+
}
|
|
53
|
+
return { texts: { ...base, text }, problems };
|
|
54
|
+
}
|
|
55
|
+
export { formatApiDocsText } from "./types.js";
|