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

Migrate to automated API tools pipeline via OpenAPI #14353

Open
9 tasks
jpandersen87 opened this issue May 9, 2024 · 0 comments
Open
9 tasks

Migrate to automated API tools pipeline via OpenAPI #14353

jpandersen87 opened this issue May 9, 2024 · 0 comments
Labels
backend Work Type label to flag work that requires back-end engineering Epic ZenHub Epic label experience Team label to flag issues owned by the Experience Team frontend Work Type label to flag work related to the front-end websites

Comments

@jpandersen87
Copy link
Collaborator

jpandersen87 commented May 9, 2024

A healthy API is one that automatically generates an OpenAPI document describing it, which allows for automation of things such as code generation of tools that test and use the API in any languages that support it. We need to make the needed changes to backend to facilitate this. Taking full advantage of the OpenAPI specification should allow us to test the API through the generated OpenAPI document, without needing manually-created tests.

Acceptance Criteria

  • A 3.1 OpenAPI document describing our API that passes validation is automatically generated with all azure function endpoints as paths
    • Each azure function that acts as an endpoint should be properly annotated with:
      • security
      • method
      • operationId
      • path
      • responses with schemas
  • Automated testing of the API via the OpenAPI doc
  • Automated generation of Frontend code and types via the OpenAPI doc
@jpandersen87 jpandersen87 added backend Work Type label to flag work that requires back-end engineering experience Team label to flag issues owned by the Experience Team frontend Work Type label to flag work related to the front-end websites Epic ZenHub Epic label labels May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Work Type label to flag work that requires back-end engineering Epic ZenHub Epic label experience Team label to flag issues owned by the Experience Team frontend Work Type label to flag work related to the front-end websites
Projects
Status: New items
Development

No branches or pull requests

1 participant