Initial api definition

2021-12-09 21:04:20 +01:00
commit 262b6bf22e
1 changed files with 37 additions and 0 deletions
--- a/api.yaml
+++ 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