changes in service

2021-01-15 12:22:40 +01:00
parent 9717d171bf
commit 124fca001a
3 changed files with 108 additions and 2 deletions
--- a/tools/ws/swagger.yaml
+++ b/tools/ws/swagger.yaml
@ -0,0 +1,100 @@
+swagger: '2.0'
+info:
+  title: Hello API
+  version: "0.1"
+
+paths:
+  /greeting:
+    get:
+      operationId: api.say_hello
+      summary: Returns a greeting
+      parameters:
+        - name: name
+          in: query
+          type: string
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            type: object
+            properties:
+              message:
+                type: string
+                description: Message greeting
+  /hero/{id}:
+    get:
+      operationId: heroes.get_hero
+      summary: Returns hero by id
+      parameters:
+        - name: id
+          in: path
+          type: integer
+          required: true
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            $ref: '#/definitions/Hero'
+        404:
+          description: Hero not found
+    put:
+      operationId: heroes.put_hero
+      summary: Update a hero
+      parameters:
+        - name: id
+          in: path 
+          type: integer
+          required: true
+        - name: hero
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/Hero'
+      responses:
+        200:
+          description: Hero updated
+        402:
+          description: Duplicate name
+        403:
+          description: Some error
+        404:
+          description: Hero not found
+  /hero:
+    post:
+      operationId: heroes.post_hero
+      summary: Insert a hero
+      parameters:
+        - name: hero
+          in: body
+          required: true
+          schema:
+            $ref: '#/definitions/Hero'
+      responses:
+        200:
+          description: Hero inserted
+        403:
+          description: Some error
+  /heroes:
+    get:
+      operationId: heroes.get_heroes
+      summary: Returns all heroes
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Hero'
+        404:
+          description: No heroes available
+
+
+definitions:
+  Hero:
+    description: Hero type
+    type: object
+    properties:
+      id: 
+        type: integer
+      name: 
+        type: string