bcgov/indy-tails-server

Create a new api endpoint for health check

Open

#31 opened on May 24, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (54 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (29 stars)
PR merge metrics
 (Avg merge 9h 34m) (1 merged PR in 30d)

Description

At the moment, there's no health check api endpoint available. When deploying with load balancers for health checking, this is not possible.

Request a new endpoint for health checking purpose.

Contributor guide

Research direction
Examine the existing Python server code to understand the routing mechanism, then add a new endpoint (e.g., /health) that returns a JSON response with a status of 'ok'.
Tech stack
python
Domain
backend
Issue type
Feature
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85