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 the command that generates the API documentation schema file to the documentation. #2935

Closed
Tracked by #2888
silentninja opened this issue Jun 9, 2023 · 0 comments · Fixed by #2970
Closed
Tracked by #2888
Assignees
Labels
type: enhancement New feature or request work: documentation Improvements or additions to documentation
Milestone

Comments

@silentninja
Copy link
Contributor

silentninja commented Jun 9, 2023

Problem

There is lack of instructions on how to generate the API schema file necessary for API documentation.

Proposed solution

Add the following command in the documentation:
./manage.py spectacular --color --file schema.yml
On running this command in mathesar_service_dev , will generate the API schema file (schema.yml) necessary for API documentation.

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: documentation Improvements or additions to documentation
Projects
No open projects
3 participants