Home Ciência e Tecnologia La Suite Docs 5.0.0: Nova API, rompe com o cliente antigo

La Suite Docs 5.0.0: Nova API, rompe com o cliente antigo

12
0

fechar notícias

Este artigo também está disponível em inglês. Foi traduzido com assistência técnica e revisado editorialmente antes da publicação.

Com a versão 5.0.0, o La Suite Docs reconstrói principalmente documentos API. Maior mudança: o conteúdo do documento e os metadados agora estão separados. De acordo com as notas de lançamento oficiais e instruções de atualização, o caminho do conteúdo anterior agora é chamado formatted-contentcampo content são omitidos da resposta regular do documento e pontos de extremidade separados são adicionados para leitura e gravação. Esta é uma alteração no cliente API existente.

Leia mais depois do anúncio

La Suite Docs é um editor de código aberto para colaboração em equipe e se considera uma alternativa superior ao Notion ou Google Docs. O grupo-alvo inclui instituições públicas, bem como empresas. O Centro Alemão para a Soberania Digital da Administração Pública (ZenDiS) e a Autoridade Interministerial Francesa para o Digital (DINUM) estão por trás do projeto.

Os desenvolvedores mencionaram o motivo do corte brusco no commit d7a186a. Anteriormente, as alterações de conteúdo passavam pelo mesmo endpoint de atualização que outras propriedades do documento. Mesmo com uma simples mudança de nome, o servidor envia todo o conteúdo – e não há necessidade de acessar o status dos documentos armazenados no armazenamento do S3. Agora existe um endpoint separado para isso: PATCH /api/v1.0/documents/{document_id}/content/. As instruções de atualização mostram campos codificados em Base64 como a carga esperada content. Se o status do documento aprovado for inválido, o servidor responde com 400 Bad Request e mensagens de erro invalid yjs document. Se você estiver apenas alterando metadados, como título ou visibilidade, não precisará carregar o conteúdo real do documento.

Há também um ponto final separado para leitura. GET /api/v1.0/documents/{document_id}/content/ transmitir conteúdo de acordo com as instruções de atualização text/plain. O commit 6b3d197 indica que este é o caso StreamingHttpResponse e pedaços de 8.192 bytes são usados. Se o arquivo estiver faltando no armazenamento, o endpoint ainda enviará um HTTP 200 com corpo vazio. O teste do mesmo compromisso também lista a matriz de acesso: Usuários anônimos têm permissão para acessar documentos públicos; para documentos não públicos, você receberá 401. Usuários autenticados sem autorização são atribuídos para serem restritos 403. No código, o projeto fala sobre “conteúdo bruto do Yjs”. Yjs é uma biblioteca de colaboração em tempo real que sincroniza automaticamente tipos de dados comuns. Portanto, os endpoints entregam o estado bruto colaborativo de um documento, em vez de um formato de troca finalizado.

Para os self-hosters, a segunda grande novidade é a atualização do serviço de conversão para DocSpec 3.0.x. Pull Request #2220 afirma especificamente que as imagens Docker ghcr.io/docspecio/api:3.0.0 deve ser atualizado junto com o código do aplicativo. O novo formato de solicitação é incompatível; Se você atualizar apenas uma página, corre o risco de falha na conversão do documento. A mesma solicitação pull também reflete uma mudança técnica: em vez de um multipart upload, o cliente agora envia o conteúdo do documento diretamente no corpo da solicitação e define Content-Type e Accept explicitamente. Qualquer pessoa que mantenha sua própria configuração do Compose, Helm ou Kubernetes deve planejar um conversor para um grande plano de atualização.

Outra novidade é a conexão Mistral para o novo pipeline de IA. Commit b6efac3 introduz uma opção de provedor que, dependendo da configuração, é OpenAIChatModel ou MistralModel usado. Consulte a documentação para variáveis ​​de ambiente para este OPENAI_SDK_API_KEY, OPENAI_SDK_BASE_URL, MISTRAL_SDK_API_KEY e MISTRAL_SDK_BASE_URL no. A instrução de atualização também nomeia a variável anterior AI_API_KEY e AI_BASE_URL no OPENAI_SDK_* em volta. Importante para os próprios operadores de infraestrutura de IA: Path Mistral só pode ser usado em operações assíncronas com uvicorn. Inicialmente, esta é uma pequena mudança para os usuários finais; A inovação é voltada para instalações que não utilizam parceiros compatíveis com OpenAI.

Leia mais depois do anúncio

Existem também algumas atualizações práticas na operação e na UI na versão 5.0.0. Pull Request #2241 corrige cabeçalhos de autenticação de encaminhamento que agora são configuráveis, dizendo que o Traefik usa um nome de cabeçalho diferente; Os cabeçalhos a serem lidos podem ser definidos via configuração HTTP_X_FORWARDED_URI sintonia. De acordo com PR #2222, a função de ajuda do Crisp mudou para o menu de ajuda no front end – o botão estava anteriormente sobreposto na seção do aplicativo.

Existem também correções menores, mas úteis: de acordo com PR #2028, o backend agora classifica documentos incorporados updated_at Operações de movimentação para baixo e movimentação inválida na árvore do documento são reconhecidas pelo servidor de acordo com PR #2208 400 Bad Request em vez de com 500 Internal Server Error. As notas de lançamento também apresentam algumas melhorias de acessibilidade e pequenas correções de front-end.

O que se segue é que a versão 5.0.0 não é um lançamento de recurso importante, mas sim uma conversão de back-end e infraestrutura com consequências visíveis para clientes de API, auto-hosters e próprios operadores de serviços adicionais. Os usuários finais verão principalmente melhorias menores na interface do usuário. Porém, para os integradores, a nova separação entre metadados, conteúdo formatado e fluxos de conteúdo bruto traz alguns ajustes.


(foo)

Fonte

LEAVE A REPLY

Please enter your comment!
Please enter your name here