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

Added the command that generates the API documentation schema file to… #2970

Merged
merged 2 commits into from Jun 27, 2023

Conversation

varshadr
Copy link
Contributor

Fixes #2935

Technical details
Added the following command in the API README.md FILE:

./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.

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 self-assigned this Jun 25, 2023
@varshadr varshadr added the work: documentation Improvements or additions to documentation label Jun 25, 2023
@rajatvijay rajatvijay assigned silentninja and unassigned varshadr Jun 26, 2023
@rajatvijay rajatvijay added the pr-status: review A PR awaiting review label Jun 26, 2023
@rajatvijay rajatvijay added this to the Backlog milestone Jun 26, 2023
Copy link
Contributor

@silentninja silentninja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. The command can be used in all the Mathesar environments and not just the development container, so I removed specifically mentioning mathesar_dev_service

@silentninja silentninja added this pull request to the merge queue Jun 27, 2023
Merged via the queue into develop with commit c35c5c4 Jun 27, 2023
6 checks passed
@silentninja silentninja deleted the api_documentation branch June 27, 2023 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review work: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add the command that generates the API documentation schema file to the documentation.
3 participants