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

3145 add openapi specification for /tables/ endpoint #3146

Merged
merged 3 commits into from Sep 17, 2023

Conversation

varshadr
Copy link
Contributor

Fixes #3145

This PR adds OpenAPI Specification for the /tables/ endpoint to the codebase

Technical details

  • Refined custom_preprocessing_hook to include '/api/db/v0/tables/' endpoint.
  • Finally, generated the spec for /tables/ endpoint using the _./manage.py spectacular --color --file schema.yml_ command

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 pr-status: revision A PR awaiting follow-up work from its author after review labels Aug 15, 2023
@varshadr varshadr added this to the GSoC 2023 milestone Aug 15, 2023
@varshadr varshadr linked an issue Aug 15, 2023 that may be closed by this pull request
@varshadr
Copy link
Contributor Author

@silentninja, could you please review the spec I generated for /tables/ endpoint?

@varshadr varshadr changed the title 3145 add openapi specification for tabels endpoint 3145 add openapi specification for /tables/ endpoint Aug 15, 2023
@rajatvijay rajatvijay removed the pr-status: revision A PR awaiting follow-up work from its author after review label Aug 16, 2023
@varshadr varshadr added status: draft and removed pr-status: review A PR awaiting review labels Aug 18, 2023
@varshadr varshadr added this pull request to the merge queue Sep 17, 2023
Merged via the queue into develop with commit 1899f96 Sep 17, 2023
27 checks passed
@varshadr varshadr deleted the 3145-add-openapi-specification-for-tabels-endpoint branch September 17, 2023 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

Add OpenAPI Specification for /tables/ endpoint
3 participants