[Task] OpenAPI - Describe the CRON and WebHook endpoints
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
What should be done
Our internal API (callable only by the Lenra apps) contains CRON and WebHook management endpoints that are not described yet.
Describe those endpoints that are defined in the server repo: https://github.com/lenra-io/server/blob/beta/libs/application_runner/lib/router.ex#L29
Decribe them in the OpenAPI dedicated to the internal API: src/internal-api.yml
Technical recommandation
Define common structures (that could be used in many requests and responses directly in the file, in the components.schemas definition (that does not exist yet).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the endpoint definitions in the server repository at libs/application_runner/lib/router.ex around line 29, then update src/internal-api.yml. Identify the CRON and WebHook management endpoints and define reusable structures under components.schemas as needed. Done means the internal OpenAPI document describes those endpoints and their request and response schemas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100