From 169d60abc7e0ee191bfb66ecb1fbbac14ab88095 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Fri, 18 Mar 2016 16:24:05 +0100 Subject: Transferring API Description file from Apiary.io --- apiary.apib | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 apiary.apib diff --git a/apiary.apib b/apiary.apib new file mode 100644 index 00000000..cd355a1e --- /dev/null +++ b/apiary.apib @@ -0,0 +1,80 @@ +FORMAT: 1A +HOST: http://polls.apiblueprint.org/ + +# wallabag + +Polls is a simple API allowing consumers to view polls and vote in them. + +## Questions Collection [/questions] + +### List All Questions [GET] + ++ Response 200 (application/json) + + [ + { + "question": "Favourite programming language?", + "published_at": "2015-08-05T08:40:51.620Z", + "choices": [ + { + "choice": "Swift", + "votes": 2048 + }, { + "choice": "Python", + "votes": 1024 + }, { + "choice": "Objective-C", + "votes": 512 + }, { + "choice": "Ruby", + "votes": 256 + } + ] + } + ] + +### Create a New Question [POST] + +You may create your own question using this action. It takes a JSON +object containing a question and a collection of answers in the +form of choices. + ++ Request (application/json) + + { + "question": "Favourite programming language?", + "choices": [ + "Swift", + "Python", + "Objective-C", + "Ruby" + ] + } + ++ Response 201 (application/json) + + + Headers + + Location: /questions/2 + + + Body + + { + "question": "Favourite programming language?", + "published_at": "2015-08-05T08:40:51.620Z", + "choices": [ + { + "choice": "Swift", + "votes": 0 + }, { + "choice": "Python", + "votes": 0 + }, { + "choice": "Objective-C", + "votes": 0 + }, { + "choice": "Ruby", + "votes": 0 + } + ] + } \ No newline at end of file -- cgit v1.2.3