Constructor del portal
El constructor del portal del workspace: el borrador, las versiones publicadas y el tema. list devuelve el estado completo (incluida la revision que protege el guardado), draft update reemplaza todo el borrador y publish create lo pone en el aire como una versión nueva. Los comandos tools editan el borrador por partes — una página, un bloque, un campo — y son los mismos que usa el chat con IA del constructor.
Borrador, publicación y tema
| Comando | HTTP | Descripción |
|---|---|---|
builder list | GET /v1/builder | Consultar el constructor del portal |
builder draft update | PUT /v1/builder/draft | Guardar el borrador del portal |
builder og-image create | POST /v1/builder/og_image | Subir una imagen og:image |
builder publish create | POST /v1/builder/publish | Publicar el portal |
builder secrets create | POST /v1/builder/secrets | Cifrar un secreto de bloque |
builder theme update | PATCH /v1/builder/theme | Modificar los colores del tema del portal |
Pruebas en el borrador
Ejecutan de verdad la acción de un Botón de acción o de un Formulario del borrador, marcada como preview: true.
| Comando | HTTP | Descripción |
|---|---|---|
builder action-runs create | POST /v1/builder/action_runs | Probar un botón de acción del borrador |
builder form-submissions create | POST /v1/builder/form_submissions | Probar un formulario del borrador |
Versiones
versions restore copia una versión al borrador sin tocar lo que está en el aire; versions rollback vuelve a poner la versión en el aire en el acto.
| Comando | HTTP | Descripción |
|---|---|---|
builder versions get | GET /v1/builder/versions/{number} | Consultar una versión publicada |
builder versions restore | POST /v1/builder/versions/{number}/restore | Restaurar una versión en el borrador |
builder versions rollback | POST /v1/builder/versions/{number}/rollback | Volver a poner una versión en el aire |
Herramientas — páginas
| Comando | HTTP | Descripción |
|---|---|---|
builder tools create-page create | POST /v1/builder/tools/create_page | Crear una página |
builder tools delete-page create | POST /v1/builder/tools/delete_page | Eliminar una página |
builder tools get-page list | GET /v1/builder/tools/get_page | Consultar una página del borrador |
builder tools list-pages list | GET /v1/builder/tools/list_pages | Listar las páginas del borrador |
builder tools move-page create | POST /v1/builder/tools/move_page | Mover una página en el menú |
builder tools update-page create | POST /v1/builder/tools/update_page | Modificar una página |
Herramientas — bloques
| Comando | HTTP | Descripción |
|---|---|---|
builder tools describe-block-type list | GET /v1/builder/tools/describe_block_type | Describir un tipo de bloque |
builder tools duplicate-block create | POST /v1/builder/tools/duplicate_block | Duplicar un bloque |
builder tools insert-block create | POST /v1/builder/tools/insert_block | Insertar un bloque |
builder tools list-actions list | GET /v1/builder/tools/list_actions | Listar las acciones del botón |
builder tools list-block-types list | GET /v1/builder/tools/list_block_types | Listar los tipos de bloque |
builder tools move-block create | POST /v1/builder/tools/move_block | Mover un bloque |
builder tools remove-block create | POST /v1/builder/tools/remove_block | Quitar un bloque |
builder tools update-block create | POST /v1/builder/tools/update_block | Modificar un bloque |
Herramientas — tema, archivos y entidades
| Comando | HTTP | Descripción |
|---|---|---|
builder tools get-theme list | GET /v1/builder/tools/get_theme | Consultar los colores del tema |
builder tools preview-portal-user-mapping list | GET /v1/builder/tools/preview_portal_user_mapping | Previsualizar el mapeo de usuarios del portal |
builder tools read-asset list | GET /v1/builder/tools/read_asset | Leer el contenido de un archivo |
builder tools register-entity create | POST /v1/builder/tools/register_entity | Registrar una entidad desde una fuente de datos |
builder tools rename-entity-fields create | POST /v1/builder/tools/rename_entity_fields | Renombrar los campos de una entidad |
builder tools save-computed-field create | POST /v1/builder/tools/save_computed_field | Guardar un campo calculado |
Ejemplos
--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.
# Consultar el constructor del portal
kobana dashboards builder list --fields "draft,live_version,versions"
# Listar las páginas del borrador
kobana dashboards builder tools list-pages list
# Crear una página
kobana dashboards builder tools create-page create \
--json '{"name": "Faturas", "template": "list", "entity": "faturas"}'
# Insertar un bloque
kobana dashboards builder tools insert-block create \
--json '{"page_id": "PAGE_ID", "type": "Text", "props": {"text": "Bem-vindo!"}}'
# Publicar el portal
kobana dashboards builder publish create \
--json '{"revision": 12, "pages": [], "note": "Nova página de faturas"}' \
--dry-run
# Volver a poner una versión en el aire
kobana dashboards builder versions rollback --params '{"number": 3}' --dry-run
Próximos pasos
- Configuración del portal
- Entidades
- Introspección de schema — todos los parámetros que acepta este recurso.