From 191926998872471902bcb491329282a686a56c6c Mon Sep 17 00:00:00 2001 From: Zaptoss Date: Mon, 7 Oct 2024 17:07:14 +0300 Subject: [PATCH] Docs --- docs/spec/components/schemas/QRCodeKey.yaml | 12 +++++ ...ions@geo-points-svc@v2@public@qrcodes.yaml | 51 +++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 docs/spec/components/schemas/QRCodeKey.yaml create mode 100644 docs/spec/paths/integrations@geo-points-svc@v2@public@qrcodes.yaml diff --git a/docs/spec/components/schemas/QRCodeKey.yaml b/docs/spec/components/schemas/QRCodeKey.yaml new file mode 100644 index 0000000..5d10cc2 --- /dev/null +++ b/docs/spec/components/schemas/QRCodeKey.yaml @@ -0,0 +1,12 @@ +type: object +required: + - id + - type +properties: + id: + type: string + description: QR code value + example: "one_time_abcdefg..xyz" + type: + type: string + enum: [ qr_code ] diff --git a/docs/spec/paths/integrations@geo-points-svc@v2@public@qrcodes.yaml b/docs/spec/paths/integrations@geo-points-svc@v2@public@qrcodes.yaml new file mode 100644 index 0000000..d527438 --- /dev/null +++ b/docs/spec/paths/integrations@geo-points-svc@v2@public@qrcodes.yaml @@ -0,0 +1,51 @@ +post: + tags: + - QRCodes + summary: Send QR code + description: Send a QR code and get a reward + operationId: sendQRCode + security: + - BearerAuth: [] + requestBody: + required: true + content: + application/vnd.api+json: + schema: + type: object + required: + - data + properties: + data: + $ref: '#/components/schemas/QRCodeKey' + responses: + 200: + description: Success + content: + application/vnd.api+json: + schema: + type: object + required: + - data + properties: + data: + $ref: '#/components/schemas/EventClaimingState' + 400: + $ref: '#/components/responses/invalidParameter' + 401: + $ref: '#/components/responses/invalidAuth' + 403: + description: May be user haven't verified passport + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/Errors' + 404: + $ref: '#/components/responses/notFound' + 409: + description: QR code already submited + content: + application/vnd.api+json: + schema: + $ref: '#/components/schemas/Errors' + 500: + $ref: '#/components/responses/internalError'