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ção | Família | Campos |
|---|---|---|
write_file | Código | path, rev, content |
edit_file | Código | path, old, new, replace_all |
delete_file | Código | path, rev |
rename_file | Código | path, rev, to |
set_text | Visuais | node, rev, text, html, item |
set_attr | Visuais | node, rev, name, value |
set_classes | Visuais | node, rev, add, remove, breakpoint |
replace_image | Visuais | node, rev, media_id, alt |
move | Visuais | node, rev, before, after, into |
duplicate | Visuais | node, rev, ref |
remove | Visuais | node, rev |
insert_section | Visuais | at, rev, html, library_key, ref, source, source_rev |
set_token | Tema | name, value |
set_knob | Tema | name, value |
define_knob | Atalhos | name, variable, kind, min, max, step, unit |
rename_knob | Atalhos | name, to |
remove_knob | Atalhos | name |
set_whatsapp_link | Atalhos | node, rev, number_ref, text |
clear_whatsapp_link | Atalhos | node, rev |
insert_element | Atalhos | at, rev, element, key, ref |
set_form_field | Atalhos | node, rev, field, input, required |
insert_form_field | Atalhos | at, rev, field, input, text, required, ref |
set_form_option | Atalhos | node, rev, text |
insert_form_option | Atalhos | at, rev, text, ref |
Código
Mexem nos arquivos inteiros ou em trechos de texto deles.
write_file
write_fileCria 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
edit_fileTroca 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
delete_fileExclui 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
rename_fileRenomeia 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
set_textTroca 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
set_attrGrava 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
set_classesAcrescenta (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
replace_imageTroca 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
moveMove 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
duplicateDuplica um elemento logo depois dele. ref dá um nome à cópia para as operações seguintes do lote.
Campos: node, rev, ref.
remove
removeRemove um elemento.
Campos: node, rev.
insert_section
insert_sectionInsere 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
set_tokenGrava 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
set_knobMuda 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
define_knobDeclara 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
rename_knobRenomeia um knob para to.
Campos: name, to.
remove_knob
remove_knobRemove um knob de knobs.json.
Campos: name.
set_whatsapp_link
set_whatsapp_linkTransforma 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
clear_whatsapp_linkDesfaz o link de WhatsApp de um elemento.
Campos: node, rev.
insert_element
insert_elementInsere 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
set_form_fieldLiga 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
insert_form_fieldInsere 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
set_form_optionTroca 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
insert_form_optionInsere 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
| Campo | Significado |
|---|---|
add | Classes a acrescentar. |
after | Elemento que fica logo antes do movido. |
alt | Texto alternativo da imagem. |
at | Onde inserir: um objeto com exatamente um entre before, after, into (um node) e page (um arquivo de página, no fim do conteúdo). |
before | Elemento que fica logo depois do movido. |
breakpoint | sm, md, lg ou xl. |
content | O conteúdo inteiro do arquivo. |
element | webchat ou booking. |
field | O campo do lead que o campo do formulário preenche. |
html | Markup HTML. |
input | O tipo do campo de formulário. |
into | Elemento que recebe o movido no fim. |
item | Índice, a partir de 0, do item repetido dentro do elemento. |
key | A chave do bloco da plataforma. |
kind | range ou color. |
library_key | A chave de uma seção da biblioteca ou de uma seção salva do workspace. |
max | Maior valor do knob range. |
media_id | O id de uma imagem da biblioteca de mídia. |
min | Menor valor do knob range. |
name | O nome do atributo, do token ou do knob. |
new | O trecho novo. |
node | O elemento, no formato arquivo#posição lido do mapa da página, ou @ref para um elemento criado antes no mesmo lote. |
number_ref | A referência do número de WhatsApp do workspace. |
old | O trecho exato a trocar. |
path | Caminho do arquivo, como pages/index.html ou src/App.jsx. |
ref | Nome para o elemento criado, usado como @nome nas operações seguintes do lote: letras minúsculas, números, - e _, até 32. |
remove | Classes a tirar. |
replace_all | Troca todas as ocorrências de old. |
required | Se o campo é obrigatório. |
rev | O 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. |
source | O elemento a copiar, que pode estar em outra página. |
source_rev | O rev do arquivo de source. |
step | Passo do knob range. |
text | Em 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. |
to | O caminho ou o nome novo. |
unit | Unidade do knob range: vazio, px, rem, em, %, vh, vw, deg, ms ou s. |
value | O valor do atributo, do token ou do knob. Num knob range, um número. |
variable | A variável CSS ligada ao knob, como --espaco-topo. |