From 9acaaf8ab1b68e0d592f79dd113be1fe403553b1 Mon Sep 17 00:00:00 2001 From: Rob Savoye Date: Sun, 17 Dec 2023 14:02:43 -0700 Subject: [PATCH] fix: Add column to tables for if supported by TM Admin --- docs/endpoints.md | 104 +++++++++++++++++++++++----------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/endpoints.md b/docs/endpoints.md index f80171c3..5412938f 100644 --- a/docs/endpoints.md +++ b/docs/endpoints.md @@ -4,16 +4,16 @@ Endpoints for managing User profiles. -| Tasking Manager | FMTM| -|-----------------|-----| -|Get paged list of all usernames|Get Users| +| Tasking Manager | FMTM|TM Admin| +|-----------------|-----|--------| +|Get paged list of all usernames|Get Users|UsersDB.getAll()| |Registers users without OpenStreetMap account|| -|Updates user info|| +|Updates user info||UsersDB.updateTable()| |Resends the verification email token to the logged in user|| |Get paged lists of users matching OpenStreetMap username filter|| -|Get user information by OpenStreetMap username|| +|Get user information by OpenStreetMap username|UsersDB.getByName()| |Get stats about users registered within a period of time|| -|Get user information by id|Get User by ID| +|Get user information by id|Get User by ID|UsersDB.getByID()| |Get a list of tasks a user has interacted with|| |Allows user to enable or disable expert mode|| |Allows PMs to set a user's mapping level|| @@ -27,46 +27,46 @@ Endpoints for managing User profiles. Endpoints for managing Organization profiles. -| Tasking Manager | FMTM| -|-----------------|-----| -| List all organisations|Get Organization|| -| Creates a new organisation|Create Organization|| -| Deletes an organisation|Delete Organizations|| -| Retrieves an organisation|Get Organization Detail|| -| Updates an organisation|Update Organization|| +| Tasking Manager | FMTM|TM Admin| +|-----------------|-----|--------| +| List all organisations|Get Organization|OrganizationsDB.getAll()| +| Creates a new organisation|Create Organization|OrganizationsDB.createTable()| +| Deletes an organisation|Delete Organizations||| +| Retrieves an organisation|Get Organization Detail|OrganizationsDB.getByID()| +| Updates an organisation|Update Organization|OrganizationsDB.updateTable()| | Return statistics about projects and active tasks of an organisation|| # Projects Endpoints for managing projects. -| Tasking Manager | FMTM| -|-----------------|-----| -|List and search for projects|Read Projects| -|Creates a tasking-manager project|Create Project| -|List and search projects by bounding box|| -|Get featured projects|| -|Get all projects for logged in admin|| -|Get popular projects|| -|Get similar projects|| -|Gets projects user has mapped|| +| Tasking Manager | FMTM|TM Admin| +|-----------------|-----|--------| +|List and search for projects|Read Projects|projectsDB.getAll()| +|Creates a tasking-manager project|Create Project|projectsDB.createTable()| +|List and search projects by bounding box||projectsDB.getByLocation()|| +|Get featured projects||projectsDB.updateTable()| +|Get all projects for logged in admin||projectsDB.getByWhere()| +|Get popular projects||projectsDB.getByWhere()| +|Get similar projects||projectsDB.getByWhere()| +|Gets projects user has mapped||projectsDB.getByWhere()| |Deletes a Tasking-Manager project|Delete Project| -|Get a specified project including it's area|Get Project Details| -|Updates a Tasking-Manager project|Update Project| -|Set a project as featured|| +|Get a specified project including it's area|Get Project Details|projectsDB.getByID()| +|Updates a Tasking-Manager project|Update Project|projectsDB.updataTable()| +|Set a project as featured||projectsDB.updateTable()| |Send message to all contributors of a project|| -|Unset a project as featured|| -|Transfers a project to a new user|| -|Get all user activity on a project|| -|Get latest user activity on all of project task|| -|Get all user contributions on a project|| -|Get contributions by day for a project|| -|Get AOI of Project|| +|Unset a project as featured||projectsDB.updateTable()| +|Transfers a project to a new user||projectsDB.updateTable()| +|Get all user activity on a project||projectsDB.getByWhere()| +|Get latest user activity on all of project task||projectsDB.getByWhere()| +|Get all user contributions on a project||projectsDB.getByWhere()| +|Get contributions by day for a project||projectsDB.getByWhere()| +|Get AOI of Project||projectsDB.getByID()| ||Upload Custom XLSForm| ||Project Partial Update| ||Upload Multi Project Boundary| -||Task Split| -||Upload Project Boundary| +||Task Split|| +||Upload Project Boundary|| ||Edit Project Boundary| ||Update Odk Credentials| ||Validate Form| @@ -94,27 +94,27 @@ Endpoints for managing projects. Endpoints for managing tasks in a project. -| Tasking Manager | FMTM| -|-----------------|-----| +| Tasking Manager | FMTM|TM Admin| +|-----------------|-----|--------| |Delete a list of tasks from a project|| -|Get all tasks for a project as JSON|Read Tasks| -|Extends duration of locked tasks|| -|Invalidate all validated tasks on a project|| -|Locks a task for mapping|| -|Lock tasks for validation|| +|Get all tasks for a project as JSON|Read Tasks|tasksDB.getAll()| +|Extends duration of locked tasks||tasksDB.getByWhere()| +|Invalidate all validated tasks on a project||| +|Locks a task for mapping||tasksDB.updateTable()| +|Lock tasks for validation||tasksDB.updateTable()| |Map all tasks on a project|| -|Set all bad imagery tasks as ready for mapping|| -|Reset all tasks on project back to ready, preserving history|| +|Set all bad imagery tasks as ready for mapping||tasksDB.updateTable()| +|Reset all tasks on project back to ready, preserving history||tasksDB.updateTable()| |Revert tasks by a specific user in a project|| |Split a task|| -|Unlock a task that is locked for mapping resetting it to its last status|| -|Unlock tasks that are locked for validation resetting them to their last status|| -|Undo a task's mapping status|Update Task Status| -|Set a task as mapped|Update Task Status| -|Set tasks as validated|Update Task Status| -|Validate all mapped tasks on a project|Update Task Status| -|Get task tiles intersecting with the aoi provided|| -|Get all tasks for a project as GPX|| +|Unlock a task that is locked for mapping resetting it to its last status||tasksDB.updateTable()| +|Unlock tasks that are locked for validation resetting them to their last status||tasksDB.updateTable()| +|Undo a task's mapping status|Update Task Status|tasksDB.updateTable()| +|Set a task as mapped|Update Task Status|tasksDB.updateTable()| +|Set tasks as validated|Update Task Status|tasksDB.updateTable()| +|Validate all mapped tasks on a project|Update Task Status|tasksDB.updateTable()| +|Get task tiles intersecting with the aoi provided||tasksDB.getByLocation()| +|Get all tasks for a project as GPX||tasks.getAll()| |Get all mapped tasks for a project grouped by username|| |Get all tasks for a project as OSM XML|| |Get a task's metadata|Get Task|