Fixed OpenAPI definition generation of paging parameters

maritimeconnectivity / ServiceRegistry

MCP (Maritime Connectivity Platform) Service Registry API

Apache License 2.0

2 stars 2 forks source link

Fixed OpenAPI definition generation of paging parameters #44

Closed oliverhaagh closed 2 years ago

oliverhaagh commented 2 years ago

The Pageable object that is taken as a parameter to endpoints that support was previously being translated to a JSON object that should be given as query parameter which is not allowed in GET calls. Adding the @ParameterObject annotation tells springdoc that a Pageable object should be translated to paging attributes (page, size and sort) instead of a JSON object.

nvasta commented 2 years ago

Nice one! Can we also do this for the XMLController?

oliverhaagh commented 2 years ago

Ah yes, good catch, missed that one! I'll add it to the PR

oliverhaagh commented 2 years ago

Done!

nvasta commented 2 years ago

Seems good to me... they checks build fails for some reason... only happens here.. not sure why... I'll accept anyway

oliverhaagh commented 2 years ago

Thx! Yeah, I have also noticed that the build job fails... for some reason though it succeeded on the first commit in this PR, and then failed on the second... could maybe be some kind of caching issue?