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

API Specifications: refactors for clarity; doc improvements #152

Merged
merged 1 commit into from
Aug 21, 2024

Conversation

joshbeard
Copy link
Contributor

@joshbeard joshbeard commented Aug 21, 2024

  • Consolidated the long API specification description into a global constant for improved readability.
  • Renamed apiSpecificationResource to apiSpecResource and updated related structs and methods for consistency.
  • Replaced jsonMatch function with a more robust implementation.
  • Improved error handling and logging across the resource methods.
  • Added TestJsonMatch unit tests to validate the JSON comparison logic.
  • Improve documentation
  • General cleanup and code structure improvements for maintainability.

@joshbeard joshbeard changed the title Refactor API specification resource for clarity and consistency API Specifications: refactors for clarity; doc improvements Aug 21, 2024
- Consolidated the long API specification description into a global
  constant for improved readability.
- Renamed `apiSpecificationResource` to `apiSpecResource` and updated
  related structs and methods for consistency.
- Replaced `jsonMatch` function with a more robust implementation.
- Improved error handling and logging across the resource methods.
- Added `TestJsonMatch` unit tests to validate the JSON comparison
  logic.
- General cleanup and code structure improvements for maintainability.
@joshbeard joshbeard marked this pull request as ready for review August 21, 2024 17:00
@joshbeard joshbeard requested a review from a team as a code owner August 21, 2024 17:00
@joshbeard joshbeard self-assigned this Aug 21, 2024
@joshbeard joshbeard requested a review from bdwellons August 21, 2024 17:01
@joshbeard joshbeard merged commit 232684c into LiveOakLabs:main Aug 21, 2024
15 checks passed
@joshbeard joshbeard deleted the spec-refactors branch August 21, 2024 18:04
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.

2 participants