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

Implemeted extend schema decorator to document the error response for /databases/ endpoint #3070

Closed

Conversation

varshadr
Copy link
Contributor

Fixes #3068

This pull request introduces the Extend Schema decorator to the DatabasesViewSet. By utilizing the decorator, we will document the missing 404 error response for /api/ui/v0/databases/{id}/types/, that DRF spectacular failed to document.

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 pr-status: review A PR awaiting review labels Jul 19, 2023
@varshadr varshadr added this to the GSoC 2023 milestone Jul 19, 2023
@varshadr varshadr linked an issue Jul 19, 2023 that may be closed by this pull request
@varshadr varshadr requested a review from silentninja July 19, 2023 17:35
@github-actions
Copy link

github-actions bot commented Sep 2, 2023

This pull request has not been updated in 45 days and is being marked as stale. It will automatically be closed in 30 days if not updated by then.

@github-actions github-actions bot added the stale label Sep 2, 2023
@silentninja silentninja removed the stale label Sep 5, 2023
@silentninja silentninja assigned varshadr and unassigned silentninja Oct 19, 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 Oct 19, 2023
@mathemancer
Copy link
Contributor

We're reprioritizing, and unfortunately, we can't continue the documentation project.

@kgodey kgodey deleted the 3068-fix-the-error-response-for-databases-endpoint branch March 8, 2024 20:47
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.

Fix the error response for /databases/ endpoint
3 participants