From 262b6bf22ed24c8004c7d193031c9965ae9df278 Mon Sep 17 00:00:00 2001 From: bytedream Date: Thu, 9 Dec 2021 21:04:20 +0100 Subject: [PATCH] Initial api definition --- api.yaml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 api.yaml diff --git a/api.yaml b/api.yaml new file mode 100644 index 0000000..7dbcb1c --- /dev/null +++ b/api.yaml @@ -0,0 +1,37 @@ +openapi: 3.0.3 +info: + title: TheAdversary api + description: TheAdversary api + version: 1.0.0 +servers: + - url: 'https://localhost:8080' +paths: + /recent: + get: + summary: Get recent articles + parameters: + - in: query + name: limit + schema: + type: integer + description: Limit of recent articles to return + responses: + 200: + description: OK + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: Title of the article + summary: + type: string + description: A short overview summary of the article + image: + type: string + description: Link to a preview image + link: + type: string + description: Link to the article itself