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

Remove query_serializer for reporting endpoints#577

Merged
dhruvkb merged 1 commit intomainfrom
fix_query_body
Mar 22, 2022
Merged

Remove query_serializer for reporting endpoints#577
dhruvkb merged 1 commit intomainfrom
fix_query_body

Conversation

@dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Mar 20, 2022

Description

The reporting endpoints for audio and image had the query_serializer set on the Swagger operation. This caused the schema of the data sent in the POST body to be shown as the query parameters.

Screenshot on main:
Screenshot 2022-03-20 at 11 27 16 AM

By removing the query_serializer, this duplication is gone and the information appears in the correct location.

Screenshot from PR:
Screenshot 2022-03-20 at 11 27 42 AM

Testing Instructions

  1. Check out the PR and run the services using just up.
  2. Visit the API docs for the image and audio report endpoints.

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: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository labels Mar 20, 2022
@dhruvkb dhruvkb requested a review from a team as a code owner March 20, 2022 07:28
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Nice catch!

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 to me! I was able to spin up the container and see that the duplicated text was no longer present.

@dhruvkb dhruvkb merged commit 9147429 into main Mar 22, 2022
@dhruvkb dhruvkb deleted the fix_query_body branch March 22, 2022 03:50
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants