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

Ops 2239/refactor get response schema #2330

Merged
merged 10 commits into from
May 22, 2024

Conversation

rajohnson90
Copy link
Contributor

@rajohnson90 rajohnson90 commented May 20, 2024

What changed

Updated the GET Agreement and GET Agreements endpoints to use base marshmallow schemas in order to serialize Agreements before being returned by the API. We could further use marshmallow capabilities to exclude unneeded data and keep the Agreement object size smaller, but I don't have the knowledge of our codebase required to determine what data is currently considered 'unnecessary'.

Issue

Issue 2239

How to test

  1. Open any agreement in the OPS dashboard
  2. Verify that none of the fields are populated with placeholder values (such as TBD)

Definition of Done Checklist

  • OESA: Code refactored for clarity
  • OESA: Dependency rules followed
  • Automated unit tests updated and passed
  • Automated integration tests updated and passed
  • Automated quality tests updated and passed
  • Automated load tests updated and passed
  • Automated a11y tests updated and passed
  • Automated security tests updated and passed
  • 90%+ Code coverage achieved
  • Form validations updated

@rajohnson90 rajohnson90 self-assigned this May 20, 2024
@rajohnson90 rajohnson90 marked this pull request as draft May 20, 2024 14:28
@rajohnson90 rajohnson90 changed the title DRAFT: Ops 2239/refactor get response schema Ops 2239/refactor get response schema May 20, 2024
@rajohnson90 rajohnson90 marked this pull request as ready for review May 20, 2024 14:38
@rajohnson90 rajohnson90 changed the title Ops 2239/refactor get response schema DRAFT Ops 2239/refactor get response schema May 20, 2024
@rajohnson90
Copy link
Contributor Author

Realized I did not map CANs in. I will need a bit more time to add CANs so I'm moving this back to draft status.

@rajohnson90 rajohnson90 linked an issue May 20, 2024 that may be closed by this pull request
4 tasks
@rajohnson90 rajohnson90 marked this pull request as draft May 20, 2024 17:57
@rajohnson90 rajohnson90 changed the title DRAFT Ops 2239/refactor get response schema Ops 2239/refactor get response schema May 22, 2024
@rajohnson90 rajohnson90 marked this pull request as ready for review May 22, 2024 14:58
@rajohnson90 rajohnson90 added tech-debt Resolved technical debt (tooling, configuration, or workflow) and removed don't merge labels May 22, 2024
@rajohnson90 rajohnson90 merged commit cb5a0b9 into main May 22, 2024
11 checks passed
@rajohnson90 rajohnson90 deleted the OPS-2239/refactor-get-response-schema branch May 22, 2024 18:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tech-debt Resolved technical debt (tooling, configuration, or workflow)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor GET Agreement response schema
3 participants