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.

Sign up for GitHub

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

Jump to bottom

Integrate DRF Spectacular with Mathesar's backend codebase #2938

Closed
Tracked by #2888
varshadr opened this issue Jun 10, 2023 · 0 comments · Fixed by #2939
Closed
Tracked by #2888

Integrate DRF Spectacular with Mathesar's backend codebase #2938

varshadr opened this issue Jun 10, 2023 · 0 comments · Fixed by #2939
Assignees
@varshadr
Labels
ready Ready for implementation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL

Comments

@varshadr
Copy link
Contributor

varshadr commented Jun 10, 2023 •
edited

Why DRF Spectacular

-DRF Spectacular automatically generates comprehensive documentation based on OpenAPI specification for Mathesar's API.
-It is compatible with Mathesar's Django REST Framework

Proposed solution

-Add the "drf-spectacular" package to the project's dependencies
-Configure the SPECTACULAR_SETTINGS in the Mathesar's settings file
@varshadr varshadr added status: triage type: enhancement New feature or request labels Jun 10, 2023
@varshadr varshadr mentioned this issue Jun 10, 2023
Closed
@varshadr varshadr added ready Ready for implementation and removed status: triage labels Jun 10, 2023
@varshadr varshadr self-assigned this Jun 10, 2023
@varshadr varshadr added the work: backend Related to Python, Django, and simple SQL label Jun 10, 2023
@varshadr varshadr mentioned this issue Jun 11, 2023
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@varshadr varshadr

Labels
ready Ready for implementation type: enhancement New feature or request work: backend Related to Python, Django, and simple SQL
Projects
No open projects
[NO LONGER USED] Mathesar work tracker
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Integrated drf-spectacular library mathesar-foundation/mathesar
1 participant
@varshadr