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

Responses in OpenAPI ergänzen und anpassen #224

Open
4 tasks
jackDS008 opened this issue Jul 2, 2022 · 0 comments
Open
4 tasks

Responses in OpenAPI ergänzen und anpassen #224

jackDS008 opened this issue Jul 2, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jackDS008
Copy link
Collaborator

User story

  1. As a Developer
  2. I want / need a well documentated OpenAPI
  3. So that I can further develop new features

Acceptance criteria

  • Fehlende Responses wurden ergänzt
  • Fehlende Schemas/Definitions wurden ergänzt
  • Die 200 Responses in der OpenAPI geben den tatsächlichen Response als Schema/Definition zurück und nicht "Returns Response JSON." oder ähnliches
  • Die Endpunkte sind einheitlich beschrieben

Definition of done (DoD)

  • code peer-reviewed (by at least one team member)
  • acceptance criteria met
  • integrated into a clean build
  • documentation updated
  • code is well-formatted (according to our norms) and structure
  • Code supports all functions/cases and all responses defined in the API
  • no severe bugs during main functionalities (program should not stop executing due to these bugs, e.g. runtime exception in Docker)
  • Bill of Materials updated if necessary
  • 70% of the tests pass
  • important functions shall be tested
  • Code has been deployed via Docker to the server

DoD general criteria

  • Feature has been fully implemented
  • Feature has been merged into the mainline
  • All acceptance criteria were met
  • Product owner approved features
  • All tests are passing
  • Developers agreed to release
@jackDS008 jackDS008 added the documentation Improvements or additions to documentation label Jul 2, 2022
@jackDS008 jackDS008 added this to Product Backlog in Feature Backlog via automation Jul 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Feature Backlog
Product Backlog
Development

No branches or pull requests

1 participant