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

[Issue 938] Make opportunity endpoints v0 instead of v1 #939

Merged
merged 5 commits into from
Jan 2, 2024

Conversation

chouinar
Copy link
Collaborator

Summary

Fixes #938

Time to review: 5 mins

Changes proposed

Modified our opportunity endpoints to be prefixed with /v0 instead of v1

Context for reviewers

This was a recommendation we received to make clear the endpoints are early alpha versions. Also added a small description to the endpoints to help make this clear too.

Additional information

Screenshot 2023-12-20 at 12 31 31 PM

Copy link
Collaborator

@acouch acouch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(praise) Awesome, to get this done so fast.

(suggestion) Adding

    app.title = 'Simpler Grants API'
    app.version = 'v0'
    app.config['DOCS_FAVICON'] = 'https://simpler.grants.gov/img/favicon.ico'

to src/app/config.py

would update the HTML title and version next to the title as well:

image

to:

image

Additionally, updating the app.info.description to "Back end API for simpler.grants.gov. This API is in ALPHA VERSION! Its current form is primarily for testing and feedback." would help communicate the state of the API as well.

@@ -51,7 +51,7 @@ paths:
tags:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this YAML file autogenerated before it's checked into git? (Sorry I'm not familiar with how our system currently works on this front!)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there is a github action that runs automatically to do it. I just made a few updates based on what Aaron suggested, and it triggered: https://github.com/HHS/simpler-grants-gov/actions/runs/7387946234/job/20097725000?pr=939 which added this commit: 759df0f

Note, the yml file is not used by the API and is just reference. The file it uses when running is generated when the app starts up (exact same underlying code generates them).

@chouinar chouinar merged commit 4199f1e into main Jan 2, 2024
@chouinar chouinar deleted the chouinar/938-v0 branch January 2, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Modify opportunity endpoints to be v0 instead of v1
4 participants