Add README.md

README.md

@@ -0,0 +1,14 @@
+# Библиотека openapi контрактов
+
+Библиотека содержит openapi описание методов используемых для интеграции аппаратной части и информационной системы
+
+## Сборка библиотеки
+
+При сборке будут сгенерированы классы контроллеров и DTO скомпилированы и упакованы в jar файл
+
+`gradle jar`
+
+## Описанные методы
+
+- GET /qr - метод получения qr-кодов
+- POST /qr-used/{qrId} - метод отметки использования qr-кода клиентом(для сбора метрик)

src/main/resources/openapi-contract.yaml

@@ -21,6 +21,8 @@ paths:
       summary: Получение qr кодов
       description: Получение qr кодов за сегодня, за исключением прошедшего времени
       operationId: getQrCodes
+      security:
+        - bearerAuth: [ ]
       responses:
         '200':
           description: Successful operation
@@ -46,6 +48,8 @@ paths:
       summary: Отметка qr-кода как использованного(Для сбора метрик).
       description: Отправляется микрокомпьютером, когда qr-код был задействован.
       operationId: markQrCodeAsUsed
+      security:
+        - bearerAuth: [ ]
       responses:
         '200':
           description: Successfull mark
@@ -81,3 +85,8 @@ components:
           type: string
           format: uuid
           example: 'dd654b6c-a671-488e-8fc9-eb564d0a8f22'
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT