Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix incorrect OpenAPI examples #5160

Merged
merged 7 commits into from
Nov 14, 2024
Merged

Fix incorrect OpenAPI examples #5160

merged 7 commits into from
Nov 14, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 13, 2024

Fixes

Fixes #4885 by @zackkrida

Description

This PR corrects the OpenAPI examples for

  • stats, search and related endpoints (for both image and audio media types)
  • removes unnecessary nesting under application/json everywhere
  • removes redundant variables and arguments (code-quality improvements)

Testing Instructions

  1. Check out the PR and run the API dev server.
  2. Visit the OpenAPI spec at http://localhost:50280/v1/.
  3. Check that the OpenAPI examples, specifically for the endpoints with corrections mentioned above, are correct.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate 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.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

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 changed the title Remove unnecessary nesting under application/json Fix incorrect OpenAPI examples Nov 13, 2024
@openverse-bot openverse-bot added 🧱 stack: api Related to the Django API 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase labels Nov 13, 2024
@dhruvkb dhruvkb marked this pull request as ready for review November 13, 2024 07:25
@dhruvkb dhruvkb requested a review from a team as a code owner November 13, 2024 07:25
@dhruvkb dhruvkb requested review from krysal and obulat and removed request for a team November 13, 2024 07:25
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.

LGTM! It's nice to remove a level of indentation with the gone "application/json" in many cases.

@dhruvkb dhruvkb merged commit d5740c8 into main Nov 14, 2024
83 of 87 checks passed
@dhruvkb dhruvkb deleted the fix_openapi_eg branch November 14, 2024 03:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: api Related to the Django API
Projects
Status: 🤝 Merged
Development

Successfully merging this pull request may close these issues.

Media list endpoints have incorrect OpenAPI (previously Swagger) example definitions
3 participants