draft API descriptor

2023-10-22 09:58:56 +02:00 · 2023-10-22 09:58:56 +02:00 · dc89897961
parent 8e85c9dec1
commit dc89897961
1 changed files with 108 additions and 0 deletions
--- a/doc/api/openapi/openapi.yaml
+++ b/doc/api/openapi/openapi.yaml
@ -0,0 +1,108 @@
+openapi: 3.0.3
+info:
+  title: Recettes - OpenAPI 3.0
+  description: |-
+    API recettes
+  contact:
+    email: meutel@meutel.net
+  license:
+    name: MIT
+    url: https://mit-license.org/
+  version: 1.0.0
+servers:
+  - url: https://recettes.meutel.net/api/v1
+tags:
+  - name: receipe
+    description: Receipes
+  - name: parameters
+    description: Application parameters
+paths:
+  /receipes:
+    get:
+      tags:
+        - receipe
+      summary: Lists receipes
+      description: Lists and search receipes
+      operationId: findReceipes
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Receipe'
+
+  /receipe/{receipeId}:
+    get:
+      tags:
+        - receipe
+      summary: Find receipe by ID
+      description: Returns a single receipe
+      operationId: getReceipeById
+      parameters:
+        - name: receipeId
+          in: path
+          description: ID of receipe to return
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Receipe'
+        '400':
+          description: Invalid ID supplied
+        '404':
+          description: Receipe not found
+
+  /parameters/{paramType}:
+    get:
+      tags:
+        - parameter
+      summary: Parameters by type
+      description: Returns a list of parameters of given type
+      operationId: listParametersByType
+      parameters:
+        - name: paramType
+          in: path
+          description: Type of parameters to return
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Parameter'
+
+components:
+  schemas:
+    Parameter:
+      type: object
+      required:
+        - id
+        - name
+        - '@type'
+      properties:
+        id:
+          description: Parameter unique id
+          type: string
+          maxLength: 24
+          minLength: 24
+        name:
+          description: Parameter name
+          type: string
+        '@type':
+          description: Parameter type
+          type: string
+    Receipe:
+      type: object