Api 42951 poa v2 zip code updates #19665

rockwellwindsor-va · 2024-12-02T13:40:00Z

Summary

zipCode is only required now when the countryCode is 'US'

Updates schema
updates validations
- Adjusts/add tests
Updates documentation to reflect changes for zipCode

Related issue(s)

API-42951

Testing done

New code is covered by unit tests
Old tests adjusted

Testing Notes

Any 2122 & 2122a v2 submissions where the countryCode and zipCode are taken out/put in will test the behavior

Screenshots

2122
2122a

What areas of the site does it impact?

modified:   modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb
modified:   modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb
modified:   modules/claims_api/config/schemas/v2/2122.json
modified:   modules/claims_api/config/schemas/v2/2122a.json
modified:   modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122_spec.rb
modified:   modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122a_spec.rb
modified:   modules/claims_api/spec/requests/v2/veterans/power_of_attorney/power_of_attorney_request_spec.rb
modified:   modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
modified:   modules/claims_api/app/swagger/claims_api/v2/production/swagger.json

Acceptance criteria

I fixed|updated|added unit tests and integration tests for each feature (if applicable).
No error nor warning in the console.
Events are being sent to the appropriate logging solution
Documentation has been updated (link to documentation)
No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
Feature/bug has a monitor built into Datadog (if applicable)
If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
I added a screenshot of the developed feature

Requested Feedback

(OPTIONAL)What should the reviewers know in addition to the above. Is there anything specific you wish the reviewer to assist with. Do you have any concerns with this PR, why?

* Updates schema * updates validations * Adjusts/add tests modified: modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb modified: modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb modified: modules/claims_api/config/schemas/v2/2122.json modified: modules/claims_api/config/schemas/v2/2122a.json modified: modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122_spec.rb modified: modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122a_spec.rb modified: modules/claims_api/spec/requests/v2/veterans/power_of_attorney/power_of_attorney_request_spec.rb

github-actions · 2024-12-02T13:40:45Z

	1 Warning
⚠️	This PR changes `232` LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding `200`. Expect some delays getting reviews. File Summary Files modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb (+2/-1) modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb (+19/-9) modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122_spec.rb (+123/-0) modules/claims_api/spec/requests/v2/veterans/power_of_attorney/2122a_spec.rb (+63/-13) modules/claims_api/spec/requests/v2/veterans/power_of_attorney/power_of_attorney_request_spec.rb (+1/-1) Note: We exclude files matching the following when considering PR size: `.csv, .json, .tsv, .txt, .md, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, .bru, *.pdf` Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

* Updates documentation to reflect changes for zipCode modified: modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json modified: modules/claims_api/app/swagger/claims_api/v2/production/swagger.json

stiehlrod

tested V2 2122 & 2122a. LGTM

tycol7

looking good so far. are we using country or countryCode? seems to be a mix of both throughout.

modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb

modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json

modules/claims_api/config/schemas/v2/2122a.json

tycol7

we should resolve country vs countryCode before merging.

rockwellwindsor-va · 2024-12-03T18:46:35Z

looking good so far. are we using country or countryCode? seems to be a mix of both throughout.

Yep totally got some bleed over on that term from the other PR with that update in it. Should have just merged in order but now that https://github.com/department-of-veterans-affairs/vets-api/pull/19650[)](https://github.com/department-of-veterans-affairs/vets-api/commit/4c52087c513b9296c62326dd81f57b925e29eb78) has merged in can utilize countrycode throughout as needed.

Also address the other comments:

countryCode should now be consistently used
refactored address method to avoid duplication
adjusted method name to be more descriptive
linting fixes

Added new screenshots in PR

* Fixes misplaced `countryCode` usage * Adjusts missing missing spaces in the docs * Compiles docs w/ updates * Refactors `validate_address_zip_code` with `validate_zip` method to remove code duplication * A few other small linting fixes based on PR feedback modified: modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb modified: modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json modified: modules/claims_api/app/swagger/claims_api/v2/production/swagger.json modified: modules/claims_api/config/schemas/v2/2122a.json

…t update to go in to finish

tycol7

looks great!

tycol7 · 2024-12-04T16:16:19Z

modules/claims_api/app/controllers/concerns/claims_api/v2/power_of_attorney_validation.rb

+      # the Claimant object is already being validatated below,
+      # so that code has been adjusted and it is being left out of this workflow


We shouldnʼt need the comment now that the method name is self-descriptive.

ah, yep cabc789

rockwellwindsor-va added 2 commits November 29, 2024 16:26

Merge branch 'master' into API-42951-poa-v2-zip-code-updates

360097d

github-actions bot added the test-passing label Dec 2, 2024

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 2, 2024 13:51 Inactive

