rdv:add swagger config file for calendar bundle

src/Bundle/ChillCalendarBundle/chill.api.specs.yaml

@@ -0,0 +1,81 @@
+---
+openapi: "3.0.0"
+info:
+  version: "1.0.0"
+  title: "Chill api"
+  description: "Api documentation for chill. Currently, work in progress"
+servers:
+  - url: "/api"
+    description: "Your current dev server"
+
+paths:
+  /1.0/calendar/calendar.json:
+    get:
+      tags:
+        - calendar
+      summary: Return a list of all calendar items
+      responses:
+        200:
+          description: "ok"
+
+  /1.0/calendar/calendar/{id}.json:
+    get:
+      tags:
+        - calendar
+      summary: Return an calendar item by id
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The calendar id
+          schema:
+            type: integer
+            format: integer
+            minimum: 1
+      responses:
+        200:
+          description: "ok"
+        404:
+          description: "not found"
+        401:
+          description: "Unauthorized"
+
+  /1.0/calendar/calendar-range.json:
+    get:
+      tags:
+        - calendar
+      summary: Return a list of all calendar range items
+      responses:
+        200:
+          description: "ok"
+
+  /1.0/calendar/calendar-range/{id}.json:
+    get:
+      tags:
+        - calendar
+      summary: Return an calendar-range item by id
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The calendar-range id
+          schema:
+            type: integer
+            format: integer
+            minimum: 1
+      responses:
+        200:
+          description: "ok"
+        404:
+          description: "not found"
+        401:
+          description: "Unauthorized"
+  
+  /1.0/calendar/calendar-range-available.json:
+    get:
+      tags:
+        - calendar
+      summary: Return a list of available calendar range items. Available means calendar-range not being taken by a calendar entity
+      responses:
+        200:
+          description: "ok"