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.

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

[2025] Public API route #102

Open
pcraig3 opened this issue Dec 10, 2024 · 0 comments
Open

[2025] Public API route #102

pcraig3 opened this issue Dec 10, 2024 · 0 comments
Labels

Comments

@pcraig3
Copy link
Collaborator

pcraig3 commented Dec 10, 2024

Summary

The endgoal for a public API endpoint is to be able to offer NOFO data to downstream consumers.

Since NOFOs are public once they are published on grants.gov, we should be able to offer the NOFO data publicly as an alternate format to PDF to people or organizations who are interested.

We would need to think on this a bit, as sometimes published NOFOs are updated after publishing and we would want to make sure our content is kept current, and not offer different versions of the same NOFO depending on where you are getting it.

However, the general ID is that we would offer a public GET route to "get a NOFO by ID".

This would be limited to "published" NOFOS, and would therefore exclude archived NOFOs or drafts, etc.

We should also remove personal information or internal metadata which we produce: things like "coach", "designer", "status", which help us manage a NOFO through to publication but are not needed by grant applicants.

If we are talking about publishing a NOFO to SimplerGrants or passing it to another system, we would want to have some kind of authentication set up, which could be a bearer token or it could be something else.

This issue does not need to be actioned until we have a compelling use case or consumer for this data.

@pcraig3 pcraig3 added the API label Dec 10, 2024
@pcraig3 pcraig3 changed the title GET route API Public API route Dec 10, 2024
@pcraig3 pcraig3 changed the title Public API route [2025] Public API route Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant