Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Zaptoss committed Oct 7, 2024
1 parent 4829055 commit 1919269
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/spec/components/schemas/QRCodeKey.yaml
Original file line number Diff line number Diff line change
@@ -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 ]
51 changes: 51 additions & 0 deletions docs/spec/paths/integrations@geo-points-svc@v2@[email protected]
Original file line number Diff line number Diff line change
@@ -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'

0 comments on commit 1919269

Please sign in to comment.