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

[10k]: API documentation (non-public) #71

Closed
6 tasks done
widal001 opened this issue Jun 28, 2023 · 1 comment
Closed
6 tasks done

[10k]: API documentation (non-public) #71

widal001 opened this issue Jun 28, 2023 · 1 comment
Labels
deliverable: 10k ft Product deliverables described at 10k feet project: grants.gov Grants.gov Modernization tickets topic: backend Backend development tickets

Comments

@widal001
Copy link
Collaborator

widal001 commented Jun 28, 2023

Description

This should include full OpenAPI documentation of the GET Opportunities API, as well as a tutorial for users who are interacting with the beta.grants.gov APIs for the first time.

The documentation should also describe what is likely to be stable in the API as it is developed versus what is unstable and will likely change without warning.

The update and deployment of documentation should be fully open source and managed through infrastructure as code.

Dependencies

Sub-Tasks

Sub-tasks can be found in this milestone

Definition of Done

  • Open API spec that gets updated automatically when updates to the API are deployed
  • Internal documentation is updated in Github
@widal001 widal001 added milestone topic: backend Backend development tickets labels Jun 28, 2023
@widal001 widal001 added this to the GET Opportunities milestone Jun 29, 2023
@widal001 widal001 added the project: grants.gov Grants.gov Modernization tickets label Jul 14, 2023
@widal001 widal001 added the deliverable: 10k ft Product deliverables described at 10k feet label Jul 19, 2023
@widal001 widal001 changed the title Milestone: API documentation [Epic]: API documentation Aug 28, 2023
@widal001 widal001 removed this from the FY24 Q1: GET Opportunities milestone Sep 18, 2023
@DevAppl1111
Copy link

Awesome

@widal001 widal001 changed the title [Epic]: API documentation [10k]: API documentation Oct 12, 2023
@sumiat sumiat changed the title [10k]: API documentation [10k]: API documentation (non-public) Dec 11, 2023
@sumiat sumiat closed this as completed Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deliverable: 10k ft Product deliverables described at 10k feet project: grants.gov Grants.gov Modernization tickets topic: backend Backend development tickets
Projects
Development

No branches or pull requests

3 participants