Skip to content

Commit

Permalink
Add note to Simple Forms API README about native setup (#19462)
Browse files Browse the repository at this point in the history
Adds some clarification to the README for the simple_forms_api module about the setup needed to run the rails command locally as well was the path needed by the command to find the appropriate PDF file.
  • Loading branch information
derekhouck authored Nov 15, 2024
1 parent f6e2b92 commit f2cea57
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions modules/simple_forms_api/README.rdoc
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

0 comments on commit f2cea57

Please sign in to comment.