Skip to content

Implement regular pickup RestAPI

KoeMai requested to merge 1373_build_restapi_for_regular_pickup_backend into master

Closes #1373 (closed) regular pickup API implementation

What does this MR do?

Adds an OpenAPI for regular pickup configuration for a store.

This allows configuring the regular picks for a store via RESTapi.

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

Not expected, it is an additional way to configure the regular pickups and should replace the very old Xhr way.

How to test

  1. Checkout branch locally
  2. Login as foodsaver
  3. Save PHP_SESSION token for postman
  4. Open postman
  5. Run a PUT method on "http://localhost:18090/api/stores/5/regularPickup" with [{ "weekday": 1, "startTimeOfPickup": "12:01", "maxCountOfSlots": 5 }, { "weekday": 1, "startTimeOfPickup": "12:00", "maxCountOfSlots": 5 }]
  6. Run a 'GET' method to ready the change back -->

Checklist

  • Design API
  • Discuss API
  • Implement API (Basic)
  • Add API tests
  • no unrelated changes
  • asked someone for a code review
  • set a "for:" label to indicate who will be affected by this change
  • 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

Edited by KoeMai

Merge request reports