documentation for api

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

@@ -0,0 +1,59 @@
+---
+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"
+
+components:
+  parameters:
+    _format:
+      name: _format
+      in: path
+      required: true
+      schema:
+        type: string
+        enum:
+          - json
+
+paths:
+  /1.0/search.json:
+    get:
+      summary: perform a search across multiple entities
+      tags:
+        - search
+        - person
+        - thirdparty
+      description: >
+        **Warning**: This is currently a stub (not really implemented
+
+        The search is performed across multiple entities. The entities must be listed into 
+        `type` parameters.
+
+        The results are ordered by relevance, from the most to the lowest relevant.
+
+      parameters:
+        - name: q
+          in: query
+          required: true
+          description: the pattern to search
+          schema:
+            type: string
+        - name: type[]
+          in: query
+          required: true
+          description: the type entities amongst the search is performed
+          schema:
+            type: array
+            items:
+              type: string
+              enum:
+                - person
+                - thirdparty
+      responses:
+        200:
+          description: "OK"
+