From 2a06026e6bdafe609a6d718fc451e08a432f3638 Mon Sep 17 00:00:00 2001 From: wookie184 Date: Sat, 6 Jan 2024 18:35:33 +0000 Subject: [PATCH] Document api v1 paste show endpoint --- doc/usage.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/doc/usage.rst b/doc/usage.rst index d2ee7ca..a5a4fdb 100644 --- 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