SwitchboardAPI: Milestone

[LukSteib]

Milestone Scope Overview

Based on the https://github.com/makerdao-ses/switchboard-boilerplate/issues/3#issuecomment-1437098636

Scope: Milestone 1

• [x] Finalise document model requirement (see here)
• [x] Setup a project with a linter and a prettier
• [x] Setup ORM, declarative module structure
• [x] Setup tests for operations, models, database integration
• [x] Add CI steps to enforce tests, coverage, correct build outcome
• [x] Setup API playground (+possibly make database/code comments visible in the playground)
• [x] Add input validator (+possibly enforce its use via the config structure)
• [x] Implement authentication as a plugin/middleware
• [x] Enforce high code coverage
• [x] Setup advanced logging library like winston, enforce correct usage (via a readme guide, linter settings)
• [ ] Setup something like tsdoc (can be enforced via a linter rule)
• [ ] Setup database migrations
• [ ] Implement UI to login, create users and their API keys
• [ ] Implement authorization on per action bases
• [ ] Add CD steps to build and deploy staging on merge to main
• [ ] Store history of every record
• [ ] Store change requests (endpoint path, parsed request body, reference to the record version it produced)
• [ ] Store attached files (as base64 or upload them somewhere)
• [ ] Implement existing modules

[LukSteib]

Weekly Scope Planning KW 12

• [x] powerhouse-inc/switchboard#16 (@KirillDogadin-std)
• [x] powerhouse-inc/switchboard#23 (@KirillDogadin-std)
• [ ] powerhouse-inc/switchboard#21 (@KirillDogadin-std)
• [ ] Store history of every record (@valiafetisov)

Bonus

• [ ] powerhouse-inc/switchboard#22 (@KirillDogadin-std)
• [ ] Store change requests (endpoint path, parsed request body, reference to the record version it produced) (@valiafetisov)
• [x] powerhouse-inc/switchboard#24

[valiafetisov]

As discussed, I propose to push Enforce high code coverage with higher priority than Setup something like tsdoc, since powerhouse-inc/switchboard#21 showed some indirect dependency. I've edited the scope to reflect those points. Also, can we please link actual issues instead/in addition to the textual description?

[LukSteib]

Weekly Scope Planning KW 13

• [x] powerhouse-inc/switchboard#21
• [x] powerhouse-inc/switchboard#26
• [x] powerhouse-inc/switchboard#27
• [x] powerhouse-inc/switchboard#32
• [x] Investigate schema structure powerhouse-inc/switchboard#31
• [ ] Implement login interface
• [ ] Implement optional token restriction by origin

[LukSteib]

Weekly Scope Planning KW 14

• [x] powerhouse-inc/switchboard#39(@KirillDogadin-std)
• [x] powerhouse-inc/switchboard#22 (@KirillDogadin-std)
• [x] Implement user management interface to UI @valiafetisov
• [x] powerhouse-inc/powerhouse#357 @valiafetisov
• [x] powerhouse-inc/switchboard#30
• [ ] powerhouse-inc/switchboard#41 (@KirillDogadin-std)
• [ ] powerhouse-inc/powerhouse#358

[LukSteib]

Weekly Scope Planning KW 15

• [x] powerhouse-inc/switchboard#39(@KirillDogadin-std)
• [x] powerhouse-inc/switchboard#42 (@KirillDogadin-std)
• [x] powerhouse-inc/switchboard#38 (@valiafetisov)
• [ ] powerhouse-inc/switchboard#41 (@KirillDogadin-std)
• [ ] powerhouse-inc/powerhouse#358 (@valiafetisov)
• [ ] powerhouse-inc/switchboard#43

[LukSteib]

Weekly Scope Planning KW 16

• [x] powerhouse-inc/switchboard#45 (@KirillDogadin-std)
• [ ] powerhouse-inc/switchboard#41 (@KirillDogadin-std)
• [ ] powerhouse-inc/powerhouse#358 (@valiafetisov)
• [ ] powerhouse-inc/switchboard#43