[1115] Update swagger docs for Veterans Status Card API response

[kbog25]

Keep your PR as a Draft until it's ready for Platform review. A PR is ready for Platform review when it has a teammate approval and tests, linting, and settings checks pass CI. See these tips on how to avoid common delays in getting your PR merged.

Summary

• This work is behind a feature toggle (flipper): NO
• (Summarize the changes that have been made to the platform) Update swagger docs for Veterans Status Card API response
• (If bug, how to reproduce)
• (What is the solution, why is this the solution?)
• (Which team do you work for, does your team own the maintenance of this component?) Mobile Feature Support
• (If introducing a flipper, what is the success criteria being targeted?)

Related issue(s)

• Link to ticket created in va.gov-team repo OR screenshot of Jira ticket if your team uses Jira 1115
• Link to previous change of the code/bug (if applicable)
• Link to epic if not included in ticket

Testing done

• New code is covered by unit tests
• Describe what the old behavior was prior to the change
• Describe the steps required to verify your changes are working as expected. Exclusively stating 'Specs run' is NOT acceptable as appropriate testing
• If this work is behind a flipper:
  • Tests need to be written for both the flipper on and flipper off scenarios. Docs.
  • What is the testing plan for rolling out the feature?

Screenshots

Note: Optional

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas)

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?

[github-actions]

✅ Static OpenAPI documentation has been automatically generated and committed from openapi.yaml.

[mtharmer-wc]

Overall it looks great, just a few minor tweaks. Also, if you want, you can apply the same examples from VeteranStatusCard.yml to veteran_status_card.rb, using either:

property :full_name, example: 'John T Doe Jr'

or

property :full_name do
  key :example, 'John T Doe Jr`

It's up to you, but we do have some time and it might be a good idea to match the examples between different API docs.

[github-actions]

✅ Static OpenAPI documentation has been automatically generated and committed from openapi.yaml.

[github-actions]

✅ Static OpenAPI documentation has been automatically generated and committed from openapi.yaml.

[github-actions]

✅ Static OpenAPI documentation has been automatically generated and committed from openapi.yaml.

[mtharmer-wc]

LGTM! 👍