API Documentation Detail

[sanskarm7]

DB Design / Changes:

• db migrations + process of implementation of a new db change + documentation for all moving parts (db dump, process of running migration file on local instance, testing scraper - where to find script)
• db naming conventions
• buildQuery

Scraper:

• documentation on understanding wrangler.toml files, how scrapers work, what to expect from them

Endpoint:

• error codes and meanings GOOD PRACTICE - along with endpoint info.
• rest endpoint
  • all files changed
  • areas of focus, things to look out for
  • what a typical change entails
• graphql
  • difference between rest and graphql
  • example of implementation
  • where to test on docs page
    Testing:
    • testing throughout the process [db change -> endpoint]