Ivc swagger

[cloudmagic80]

Summary

This pull request introduces the initial implementation of Swagger documentation for the IVC CHAMPA forms API. We are collaborating with the DOCMP PEGA team to integrate our API with their system. Our API will consume the payload sent by DOCMP's system via an HTTP POST request and update our database accordingly.

Key Changes:

1. Added Swagger documentation for the API endpoints and request/response models.

This work lays the foundation for the IVC CHAMPA forms integration with DOCMP's system, enabling seamless data exchange and processing.

Next Steps:

• Collaborate with DOCMP team for end-to-end testing in staging environments.
• Finalize documentation and prepare for production deployment.
• Implemented the endpoint to receive and process DOCMP's payload.
• Added database update logic to persist the received data.
• Unit tests have been added to cover the new functionality.
• Integration tests have been performed to ensure successful communication with DOCMP's system (testing environment).

Related issue(s)

https://github.com/department-of-veterans-affairs/vets-api/pull/16387 This related PR: Add ivc_champva_form model, factory and tests

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?

What areas of the site does it impact?

None so far. It is not in production yet

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 or Grafana (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?

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: app/swagger/swagger/requests/ivc_champva_forms

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: app/swagger/swagger/requests/ivc_champva_forms

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: app/swagger/swagger/requests/ivc_champva_forms

[github-actions[bot]]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

[github-actions[bot]]

This PR has been closed because it has had no activity for 37 days