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

Add OpenAPI Specification for /queries/ endpoint and fix the incorrect specs #3253

Closed
Tracked by #2958
varshadr opened this issue Oct 21, 2023 · 0 comments · Fixed by #3265
Closed
Tracked by #2958

Add OpenAPI Specification for /queries/ endpoint and fix the incorrect specs #3253

varshadr opened this issue Oct 21, 2023 · 0 comments · Fixed by #3265
Assignees
Labels
ready Ready for implementation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL work: documentation Improvements or additions to documentation
Milestone

Comments

@varshadr
Copy link
Contributor

varshadr commented Oct 21, 2023

This is a part of the API Documentation project #2888

Problem

To ensure the accuracy of the specs generated by drf-spectacular, we will generate an OpenAPI Specification specifically for a particular endpoint. This will allow us to verify its correctness by comparing it with the existing test cases and the DRF browsable API page. This issue aims to generate spec for /queries/ endpoint.

Proposed solution

  • Add /queries/ to the custom preprocessing hook function to filter out all endpoints except for the /queries/ endpoint.
  • Generate the spec file using the ./manage.py spectacular --color --file schema.yml command
@varshadr varshadr self-assigned this Oct 21, 2023
@varshadr varshadr added work: documentation Improvements or additions to documentation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL status: started labels Oct 21, 2023
@varshadr varshadr added this to the GSoC 2023 milestone Oct 21, 2023
@varshadr varshadr linked a pull request Oct 27, 2023 that will close this issue
7 tasks
@seancolsen seancolsen added ready Ready for implementation and removed status: started labels Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Ready for implementation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL work: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants