Catálogo de operações de edição

Todas as operações do lote de edição de páginas, com os campos que cada uma lê.

Esta página é gerada a partir do mesmo contrato que POST /sites/projects/{id}/edits aplica, então traz exatamente as operações e os campos que a API aceita hoje. Para entender os arquivos, os nodes e o lote, leia antes o guia Páginas.

Cada operação é um objeto JSON com op e os campos da operação. Um campo que a operação não lê é descartado e volta em ignored na resposta, com o índice da operação; ele não recusa o lote.

Índice

OperaçãoFamíliaCampos
write_fileCódigopath, rev, content
edit_fileCódigopath, old, new, replace_all
delete_fileCódigopath, rev
rename_fileCódigopath, rev, to
set_textVisuaisnode, rev, text, html, item
set_attrVisuaisnode, rev, name, value
set_classesVisuaisnode, rev, add, remove, breakpoint
replace_imageVisuaisnode, rev, media_id, alt
moveVisuaisnode, rev, before, after, into
duplicateVisuaisnode, rev, ref
removeVisuaisnode, rev
insert_sectionVisuaisat, rev, html, library_key, ref, source, source_rev
set_tokenTemaname, value
set_knobTemaname, value
define_knobAtalhosname, variable, kind, min, max, step, unit
rename_knobAtalhosname, to
remove_knobAtalhosname
set_whatsapp_linkAtalhosnode, rev, number_ref, text
clear_whatsapp_linkAtalhosnode, rev
insert_elementAtalhosat, rev, element, key, ref
set_form_fieldAtalhosnode, rev, field, input, required
insert_form_fieldAtalhosat, rev, field, input, text, required, ref
set_form_optionAtalhosnode, rev, text
insert_form_optionAtalhosat, rev, text, ref

Código

Mexem nos arquivos inteiros ou em trechos de texto deles.

write_file

Cria um arquivo ou substitui o conteúdo inteiro de um arquivo existente. Num arquivo existente, rev é obrigatório e precisa ser o rev atual (file_stale quando o arquivo mudou depois da leitura). Um conteúdo que traz um marcador de omissão novo, como uma linha ... ou um comentário dizendo que o resto não mudou, é recusado com edit_placeholder.

Campos: path, rev, content.

edit_file

Troca o trecho old por new num arquivo existente. old precisa aparecer exatamente uma vez (edit_not_found, edit_ambiguous), a menos que replace_all seja verdadeiro; new igual a old responde edit_noop.

Campos: path, old, new, replace_all.

delete_file

Exclui um arquivo, com o rev atual. Os arquivos obrigatórios da tecnologia não podem ser excluídos (file_required).

Campos: path, rev.

rename_file

Renomeia um arquivo para to, com o rev atual. O caminho novo precisa caber nas pastas da tecnologia e estar livre (path_exists, inclusive quando só a caixa das letras muda). Os arquivos obrigatórios não são renomeados.

Campos: path, rev, to.

Visuais

Mexem num elemento da página, apontado por node.

set_text

Troca o texto de um elemento. text usa a marcação inline (um só parágrafo) e html aceita o subconjunto do editor (b, strong, i, em, u, a, br); mande um dos dois. item escolhe o item de uma lista repetida.

Campos: node, rev, text, html, item.

set_attr

Grava o atributo name com value; sem value, o atributo sai. Não mudam por aqui eventos (on...), class, srcdoc e os atributos internos da plataforma (attribute_forbidden); links perigosos, campos de senha ou de cartão e formulários que enviam para fora também são recusados.

Campos: node, rev, name, value.

set_classes

Acrescenta (add) e tira (remove) classes de um elemento. Com breakpoint, as classes valem só a partir daquela largura e não podem trazer prefixo próprio.

Campos: node, rev, add, remove, breakpoint.

replace_image

Troca a imagem de um elemento por uma imagem da biblioteca de mídia do workspace (media_id), com texto alternativo opcional.

Campos: node, rev, media_id, alt.

move

Move um elemento para logo antes (before), logo depois (after) ou para o fim (into) de outro elemento do mesmo arquivo. Use exatamente um dos três.

Campos: node, rev, before, after, into.

duplicate

Duplica um elemento logo depois dele. ref dá um nome à cópia para as operações seguintes do lote.

Campos: node, rev, ref.

remove

Remove um elemento.

Campos: node, rev.

insert_section

Insere uma seção na posição de at. O conteúdo vem de html, de uma seção da biblioteca (library_key, listada em GET /sites/sections) ou da cópia de um elemento existente (source com source_rev), um só por operação.

Campos: at, rev, html, library_key, ref, source, source_rev.

Tema

Mudam um token de cor ou de medida do tema ou o valor de um knob.

set_token

Grava o valor de um token do tema, uma variável CSS como --cor-primaria. O valor vai até 200 caracteres, sem ;, chaves, url( nem comentários.

Campos: name, value.

set_knob

Muda o valor de um knob declarado em knobs.json: um número dentro de min e max num knob range, ou uma cor num knob color.

Campos: name, value.

Atalhos

São expandidos no servidor em operações das outras famílias, sempre escritas pela plataforma.

define_knob

Declara um knob novo em knobs.json, ligado a uma variável CSS. Um knob range precisa de min menor que max e step positivo; um knob color não leva min, max, step nem unit.

Campos: name, variable, kind, min, max, step, unit.

rename_knob

Renomeia um knob para to.

Campos: name, to.

remove_knob

Remove um knob de knobs.json.

Campos: name.

set_whatsapp_link

Transforma um elemento num link de WhatsApp para um número do workspace (number_ref), com uma mensagem pronta de até 500 caracteres. Número fora do workspace responde whatsapp_number_unknown.

Campos: node, rev, number_ref, text.

clear_whatsapp_link

Desfaz o link de WhatsApp de um elemento.

Campos: node, rev.

insert_element

Insere um bloco da plataforma, escrito pelo servidor: element webchat com a chave pública ou o id de um chat do site do workspace, ou booking com o id de um bloco de agendamento das configurações.

Campos: at, rev, element, key, ref.

set_form_field

Liga um campo de formulário existente a um campo do lead (field) com o tipo input, gravando o nome, o tipo e a obrigatoriedade. GET /sites/forms/targets lista os campos e os tipos aceitos.

Campos: node, rev, field, input, required.

insert_form_field

Insere um campo de formulário novo, escrito pelo servidor, ligado a um campo do lead, com rótulo (text) de até 120 caracteres.

Campos: at, rev, field, input, text, required, ref.

set_form_option

Troca o texto de uma opção de um campo de seleção e o valor que vai para o lead, juntos, com text de até 120 caracteres.

Campos: node, rev, text.

insert_form_option

Insere uma opção nova, escrita pelo servidor, num campo de seleção (at com into no select), com text de até 120 caracteres como texto e valor.

Campos: at, rev, text, ref.

Campos

CampoSignificado
addClasses a acrescentar.
afterElemento que fica logo antes do movido.
altTexto alternativo da imagem.
atOnde inserir: um objeto com exatamente um entre before, after, into (um node) e page (um arquivo de página, no fim do conteúdo).
beforeElemento que fica logo depois do movido.
breakpointsm, md, lg ou xl.
contentO conteúdo inteiro do arquivo.
elementwebchat ou booking.
fieldO campo do lead que o campo do formulário preenche.
htmlMarkup HTML.
inputO tipo do campo de formulário.
intoElemento que recebe o movido no fim.
itemÍndice, a partir de 0, do item repetido dentro do elemento.
keyA chave do bloco da plataforma.
kindrange ou color.
library_keyA chave de uma seção da biblioteca ou de uma seção salva do workspace.
maxMaior valor do knob range.
media_idO id de uma imagem da biblioteca de mídia.
minMenor valor do knob range.
nameO nome do atributo, do token ou do knob.
newO trecho novo.
nodeO elemento, no formato arquivo#posição lido do mapa da página, ou @ref para um elemento criado antes no mesmo lote.
number_refA referência do número de WhatsApp do workspace.
oldO trecho exato a trocar.
pathCaminho do arquivo, como pages/index.html ou src/App.jsx.
refNome para o elemento criado, usado como @nome nas operações seguintes do lote: letras minúsculas, números, - e _, até 32.
removeClasses a tirar.
replace_allTroca todas as ocorrências de old.
requiredSe o campo é obrigatório.
revO rev do arquivo no momento da leitura, devolvido por GET /sites/projects/{id}/files e por cada edição. Com node, é o rev do arquivo do elemento.
sourceO elemento a copiar, que pode estar em outra página.
source_revO rev do arquivo de source.
stepPasso do knob range.
textEm set_text, o texto em marcação inline (**negrito**, *itálico* e [rótulo](url)); em set_whatsapp_link, a mensagem pronta; em insert_form_field, o rótulo do campo; em set_form_option e insert_form_option, o texto e o valor da opção.
toO caminho ou o nome novo.
unitUnidade do knob range: vazio, px, rem, em, %, vh, vw, deg, ms ou s.
valueO valor do atributo, do token ou do knob. Num knob range, um número.
variableA variável CSS ligada ao knob, como --espaco-topo.