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-40554-version-2 #18790

Closed
wants to merge 1 commit into from
Closed

API-40554-version-2 #18790

wants to merge 1 commit into from

Conversation

stiehlrod
Copy link
Contributor

Summary

  • Adds maximum request example.
  • Updates dev/swagger & prod/swagger.

Related issue(s)

Testing done

Screenshots

Screenshot 2024-10-08 at 11 52 32 AM

What areas of the site does it impact?

modified:   modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
modified:   modules/claims_api/app/swagger/claims_api/v2/production/swagger.json
new file:   modules/claims_api/spec/fixtures/v2/veterans/disability_compensation/valid_526_maximum.json
modified:   modules/claims_api/spec/requests/v2/veterans/rswag_526_spec.rb

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

If you can figure out how to update this line on the fly, please let me know.

@@ -84,8 +84,7 @@ def append_example_metadata(example, response)
},
'Maximum Attributes' => {
value: JSON.parse(Rails.root.join('modules', 'claims_api', 'spec', 'fixtures', 'v2', 'veterans',
'disability_compensation', 'form_526_json_api.json').read)

'disability_compensation', 'valid_526_maximum.json').read)
Copy link
Contributor

Choose a reason for hiding this comment

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

@stiehlrod I suspect the new fixture is probably the way to go. Do we also want this removed from the 202 example below this in the docs?

Screenshot 2024-10-08 at 2 02 50 PM

It is also still in the synchronous endpoint example (and 202) so also wondering if that needs to be removed

Screenshot 2024-10-08 at 2 04 19 PM

Screenshot 2024-10-08 at 2 02 50 PM

"claimantCertification": true
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

I believe this JSON file needs a newline at the bottom of it (so a line 217 that is empty) otherwise it will keep getting this red mark on it and eventually may conflict with something if it does get formatted.

Not really my nit, just something I think gets enforced at some level for the app that I have run into.

@stiehlrod stiehlrod closed this Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants