lenra-io/docs

[Task] Add the Lenra app OpenAPI reference to the documentation website

Aberta

#74 aberto em 23 de jan. de 2023

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)CSS (0 fork)auto 404
documentationenhancementgood first issue

Métricas do repositório

Stars
 (5 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

What should be done

Add the Lenra app OpenAPI reference to the documentation website

Create a new page with a link to the swagger editor (https://editor-next.swagger.io/) and the API URL from the latest release of the API project: https://github.com/lenra-io/api/releases

Is this task linked with any other ?

Blocked by https://github.com/lenra-io/api/issues/7

Guia do colaborador

Direção de pesquisa
Identifique o URL da versão mais recente na página de releases da API Lenra e crie uma nova página de documentação vinculando ao editor Swagger com esse URL.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80