Construtor do portal

O construtor do portal do workspace: o rascunho, as versões publicadas e o tema. list devolve o estado completo (inclusive a revision que protege o salvamento), draft update substitui o rascunho inteiro e publish create o coloca no ar como nova versão. Os comandos tools editam o rascunho aos poucos — uma página, um bloco, um campo — e são os mesmos que o chat com IA do construtor usa.

Rascunho, publicação e tema

Comando	HTTP	Descrição
builder list	GET /v1/builder	Consultar o construtor do portal
builder draft update	PUT /v1/builder/draft	Salvar o rascunho do portal
builder og-image create	POST /v1/builder/og_image	Enviar uma imagem og:image
builder publish create	POST /v1/builder/publish	Publicar o portal
builder secrets create	POST /v1/builder/secrets	Criptografar um segredo de bloco
builder theme update	PATCH /v1/builder/theme	Alterar as cores do tema do portal

Testes no rascunho

Executam de verdade a ação de um Botão de ação ou de um Formulário do rascunho, marcada como preview: true.

Comando	HTTP	Descrição
builder action-runs create	POST /v1/builder/action_runs	Testar um botão de ação do rascunho
builder form-submissions create	POST /v1/builder/form_submissions	Testar um formulário do rascunho

Versões

versions restore copia uma versão para o rascunho, sem mexer no que está no ar; versions rollback coloca a versão de volta no ar na hora.

Comando	HTTP	Descrição
builder versions get	GET /v1/builder/versions/{number}	Consultar uma versão publicada
builder versions restore	POST /v1/builder/versions/{number}/restore	Restaurar uma versão no rascunho
builder versions rollback	POST /v1/builder/versions/{number}/rollback	Colocar uma versão de volta no ar

Ferramentas — páginas

Comando	HTTP	Descrição
builder tools create-page create	POST /v1/builder/tools/create_page	Criar uma página
builder tools delete-page create	POST /v1/builder/tools/delete_page	Excluir uma página
builder tools get-page list	GET /v1/builder/tools/get_page	Consultar uma página do rascunho
builder tools list-pages list	GET /v1/builder/tools/list_pages	Listar as páginas do rascunho
builder tools move-page create	POST /v1/builder/tools/move_page	Mover uma página no menu
builder tools update-page create	POST /v1/builder/tools/update_page	Alterar uma página

Ferramentas — blocos

Comando	HTTP	Descrição
builder tools describe-block-type list	GET /v1/builder/tools/describe_block_type	Descrever um tipo de bloco
builder tools duplicate-block create	POST /v1/builder/tools/duplicate_block	Duplicar um bloco
builder tools insert-block create	POST /v1/builder/tools/insert_block	Inserir um bloco
builder tools list-actions list	GET /v1/builder/tools/list_actions	Listar as ações do botão
builder tools list-block-types list	GET /v1/builder/tools/list_block_types	Listar os tipos de bloco
builder tools move-block create	POST /v1/builder/tools/move_block	Mover um bloco
builder tools remove-block create	POST /v1/builder/tools/remove_block	Remover um bloco
builder tools update-block create	POST /v1/builder/tools/update_block	Alterar um bloco

Ferramentas — tema, arquivos e entidades

Comando	HTTP	Descrição
builder tools get-theme list	GET /v1/builder/tools/get_theme	Consultar as cores do tema
builder tools preview-portal-user-mapping list	GET /v1/builder/tools/preview_portal_user_mapping	Pré-visualizar o mapeamento de usuários do portal
builder tools read-asset list	GET /v1/builder/tools/read_asset	Ler o conteúdo de um arquivo
builder tools register-entity create	POST /v1/builder/tools/register_entity	Registrar uma entidade a partir de uma fonte de dados
builder tools rename-entity-fields create	POST /v1/builder/tools/rename_entity_fields	Renomear os campos de uma entidade
builder tools save-computed-field create	POST /v1/builder/tools/save_computed_field	Salvar um campo calculado

Exemplos

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Consultar o construtor do portal
kobana dashboards builder list --fields "draft,live_version,versions"

# Listar as páginas do rascunho
kobana dashboards builder tools list-pages list

# Criar uma página
kobana dashboards builder tools create-page create \
  --json '{"name": "Faturas", "template": "list", "entity": "faturas"}'

# Inserir um bloco
kobana dashboards builder tools insert-block create \
  --json '{"page_id": "PAGE_ID", "type": "Text", "props": {"text": "Bem-vindo!"}}'

# Publicar o portal
kobana dashboards builder publish create \
  --json '{"revision": 12, "pages": [], "note": "Nova página de faturas"}' \
  --dry-run

# Colocar uma versão de volta no ar
kobana dashboards builder versions rollback --params '{"number": 3}' --dry-run

Próximos passos

• Configurações do portal
• Entidades
• Introspecção de schema — todos os parâmetros que este recurso aceita.