Pular para o conteúdo
Cérebro

Propor conteúdo ao Cérebro

v1.0.0
POSThttps://api.staging.growthaisystem.com/api/v1/cerebro/proposals
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposcerebro.propose

Propõe um documento novo numa pasta (tipo: documento_novo) ou uma versão nova de um documento (tipo: versao_documento, com o texto INTEIRO). Nada vira verdade sem uma pessoa aprovar: a proposta entra na fila de propostas do Cérebro, com a origem Integração: <nome da chave>, e o estado se acompanha em GET /cerebro/proposals/{id}.

Valor, parcela ou desconto no texto não vira documento: a proposta passa a apontar para o catálogo (caminhos). A mesma proposta repetida enquanto aberta soma ocorrência em vez de abrir outra. Aceita Idempotency-Key.

Corpo da requisição

application/jsonobrigatório

V1CerebroProposalCreateInputInput

    • tipo"documento_novo"obrigatório
      • sempre "documento_novo"
    • pastastringobrigatório

      Chave da pasta do Cérebro (empresa, oferta, servicos, objecoes… — a pasta.chave de GET /cerebro/documentos).

      • regex "^[a-z0-9_-]{1,40}$"
    • titulostringobrigatório

      Título do documento proposto.

      • tamanho 1–160
    • markdownstringobrigatório

      O conteúdo do documento, em Markdown.

      • tamanho 1–200000
    • porquestringopcional

      Por que propor (o que foi visto, de onde veio).

      • padrão ""
      • tamanho máx. 500
    • tipo"versao_documento"obrigatório
      • sempre "versao_documento"
    • documentoIdstringobrigatório

      O documento a atualizar (de GET /cerebro/documentos).

      • tamanho 1–64
    • titulostringobrigatório

      Título da proposta (o que muda, numa linha).

      • tamanho 1–160
    • markdownstringobrigatório

      O texto INTEIRO da nova versão, em Markdown (não um trecho).

      • tamanho 1–200000
    • notastringopcional

      Nota da versão (o que mudou).

      • padrão ""
      • tamanho máx. 500
    • porquestringopcional
      • padrão ""
      • tamanho máx. 500

Respostas

10 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A MESMA proposta já estava aberta (efeito: somada, ocorrencias +1) ou a Idempotency-Key repetiu uma chamada anterior (efeito: repetida). Nada novo foi aberto.

  • idstring
  • tipostring
  • estadostring
  • titulostring
  • porquestring
    • idstring
    • nomestring
    • idstring
    • titulostring
  • caminhosstring[]
  • ocorrenciasinteger
  • criadaEmstring
    • emstring
    • porstring
    • caminhostring | null
    • motivostring | null
  • efeitostring
    • um de"aberta""somada""repetida"