From caf98ba60b8a2b364405beeef15958695ae2351e Mon Sep 17 00:00:00 2001 From: moanos Date: Sun, 24 Nov 2024 11:51:37 +0100 Subject: [PATCH] docs: Add two endpoints --- docs/API/index.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/API/index.rst b/docs/API/index.rst index 5ee1f67..f1ed29e 100644 --- a/docs/API/index.rst +++ b/docs/API/index.rst @@ -26,3 +26,29 @@ An application can then send this token in the request header for authorization. .. code-block:: $ curl -X GET http://notfellchen.org/api/adoption_notice -H 'Authorization: Token 49b39856955dc6e5cc04365498d4ad30ea3aed78' + +Endpoints +--------- + +Get Adoption Notices +++++++++++++++++++++ + +.. code-block:: + curl --request GET \ + --url http://localhost:8000/api/adoption_notice \ + --header 'Authorization: {{token}}' + +Create Adoption Notice +++++++++++++++++++++++ + +.. code-block:: + curl --request POST \ + --url http://localhost:8000/api/adoption_notice \ + --header 'Authorization: {{token}}' \ + --header 'content-type: multipart/form-data' \ + --form name=TestAdoption1 \ + --form searching_since=2024-11-19 \ + --form 'description=Lorem ipsum **dolor sit** amet' \ + --form further_information=https://notfellchen.org \ + --form location_string=Berlin \ + --form group_only=true \ No newline at end of file