lenra-io/docs

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

Ouverte

#74 ouverte le 23 janv. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)CSS (0 fork)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (5 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Identifiez l'URL de la dernière version à partir de la page des versions de l'API Lenra et créez une nouvelle page de documentation liant à l'éditeur Swagger avec cette URL.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80