Backups/Mango
1
0
Fork 0
mirror of https://github.com/hkalexling/Mango.git synced 2025-08-03 11:25:29 -04:00
Code Issues Projects Releases Wiki Activity

Fix typos

Browse Source
This commit is contained in:
Alex Ling 2020-12-26 04:01:57 +00:00
parent df4deb1415
commit d50981c151
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/routes/api.cr
View File

@ -24,7 +24,7 @@ class APIRouter < Router
# Authentication # Authentication
All endpoints require authentication. After logging in, your session ID would be stored as a cookie named `mango-sessid-#{Config.current.port}`, which can be used to authenticate the API access. Note that all admin API endpoints (`/api/admin/...`) require the logged in user to have admin access. All endpoints require authentication. After logging in, your session ID would be stored as a cookie named `mango-sessid-#{Config.current.port}`, which can be used to authenticate the API access. Note that all admin API endpoints (`/api/admin/...`) require the logged-in user to have admin access.
# Terminologies # Terminologies
@ -252,7 +252,7 @@ class APIRouter < Router
}.to_json }.to_json
end end
Koa.describe "Returns the thumbanil generation progress between 0 and 1" Koa.describe "Returns the thumbnail generation progress between 0 and 1"
Koa.tag "admin" Koa.tag "admin"
Koa.response 200, ref: "$progressResult" Koa.response 200, ref: "$progressResult"
get "/api/admin/thumbnail_progress" do |env| get "/api/admin/thumbnail_progress" do |env|
@ -261,7 +261,7 @@ class APIRouter < Router
}.to_json }.to_json
end end
Koa.describe "Triggers a thumbanil generation" Koa.describe "Triggers a thumbnail generation"
Koa.tag "admin" Koa.tag "admin"
post "/api/admin/generate_thumbnails" do |env| post "/api/admin/generate_thumbnails" do |env|
spawn do spawn do
@ -288,7 +288,7 @@ class APIRouter < Router
end end
Koa.describe "Updates the reading progress of an entry or the whole title for the current user", <<-MD Koa.describe "Updates the reading progress of an entry or the whole title for the current user", <<-MD
When `eid` is provided, sets the reading progress the the entry to `page`. When `eid` is provided, sets the reading progress of the entry to `page`.
When `eid` is omitted, updates the progress of the entire title. Specifically: When `eid` is omitted, updates the progress of the entire title. Specifically:
@ -472,7 +472,7 @@ class APIRouter < Router
When `action` is set to `delete`, the behavior depends on `id`. If `id` is provided, deletes the specific job identified by the ID. Otherwise, deletes all **completed** jobs in the queue. When `action` is set to `delete`, the behavior depends on `id`. If `id` is provided, deletes the specific job identified by the ID. Otherwise, deletes all **completed** jobs in the queue.
When `action` is set to `retry`, the behaviro depends on `id`. If `id` is provided, restarts the job identified by the ID. Otherwise, retries all jobs in the `Error` or `MissingPages` status in the queue. When `action` is set to `retry`, the behavior depends on `id`. If `id` is provided, restarts the job identified by the ID. Otherwise, retries all jobs in the `Error` or `MissingPages` status in the queue.
MD MD
Koa.tag "admin" Koa.tag "admin"
Koa.path "action", desc: "The action to perform. It should be one of the followins: `delete`, `retry`, `pause` and `resume`." Koa.path "action", desc: "The action to perform. It should be one of the followins: `delete`, `retry`, `pause` and `resume`."
@ -513,7 +513,7 @@ class APIRouter < Router
end end
Koa.describe "Uploads a file to the server", <<-MD Koa.describe "Uploads a file to the server", <<-MD
Currently the only supported value for the `targe` parameter is `cover`. Currently the only supported value for the `target` parameter is `cover`.
### Cover ### Cover