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.

Sign up for GitHub

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

Add note to Simple Forms API README about native setup #19462

Merged
merged 2 commits into from
Nov 15, 2024
Merged

Add note to Simple Forms API README about native setup #19462

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f239db9
Add note about native setup
derekhouck Nov 14, 2024
18f2724
Add default path to rails command
derekhouck Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions modules/simple_forms_api/README.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
= SimpleFormsApi
This module allows you to generate form_mappings based on a PDF file.
With this in place, you can submit a form payload from the vets-website
and have this module map that payload to the associated PDF and submit it
This module allows you to generate form_mappings based on a PDF file.
With this in place, you can submit a form payload from the vets-website
and have this module map that payload to the associated PDF and submit it
to the Benefits Intake API in Lighthouse.

Note: The following command can currently only be run locally after following the [Native setup](https://github.com/department-of-veterans-affairs/vets-api/blob/master/docs/setup/native.md) instructions.

To generate files:
rails simple_forms_api:generate\['path to PDF file'\]
rails simple_forms_api:generate['modules/simple_forms_api/templates/YOUR_PDF_FILE.pdf']

Submission endpoint:
/simple_forms_api/v1/simple_forms
Expand Down
Loading