lenra-io/docs

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

Open

#74 opened on Jan 23, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)CSS (0 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Identify the latest release URL from the Lenra API releases page and create a new documentation page linking to the Swagger editor with that URL.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80