Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: implement status page endpoints #953

Merged

Conversation

JoshuaOloton
Copy link
Contributor

Description

This pull request implements a backend API for the API Status Page. It includes endpoints to update and retrieve API status information, a database model to store the data, and a script to parse and post results from Newman test runs.

Related Issue (Link to issue ticket)

#952

Motivation and Context

This change is required to create a robust backend system that can efficiently process, store, and serve API health data. It solves the problem of real-time monitoring and displaying the health of various API groups, enabling automatic updates every 15 minutes on all projects and boilerplates.

How Has This Been Tested?

Unit tests were written and carried out on the GET and POST endpoints using the Pytest library

Screenshots (if appropriate - Postman, etc):

SWAGGER UI

image

FETCH SUCCESSFUL

image

POST SUCCESSFUL

image

RUNNING PYTHON SCRIPT TO PARSE NEWMAN JSON AND POST TO ENDPOINT

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Collaborator

@johnson-oragui johnson-oragui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This implementation is supposed to check the status of different sections of the API I suppose, but I don't see any functionality or implementation or calculations for that.

Kindly point me to where it was done.

Copy link
Collaborator

@johnson-oragui johnson-oragui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a comment. Please reply

@johnson-oragui johnson-oragui merged commit 1fda8cf into hngprojects:dev Aug 24, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants