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

[ADR]: API Documentation #1336

Open
9 tasks
acouch opened this issue Feb 26, 2024 · 0 comments
Open
9 tasks

[ADR]: API Documentation #1336

acouch opened this issue Feb 26, 2024 · 0 comments
Labels
docs: adr Architecture decision record ticket project: grants.gov Grants.gov Modernization tickets

Comments

@acouch
Copy link
Collaborator

acouch commented Feb 26, 2024

Description

re: #856

This task is to create an ADR for API documentation. The Opportunity API launch will use the OpenAPI documentation. There is a desire to use another tool for the Search API / UI launch.

Approvers

@andycochran @btabaska @widal001 @lucasmbrown-usds @sumiat

Options

  • Keep Open API / Swagger docs
  • Add to simpler.grants.gov website
  • Add to public wiki (and possibly site later)

Decision Criteria

  • What is the LOE of each option?
  • How would the LOE affect current deliverables, including team member availability?
  • What is the long-term desirable landing for the API docs?
  • Are there security implications with using the wiki?

Definition of Done

  • The approvers for this decision have been identified (ideally before work on the ADR starts)
  • The ADR is created and stored in documentation/decisions/adr with status "Accepted"
  • The ADR has been reviewed and approved by the approvers listed above
  • The ADR satisfies requirements that are outlined in the ADR template
  • Any follow-up tickets have been created (if necessary)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: adr Architecture decision record ticket project: grants.gov Grants.gov Modernization tickets
Projects
Development

No branches or pull requests

1 participant