Pipeline

Atualizar a documentação pela pipeline

Um passo no fim do seu deploy e a documentação acompanha o código. Sem ninguém abrir o app, sem confirmar nada.

Disponível no plano Max. É a única escrita do acesso programático — o resto da API é leitura.

Antes: documente uma vez pelo app

O disparo mantém atualizado o que já existe; ele não descobre um repositório do zero. A primeira documentação é escolha sua (o que documentar, em qual wiki) e acontece no app. Sem ela, o disparo responde sem_plano.

A chave

Em Configurações → Chaves de API, crie uma chave e, no projeto que a pipeline vai atualizar, escolha Pode atualizar. Uma chave só de leitura é recusada — disparar gasta crédito, então a permissão é concedida de propósito, projeto por projeto.

Guarde a chave como segredo da sua pipeline, na variável MEMORAX_TOKEN.

Com o CLI

npm i -g @memoraxapp/cli memorax atualizar -p <projeto> --espaco ambas

--espaco aceita negocio, tecnica ou ambas — ambas existe para você não precisar de dois passos. Não há padrão: o espaço é sempre escolhido.

Com --esperar, o comando bloqueia até terminar e devolve o que foi feito (páginas e créditos). Ele sai com erro só se a atualização falhar; se o tempo-limite estourar, avisa e segue — o trabalho continua no servidor.

memorax atualizar -p meu-projeto --espaco ambas --esperar --timeout 900

Com curl

curl -sS -X POST "$MEMORAX_URL/api/v1/atualizar-documentacao" \ -H "Authorization: Bearer $MEMORAX_TOKEN" \ -H 'content-type: application/json' \ -d '{"projeto":"meu-projeto","espaco":"ambas"}'

A resposta é 202 com um run por wiki disparada. Consulte o estado quando quiser:

curl -sS "$MEMORAX_URL/api/v1/atualizar-documentacao?projectId=meu-projeto&run=$RUN" \ -H "Authorization: Bearer $MEMORAX_TOKEN"

Num GitHub Actions

- name: Atualizar a documentação run: npx @memoraxapp/cli atualizar -p meu-projeto --espaco ambas env: MEMORAX_TOKEN: ${{ secrets.MEMORAX_TOKEN }}

O que esperar

Nada mudou não custa nada. O disparo compara o repositório com o que já foi documentado; deploy que não toca o código documentado termina sem chamar IA.
Só o que mudou é refeito. As páginas dos trechos intocados ficam como estão.
Disparo repetido não empilha. Dois deploys em sequência devolvem o mesmo run.
O limite é o seu saldo. Não há teto por atualização: se o saldo não cobre, nada é gerado e o run diz insufficient_credits.

Erros

403 atualizar_nao_concedido — a chave lê, mas não tem a permissão nesse projeto.
400 espaco_invalido — falta espaco (ou veio um valor fora dos três).
400 sem_plano — o projeto ainda não foi documentado pelo app.
403 espaco_nao_concedido — a chave não alcança aquela wiki.
402 — organização fora do plano Max.
429 — muitos disparos seguidos no mesmo projeto.

Para ler o conhecimento (em vez de atualizá-lo), veja Referência REST, CLI ou MCP.