bcgov / bcgov/entity

PDF Gen - Construct an API for getting all generable forms

Open
#23,310 0 comments 0 reactions 0 assignees View on GitHub
blocked Entities - Data Migration Priority1
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

Create an endpoint that can be used with a GET method with no parameters, it returns a list of all generable forms in a JSON format. The results contain the PDF form names and their parameter for generating that PDF.

**NOTE**
- Look at Legal-Api repo for references, if not familiar with flask and how to create API endpoints.

TODOs
- [ ] Import bp_pdf and related flask functions
- [ ] Import related model(s) and methods
- [ ] Create a function to get a list of generable forms
- [ ] Add an endpoint / route to make the API work
- [ ] Add/Update tests if necessary
- [ ] Make sure to test the endpoint in Postman, consider successful and failed requests

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.