From 0ed721ec6f49cc8f19eecd770d0c278c07e868bb Mon Sep 17 00:00:00 2001
From: BEAUVAIS ANTOINE <antoine.beauvais@etu.unistra.fr>
Date: Sun, 26 Sep 2021 16:35:53 +0200
Subject: [PATCH] Updated OpenAPI specification.
---
back-openapi.yaml | 52 +++++++++++++++++--
.../sil/erp/back/model/Transaction.java | 2 -
2 files changed, 47 insertions(+), 7 deletions(-)
diff --git a/back-openapi.yaml b/back-openapi.yaml
index 3e1eac8..12e5231 100644
--- a/back-openapi.yaml
+++ b/back-openapi.yaml
@@ -1,6 +1,6 @@
openapi: "3.0.0"
info:
- version: 0.0.1-20210924
+ version: 0.0.1-20210926
title: SIL ERP BACK
description: Interface API between the SIL ERP services and the BACK component.
# termsOfService: https://git.unistra.fr/erp-sil/back
@@ -70,6 +70,26 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
+ /retrieveStocks:
+ get:
+ description: |
+ Returns the stocks for each item (their quantity).
+ operationId: retrieveStocks
+ responses:
+ '200':
+ description: List of stock entries.
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/Stock'
+ '500':
+ description: Internal Server Error
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorMessage'
/submitTransaction:
post:
description: Submits a new transaction into the system.
@@ -134,22 +154,44 @@ components:
subscriberPrice:
type: number
example: 0.8
+ Stock:
+ type: object
+ required:
+ - id
+ - itemId
+ - itemName
+ - quantity
+ properties:
+ id:
+ type: integer
+ example: 1
+ itemId:
+ type: integer
+ example: 1
+ itemName:
+ type: string
+ example: "Jus d'orange"
+ quantity:
+ type: integer
+ example: 25
Transaction:
type: object
required:
- item
+ - type
- quantity
- - amount
properties:
item:
type: integer
example: 1
+ type:
+ type: integer
+ description: ACHAT, REGLEMENT, VENTE, ENCAISSEMENT
+ enum: [1, 2, 3, 4]
+ example: 1
quantity:
type: integer
example: 5
- amount:
- type: number
- example: 4.0
ErrorMessage:
type: object
required:
diff --git a/src/main/java/fr/unistra/sil/erp/back/model/Transaction.java b/src/main/java/fr/unistra/sil/erp/back/model/Transaction.java
index 57efe19..cfdc6e4 100644
--- a/src/main/java/fr/unistra/sil/erp/back/model/Transaction.java
+++ b/src/main/java/fr/unistra/sil/erp/back/model/Transaction.java
@@ -4,8 +4,6 @@
*/
package fr.unistra.sil.erp.back.model;
-import java.math.BigDecimal;
-
/**
* Representation of a transaction.
*
--
GitLab