Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Make improvements to the oEmbed endpoint #934

Merged
merged 3 commits into from
Sep 23, 2022
Merged

Make improvements to the oEmbed endpoint #934

merged 3 commits into from
Sep 23, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Sep 22, 2022

Fixes

Fixes #927 by @AetherUnbound
Addresses #925 by @chrisbartoloburlo

Description

This PR fixes the issue of AssertionErrors being raised instead of a 404 response. The docs for get_api_exception say that they are supposed to be used with the raise keyword as what it returns are exceptions, not responses.

This PR also handles trailing slashes in URLs. We have been consistently pushes for uniformly using trailing URLs everywhere so our own endpoints should reasonably support them. This is a backwards compatible change.

This PR also adds tests for these changes so that we never regress on them in the future.

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.

@dhruvkb dhruvkb added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Sep 22, 2022
@dhruvkb dhruvkb requested a review from a team as a code owner September 22, 2022 10:45
@dhruvkb dhruvkb requested review from krysal and obulat September 22, 2022 10:45
@dhruvkb dhruvkb changed the title Use raise with get_api_exception Make improvements to the oEmbed endpoint Sep 22, 2022
@github-actions
Copy link

github-actions bot commented Sep 22, 2022

API Developer Docs Preview: Ready

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

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.

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for the additional tests!

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

@dhruvkb dhruvkb merged commit e1266ff into main Sep 23, 2022
@dhruvkb dhruvkb deleted the oembed_fix branch September 23, 2022 17:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Oembed endpoint raises uncaught error on non-existent identifier
3 participants