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

Improved the operationIds by implementing a post hook function #3021

Merged
merged 7 commits into from Jul 23, 2023

Conversation

varshadr
Copy link
Contributor

Fixes #3000
This PR removes the prefixes api_db_v0_ and api_ui_v0_ that were present in the operationIds generated by the drf sppectacular library. This was done by implementing a Post Processing hook function.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added 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.

@varshadr varshadr added type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL ready Ready for implementation labels Jul 10, 2023
@varshadr varshadr self-assigned this Jul 10, 2023
@varshadr varshadr added pr-status: review A PR awaiting review and removed ready Ready for implementation labels Jul 10, 2023
@varshadr varshadr assigned silentninja and unassigned varshadr Jul 10, 2023
@rajatvijay rajatvijay added this to the GSoC 2023 milestone Jul 11, 2023
Copy link
Contributor

@silentninja silentninja 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! I renamed the function name of the postprocessing hook for clarity. Please fix the lint error and merge it.

@silentninja silentninja assigned varshadr and unassigned silentninja Jul 21, 2023
@silentninja silentninja added pr-status: revision A PR awaiting follow-up work from its author after review and removed pr-status: review A PR awaiting review labels Jul 21, 2023
@varshadr
Copy link
Contributor Author

Looks good! I renamed the function name of the postprocessing hook for clarity. Please fix the lint error and merge it.

Sure, I'll do that!

@varshadr
Copy link
Contributor Author

@silentninja, I have fixed the lint error. Can you please verify it?

@silentninja silentninja added this pull request to the merge queue Jul 23, 2023
Merged via the queue into develop with commit 395518a Jul 23, 2023
21 checks passed
@silentninja silentninja deleted the 3000-improve-operationids-for-the-endpoints branch July 23, 2023 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Improve OperationIDs for the Endpoints
3 participants