Document api v1 paste show endpoint

supakeen · Jan 6, 2024 · 2a06026 · 2a06026
1 parent 5b07f9d
commit 2a06026
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/usage.rst b/doc/usage.rst
@@ -65,6 +65,14 @@ To remove a paste a ``GET`` request to the ``removal`` URL returned is
 sufficient.
 
 
+/api/v1/paste/([A-Z2-7]+)(?:#.+)?
+--------------------------------
+Used to retrieve the paste with the given ID.
+
+  >>> requests.get("http://localhost:8000/api/v1/paste/74").json()
+  {"files": [{"name": "spam", "lexer": "python", "content": "eggs"}]}
+
+
 /api/v1/lexer
 -------------
 An endpoint to list all lexers available in the ``pinnwand`` instance whose