API-42951-poa-v2-zip-code-updates

4b24251

* Updates documentation to reflect changes for zipCode modified: modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json modified: modules/claims_api/app/swagger/claims_api/v2/production/swagger.json

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 2, 2024 14:11 Inactive

github-actions bot added test-passing and removed test-passing labels Dec 2, 2024

rockwellwindsor-va added the claimsApi modules/claims_api label Dec 2, 2024

Merge branch 'master' into API-42951-poa-v2-zip-code-updates

751d056

rockwellwindsor-va marked this pull request as ready for review December 2, 2024 18:12

rockwellwindsor-va requested a review from a team as a code owner December 2, 2024 18:12

github-actions bot added omit-backend-approval test-passing and removed omit-backend-approval test-passing labels Dec 2, 2024

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 2, 2024 18:45 Inactive

stiehlrod previously approved these changes Dec 3, 2024

View reviewed changes

tycol7 reviewed Dec 3, 2024

View reviewed changes

tycol7 requested changes Dec 3, 2024

View reviewed changes

MErges in master fixes conflict

ee56f89

rockwellwindsor-va dismissed stiehlrod’s stale review via ee56f89 December 3, 2024 18:29

github-actions bot added test-failure and removed test-passing labels Dec 3, 2024

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 3, 2024 18:45 Inactive

rockwellwindsor-va added 2 commits December 3, 2024 13:03

Fixes two more instances countryCode => country

1c5549a

rockwellwindsor-va marked this pull request as draft December 3, 2024 19:09

github-actions bot added test-passing test-failure and removed test-failure labels Dec 3, 2024

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 3, 2024 19:24 Inactive

Reintroduces some countryCode strings, this will need to wait for tha…

6209e28

…t update to go in to finish

github-actions bot removed the test-failure label Dec 3, 2024

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 3, 2024 20:17 Inactive

Merges in master branch and fixes many conflicts

0888845

va-vfs-bot temporarily deployed to API-42951-poa-v2-zip-code-updates/main/main December 4, 2024 00:26 Inactive

github-actions bot added test-failure and removed test-passing labels Dec 4, 2024

Recompiles swagger docs to finish up cleaning up merge conflicts

35f1c23

va-vfs-bot deployed to API-42951-poa-v2-zip-code-updates/main/main December 4, 2024 02:40 View deployment

github-actions bot added test-passing and removed test-failure labels Dec 4, 2024

rockwellwindsor-va marked this pull request as ready for review December 4, 2024 13:40

rockwellwindsor-va requested review from tycol7 and a team December 4, 2024 15:20

tycol7 previously approved these changes Dec 4, 2024

View reviewed changes

Removes unessecary comment held over

cabc789

rockwellwindsor-va dismissed tycol7’s stale review via cabc789 December 4, 2024 16:28

tycol7 approved these changes Dec 4, 2024

View reviewed changes

rockwellwindsor-va merged commit 451e121 into master Dec 4, 2024
30 checks passed

rockwellwindsor-va deleted the API-42951-poa-v2-zip-code-updates branch December 4, 2024 16:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Api 42951 poa v2 zip code updates #19665

Api 42951 poa v2 zip code updates #19665

rockwellwindsor-va commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

Files

stiehlrod left a comment

tycol7 left a comment

tycol7 left a comment

rockwellwindsor-va commented Dec 3, 2024 •

edited

Loading

tycol7 left a comment

tycol7 Dec 4, 2024

rockwellwindsor-va Dec 4, 2024

		# the Claimant object is already being validatated below,
		# so that code has been adjusted and it is being left out of this workflow

Api 42951 poa v2 zip code updates #19665

Api 42951 poa v2 zip code updates #19665

Conversation

rockwellwindsor-va commented Dec 2, 2024 • edited Loading

Summary

Related issue(s)

Testing done

Testing Notes

Screenshots

What areas of the site does it impact?

Acceptance criteria

Requested Feedback

github-actions bot commented Dec 2, 2024 • edited Loading

Files

stiehlrod left a comment

Choose a reason for hiding this comment

tycol7 left a comment

Choose a reason for hiding this comment

tycol7 left a comment

Choose a reason for hiding this comment

rockwellwindsor-va commented Dec 3, 2024 • edited Loading

tycol7 left a comment

Choose a reason for hiding this comment

tycol7 Dec 4, 2024

Choose a reason for hiding this comment

rockwellwindsor-va Dec 4, 2024

Choose a reason for hiding this comment

rockwellwindsor-va commented Dec 2, 2024 •

edited

Loading

github-actions bot commented Dec 2, 2024 •

edited

Loading

rockwellwindsor-va commented Dec 3, 2024 •

edited

Loading