docs/openapi.yml at master · captcha-eu/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
openapi: 3.0.3
info:
  title: Captcha.at
  description: |-
    API Client to Validate a captcha
  termsOfService: https://captcha.at
  contact:
    email: hey@captcha.at
  license:
    name: MIT
  version: "0.1.0"
externalDocs:
  description: More captcha-docs
  url: https://docs.captcha.eu
servers:
  - url: https://www.captcha.eu
tags:
  - name: validation
paths:
  /validate:
    post:
      tags:
        - validation
      summary: Validate
      description: Validate a given captcha solution
      operationId: validate
      requestBody:
        description: Send a client side puzzle solution and validate it against all rules
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Validation'
        required: true
      responses:
        '403':
          description: "Rest Key False"
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
      security:
        - api_key:
          - "v"

components:
  schemas:
    Validation:
      type: string
      example: RAW_SOLUTION_FROM_JS
    ValidationResult:
      type: object
      properties:
        success:
          type: boolean
          format: int64
          example: true

  securitySchemes:
    api_key:
      type: apiKey
      description: Api Key
      name: Rest-Key
      in: header