Skip to content

Sort all REST endpoints into categories

Alex requested to merge update-rest-tags into master

Closes #1144 (closed), related to #511

What does this MR do?

Adds the @OpenApi\Tag annotation to all endpoints, which sorts them into categories in the Swagger documentation.

How confident are you it won't break things if deployed?

Absolutely

How to test

  1. Checkout branch locally
  2. Go to http://localhost:18080/api/doc/
  3. Check that all endpoints are sorted into a category

Checklist

  • added a test, or explain why one is not needed/possible...
  • no unrelated changes
  • asked someone for a code review
  • set a "for:" label to indicate who will be affected by this change
  • used "state:" labels to track this MR's state until it was beta tested
  • added to the next milestone (see https://gitlab.com/foodsharing-dev/foodsharing/-/milestones, unless it has a "for:Dev" label)
  • added an entry to CHANGELOG.md
  • added a short text that can be used in the release notes
  • Once your MR has been merged, you are responsible to create a testing issue in the Beta Testing forum: https://foodsharing.de/?page=bezirk&bid=734&sub=forum. Please change the MRs label to "state:Beta testing".
    • Consider writing a detailed description in German.
    • Describe in a few sentences, what should be tested from a user perspective.
    • Also mention different settings (e.g. different browsers, roles, ...) how this change can be tested.
    • Be aware, that also non technical people should understand.

Release notes text in German

Merge request reports