Accept body parameters for /api/pleroma/notification_settings

Oneric commented

2024-04-09 02:16:32 +00:00

Member

This brings it in line with its documentation and akkoma-fe’s expectations. For backwards-compatibility URL parameters are also still
accept with lower priority. Unfortunately this means duplicating the parameters and description in the API spec.

Usually Plug already pre-merges parameters from different sources into the plain params parameter which also gets forwarded by Phoenix.
However OpenApiSpex 3.x prevents this albeit a change is planned for 4.x, see:
https://github.com/open-api-spex/open_api_spex/issues/334
https://github.com/open-api-spex/open_api_spex/issues/92

Fixes: #691
Fixes: #722

This brings it in line with its documentation and akkoma-fe’s expectations. For backwards-compatibility URL parameters are also still accept with lower priority. Unfortunately this means duplicating the parameters and description in the API spec. Usually Plug already pre-merges parameters from different sources into the plain params parameter which also gets forwarded by Phoenix. However OpenApiSpex 3.x prevents this albeit a change is planned for 4.x, see: https://github.com/open-api-spex/open_api_spex/issues/334 https://github.com/open-api-spex/open_api_spex/issues/92 Fixes: https://akkoma.dev/AkkomaGang/akkoma/issues/691 Fixes: https://akkoma.dev/AkkomaGang/akkoma/issues/722

Oneric added 1 commit 2024-04-09 02:16:33 +00:00

ci/woodpecker/pr/lint Pipeline was successful Details

ci/woodpecker/pr/test Pipeline was successful Details

ci/woodpecker/pr/build-amd64 unknown status Details

ci/woodpecker/pr/build-arm64 unknown status Details

ci/woodpecker/pr/docs unknown status Details

bd74ad9ce4 Accept body parameters for /api/pleroma/notification_settings

This brings it in line with its documentation and akkoma-fe’s
expectations. For backwards compatibility URL parameters are still
accept with lower priority. Unfortunately this means duplicating
parameters and descriptions in the API spec.

Usually Plug already pre-merges parameters from different sources into
the plain 'params' parameter which then gets forwarded by Phoenix.
However, OpenApiSpex 3.x prevents this; 4.x is set to change this
  https://github.com/open-api-spex/open_api_spex/issues/334
  https://github.com/open-api-spex/open_api_spex/issues/92

Fixes: #691
Fixes: #722

floatingghost commented

2024-04-13 22:54:59 +00:00

Owner

all seems good, thanks!

floatingghost merged commit c1f0b6b875 into develop

2024-04-13 22:55:02 +00:00

floatingghost deleted branch notif-setting-parameters

2024-04-13 22:55:03 +00:00

floatingghost referenced this issue from a commit

2024-04-13 22:55:05 +00:00

Merge pull request 'Accept body parameters for /api/pleroma/notification_settings' (#738) from Oneric/akkoma:notif-setting-parameters into develop

Accept body parameters for /api/pleroma/notification_settings #738