Skip to content

Update health service error handling and json schema #83

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Apr 17, 2025
Merged

Update health service error handling and json schema #83

merged 6 commits into from
Apr 17, 2025

Conversation

@anilnatha
Copy link
Contributor

@anilnatha anilnatha commented Apr 7, 2025 •
edited
Loading

Purpose

This PR addresses updates to the health service and related functionality as detailed below.

Proposed Changes

  • [CHANGE] The health services schema has been updated to account for the new fields, componentCategory, componentType, and description
  • [CHANGE] Improved error handling of health service methods related to fetching and printing of health information from API
  • [CHANGE] Unit tests have been updated to use mock data rather than live API endpoints
  • [CHANGE] Updated printing of health status report to include new fields mentioned above
  • [ADD] Unit test to validate the health services schema
  • [FIX] Schema definition of health service as it wasn't properly validating enumerated values
  • [REMOVE] Superfluous unit test that creates a health_service instance

Issues

Testing

  • Tested locally using pytest

anilnatha added 6 commits April 7, 2025 12:34
@anilnatha
Updated health API schema to address the newly added fields of compon…
c90d73d 
…entCategory, componentType, and description. The related unit tests were also updated with a correction to the schema definition to properly validate the schema. The health status report printing was also updated to reflect the addition of the three fields.
@anilnatha
Updated health endpoint unit tests to use mock data when verifying if…
5cb06da 
… printing of health status reports is functional.
@anilnatha
Cleaned up printing of health information so that the word "service" …
589088f 
…isn't repeated so much.
@anilnatha
Improved error handling of health service methods, get_health_status …
2f3f8ac 
…and generate_health_status_report
@anilnatha
Added mock health services api data file for unit tests.
4dd817f
@anilnatha
Updated CHANGELOG and bumped version number in pyproject.toml for uni…
a892ea7 
…ty-sds-client.
@anilnatha
Copy link
Contributor Author

anilnatha commented Apr 7, 2025

@mcduffie Thank you for your ticket regarding improving the error handling of the health service. This PR includes changes to address that.

@anilnatha
Copy link
Contributor Author

anilnatha commented Apr 10, 2025

@brianlee731 @rtapella Friendly ping that this is awaiting review.

@anilnatha anilnatha self-assigned this Apr 10, 2025
rtapella
rtapella approved these changes Apr 15, 2025
View reviewed changes
Copy link
Contributor

@rtapella rtapella left a comment

Choose a reason for hiding this comment

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

tested locally. works.

@anilnatha anilnatha merged commit 0bc8f94 into main Apr 17, 2025
10 checks passed
@anilnatha anilnatha deleted the features/update-health-service branch May 19, 2025 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rtapella rtapella rtapella approved these changes

@brianlee731 brianlee731 Awaiting requested review from brianlee731

Assignees

@anilnatha anilnatha

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update Health Service to account for Health API updates get_health_status should check response status code

3 participants

@anilnatha @rtapella