diff options
author | Drew DeVault <sir@cmpwn.com> | 2019-06-11 13:02:48 -0400 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2019-06-11 13:02:48 -0400 |
commit | 7eb4c7abc2e902617f2776fb5d8b43fe57216ca0 (patch) | |
tree | 33c89f1fa0000ff6c3934b2f0c7f546ac352dda4 /todo.sr.ht | |
parent | b10436f201f5ec4568c1c3eda852a6f57a8cd79f (diff) | |
download | sr.ht-docs-7eb4c7abc2e902617f2776fb5d8b43fe57216ca0.tar.gz |
Fix underscores on todo.sr.ht/api.md
Diffstat (limited to 'todo.sr.ht')
-rw-r--r-- | todo.sr.ht/api.md | 41 |
1 files changed, 21 insertions, 20 deletions
diff --git a/todo.sr.ht/api.md b/todo.sr.ht/api.md index 42dbe77..e4a9624 100644 --- a/todo.sr.ht/api.md +++ b/todo.sr.ht/api.md @@ -61,20 +61,20 @@ Short form: } ``` -**Event type** may be one or more of created, comment, status_change, -label_added, label_removed, assigned_user, unassigned_user, user_mentioned, or -ticket_mentioned. +**Event type** may be one or more of `created`, `comment`, `status_change`, +`label_added`, `label_removed`, `assigned_user`, `unassigned_user`, +`user_mentioned`, or `ticket_mentioned`. -**Status** fields may be one of reported, confirmed, in_progress, pending, or -resolved. +**Status** fields may be one of `reported`, `confirmed`, `in_progress`, +`pending`, or `resolved`. -**Resolution** fields may be one of unresolved, fixed, implemented, wont_fix, -by_design, invalid, duplicate, or not_our_bug. +**Resolution** fields may be one of `unresolved`, `fixed`, `implemented`, +`wont_fix`, `by_design`, `invalid`, `duplicate`, or `not_our_bug`. -The by_user and from_ticket features are used for events where a ticket or user -was mentioned in a comment somewhere. The ticket field and user field are set to -the mentioned ticket or user, and the by_user or from_ticket field are set -according to the discussion where the mention occured. +The `by_user` and `from_ticket` features are used for events where a ticket or +user was mentioned in a comment somewhere. The ticket field and user field are +set to the mentioned ticket or user, and the `by_user` or `from_ticket` field +are set according to the discussion where the mention occured. ### Label resource @@ -126,14 +126,14 @@ Short form: } ``` -**Status** fields may be one of reported, confirmed, in_progress, pending, or -resolved. +**Status** fields may be one of `reported`, `confirmed`, `in_progress`, +`pending`, or `resolved`. -**Resolution** fields may be one of unresolved, fixed, implemented, wont_fix, -by_design, invalid, duplicate, or not_our_bug. +**Resolution** fields may be one of `unresolved`, `fixed`, `implemented`, +`wont_fix`, `by_design`, `invalid`, `duplicate`, or `not_our_bug`. -**Permissions** may be one or more of browse, submit, comment, edit, and triage. -If null, the permissions are inherited from the tracker. +**Permissions** may be one or more of `browse`, `submit`, `comment`, `edit`, and +`triage`. If null, the permissions are inherited from the tracker. Short form: @@ -162,7 +162,8 @@ Short form: } ``` -**Permissions** may be one or more of browse, submit, comment, edit, and triage. +**Permissions** may be one or more of `browse`, `submit`, `comment`, `edit`, and +`triage`. Short form: @@ -185,8 +186,8 @@ Retrieves a user resource. ### GET /api/user -Equivalent to [/api/user/:username](#GET-apiuserusername), implies the authenticated -user. +Equivalent to [/api/user/:username](#GET-apiuserusername), implies the +authenticated user. ### GET /api/user/:username/trackers |