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

Update README.md for farmdata2_api #631

Open
7 tasks
JingyuMarcelLee opened this issue Mar 6, 2023 · 0 comments
Open
7 tasks

Update README.md for farmdata2_api #631

JingyuMarcelLee opened this issue Mar 6, 2023 · 0 comments
Assignees
@JingyuMarcelLee
Labels
documentation Improvements or additions to documentation

Comments

@JingyuMarcelLee
Copy link
Collaborator

JingyuMarcelLee commented Mar 6, 2023 •
edited
Loading

The README.md file in farmdata2/farmdata2_api needs to be updated so that it covers the Express API addition to FarmData2.

Below are the tentative topics that need to be covered

  • Explain that the Swagger documentation for the APIs available at fd2_api/docs
  • Explain how to create API endpoints
    • Automatic generation of Swagger documentation must follow OpenAPI Specifications. (Links to this should be included)
    • Conventions for endpoint naming and paths
    • How to write SQL Queries and how to test them using phpMyAdmin
  • How to test the endpoints (Testing is not available yet. TODO)
  • How to refactor FarmOSAPI.js to update the mapping functions used in pages
@braughtg braughtg added the documentation Improvements or additions to documentation label Mar 14, 2023
@WarpWing WarpWing mentioned this issue Mar 2, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JingyuMarcelLee JingyuMarcelLee

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@braughtg @JingyuMarcelLee