lenra-io/docs

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

Aperta

#74 aperta il 23 gen 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)CSS (0 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (5 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Identifica l'URL dell'ultima release dalla pagina delle release dell'API Lenra e crea una nuova pagina di documentazione che colleghi allo Swagger editor con quell'URL.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80