git.sr.ht: document push options

1 files changed, 8 insertions, 0 deletions

diff --git a/git.sr.ht/api.md b/git.sr.ht/api.md
index 5edc6e7..0c16dc1 100644
--- a/git.sr.ht/api.md
+++ b/git.sr.ht/api.md
@@ -405,6 +405,7 @@ executing `git push`. Your server has 5 seconds to respond to the HTTP request.
 ```json
 {
   "push": "uuid assigned to this push event",
+  "push-options": { map of push options },
   "pusher": { user resource },
   "refs": [
     {
@@ -425,3 +426,10 @@ executing `git push`. Your server has 5 seconds to respond to the HTTP request.
   ]
 }
 ```
+
+**Notes**
+
+- Push options (specified via `git push -o <option>`) are interpreted as
+  `key=value`, and the map is populated as such. For example, `git push -o
+  foo=bar` would result in `{"foo": "bar"}`. Options specified without a value -
+  e.g. `-o foo` - will have their value set to an empty string.