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

replace status name Too Hard in API docs #1075

Merged
merged 1 commit into from
Nov 30, 2023
Merged

replace status name Too Hard in API docs #1075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/org/maproulette/data/DataManager.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ case class ActionSummary(
def percentComplete: Double = (((trueAvailable / total) * 100) - 100) * -1

// available in the database means it is created state, available in the UI, means that it is in state
// AVAILABLE, SKIPPED or TOO HARD
// AVAILABLE, SKIPPED or CAN'T COMPLETE (Formerly TOO HARD)
def trueAvailable: Double = available + skipped + deleted

def percentage(value: Double): Double = (value / total) * 100
Expand Down
12 changes: 6 additions & 6 deletions conf/v2_route/challenge.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ DELETE /challenge/:id @org.maproulette.controllers
# description: The id of the Challenge being deleted
# - name: statusFilters
# in: query
# description: A comma separated list of status ID's. 0 = Created, 1 = Fixed, 2 = False Positive, 3 = Skipped, 4 = Deleted, 5 = Already Fixed, 6 = Too Hard
# description: A comma separated list of status ID's. 0 = Created, 1 = Fixed, 2 = False Positive, 3 = Skipped, 4 = Deleted, 5 = Already Fixed, 6 = Can't Complete
###
DELETE /challenge/:id/tasks @org.maproulette.controllers.api.ChallengeController.deleteTasks(id:Long, statusFilters ?= "")
###
Expand Down Expand Up @@ -900,7 +900,7 @@ GET /challenge/:cid/previousTask/:id @org.maproulette.controllers
# description: The id of the parent Challenge limiting the tasks to only a descendent of that Challenge.
# - name: status
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: priority
# in: query
# description: Can filter the Tasks returned by the priority of the Task. 0 - High, 1 - Medium, 2 - Low
Expand Down Expand Up @@ -939,7 +939,7 @@ GET /challenge/view/:id @org.maproulette.controllers
# description: The id of the parent Challenge limiting the tasks to only a descendent of that Challenge.
# - name: status
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: priority
# in: query
# description: Can filter the Tasks returned by the priority of the Task. 0 - High, 1 - Medium, 2 - Low
Expand Down Expand Up @@ -979,7 +979,7 @@ POST /challenge/view/:id @org.maproulette.controllers
# description: The id of the parent project.
# - name: filter
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
###
GET /challenge/clustered/:id @org.maproulette.controllers.api.ChallengeController.getClusteredPoints(id:Long, filter:String ?= "", limit:Int ?= 2500, excludeLocked:Boolean ?= false)
###
Expand Down Expand Up @@ -1090,7 +1090,7 @@ GET /challenge/:id/comments/extract @org.maproulette.controllers
# description: Used in conjunction with the limit parameter to page through X number of responses. Default value is 0, ie. first page.
# - name: status
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: priority
# in: query
# description: Can filter the Tasks returned by the priority of the Task. 0 - High, 1 - Medium, 2 - Low
Expand Down Expand Up @@ -1146,7 +1146,7 @@ GET /challenge/:id/extractReviewHistory @org.maproulette.control
# description: Used in conjunction with the limit parameter to page through X number of responses. Default value is 0, ie. first page.
# - name: status
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: priority
# in: query
# description: Can filter the Tasks returned by the priority of the Task. 0 - High, 1 - Medium, 2 - Low
Expand Down
8 changes: 4 additions & 4 deletions conf/v2_route/task.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ PUT /task/:id/responses @org.maproulette.framework
###
# tags: [ Task ]
# summary: Update Task Status
# description: Will update a Tasks status to one of the following. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Will update a Tasks status to one of the following. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# responses:
# '304':
# description: No Content, update successful
Expand All @@ -596,7 +596,7 @@ PUT /task/:id/responses @org.maproulette.framework
# description: The ID of the task
# - name: status
# in: path
# description: The status to update the Task too. Following status Integers can be used. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: The status to update the Task too. Following status Integers can be used. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: comment
# in: query
# description: Any comment that is provided by the user when setting the status
Expand All @@ -618,7 +618,7 @@ PUT /task/:id/:status @org.maproulette.controllers
###
# tags: [ Task ]
# summary: Update Bundle Task Status
# description: Will update a Bundled list of Tasks statuses to one of the following. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Will update a Bundled list of Tasks statuses to one of the following. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# responses:
# '200':
# description: TaskBundle
Expand All @@ -635,7 +635,7 @@ PUT /task/:id/:status @org.maproulette.controllers
# description: The primary ID of the task for this bundle
# - name: status
# in: path
# description: The status to update the Task too. Following status Integers can be used. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: The status to update the Task too. Following status Integers can be used. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
# - name: comment
# in: query
# description: Any comment that is provided by the user when setting the status
Expand Down
4 changes: 2 additions & 2 deletions conf/v2_route/virtualchallenge.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ GET /virtualchallenge/:cid/previousTask/:id @org.maproulette.controllers
# description: The id of the parent Virtual Challenge limiting the tasks to only a descendent of that Virtual Challenge.
# - name: filter
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
###
GET /virtualchallenge/view/:id @org.maproulette.controllers.api.VirtualChallengeController.getVirtualChallengeGeoJSON(id:Long, filter:String ?= "")
###
Expand All @@ -265,7 +265,7 @@ GET /virtualchallenge/view/:id @org.maproulette.controllers
# description: The id of the parent project.
# - name: filter
# in: query
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Too Hard
# description: Can filter the Tasks returned by the status of the Task. 0 - Created, 1 - Fixed, 2 - False Positive, 3 - Skipped, 4 - Deleted, 5 - Already Fixed, 6 - Can't Complete
###
GET /virtualchallenge/clustered/:id @org.maproulette.controllers.api.VirtualChallengeController.getClusteredPoints(id:Long, filter:String ?= "")
###
Expand Down