aboutsummaryrefslogtreecommitdiffstats
path: root/git.sr.ht/api.md
diff options
context:
space:
mode:
Diffstat (limited to 'git.sr.ht/api.md')
-rw-r--r--git.sr.ht/api.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/git.sr.ht/api.md b/git.sr.ht/api.md
index c2ebce6..f8c2233 100644
--- a/git.sr.ht/api.md
+++ b/git.sr.ht/api.md
@@ -197,6 +197,38 @@ Deletes a [repository resource](#repository-resource).
**OAuth scope**: `info:write`
+### DELETE /api/repos/:name
+
+Deletes a [repository resource](#repository-resource).
+
+**OAuth scope**: `info:write`
+
+### GET /api/:username/repos/:name/readme
+### GET /api/repos/:name/readme
+
+Gets the repository README override, or 404 if none is set.
+
+The HTML returned from this endpoint is NOT sanitized.
+
+**OAuth scope**: `info:read`
+
+### PUT /api/repos/:name/readme
+
+Sets the repository README override.
+
+**OAuth scope**: `info:write`
+
+**Request body**
+
+`text/html` of new README to use for the repository, after sanitisiation.
+
+### DELETE /api/repos/:name/readme
+
+Unsets the repository README override, if any.
+The relevant files in the repository tip, if any, will be used; this is the default.
+
+**OAuth scope**: `info:write`
+
## Common data endpoints
Endpoints for fetching git data from repos.