trustcafe-api-wrapper/development.md
2026-04-16 21:31:32 +01:00

36 lines
1.3 KiB
Markdown

# Things to think about do
## Debates
1. Hating the name `jobs` and `run_job`. Requests is an
existing package dependency though. `tasks` seems to broard. I'm sure
there's probably an already existing name that I can't articulate how
to find. `apirequests`, `rqsts`, `apicalls`?
2. Should these `job` be called with dot notation? Or with slashes? Or
something else? Is it okay to have these as strings?
3. Should we do validation in the `jobs` or let the server do that all?
4. `wrapped` is an awkward name. What's more proper? But also obvious?
5. Should have consistent format, ie `create_{noun}`, and
`delete_{noun}`, rather than just verbing ie `comment`, `post` as this
is ambiguousetc
6. Known/displayed entity names or as-is/DB names, ie: `trust` or
`reltrust`? We call trust as reltrust in the database and in the
backend, relfollow for follow, but don't have relblock, instead it's
userblock. It's a bit inconsistent and not very obvious at all.
Feels helpful to make it more obvious inside the wrapper but is also
potentially misleading.
## ToDo:
1. Make more jobs
2. Make more wrappers
3. Write more documentation
4. Wrappers should also accept actual keys for when you know them
Trust
Follow
Mute
Block
Remvoved posts