Fix issue due to page_query_param not being a string

[dhruvkb]

Fixes

Fixes #722 by @AetherUnbound

Description

This PR fixes an error introduced in #699 that prevented the ReDoc pages from showing up. This is because the value of the field page_query_param is expected to be a string.

By setting pagination params to an empty list, this problem goes away.

Testing Instructions

0. Check out the PR and start the server.
1. Visit ReDoc at http://localhost:8000/v1.
2. See the pages without any errors.

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main) or a parent feature branch.
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[github-actions]

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/723

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

[obulat]

Fixes the error that prevents the docs from rendering!

[obulat]

🔥

[obulat]

When would this fail? On 500 error from the server? Would it fail on main?

[dhruvkb]

It fails for any non-success status code from the endpoint. So yes, it fails on main as curl returns exit code 22 if the response status code is 500.

[AetherUnbound]

Hmm, I'm trying this command against api-dev.openverse.engineering (which is currently failing to load) and it's passing just fine 😟 When I add the -L flag for curl it fails as you describe. Do we need that flag here too?

Update: It does not! I tried this locally on main and it failed as expected. I think it's because we aren't using a proxy in this case.

[AetherUnbound]

Love the addition of the smoke test!