docs/core/src/schemas/api/query.yaml at master · palavrapasse/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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
openapi: 3.0.3
info:
  title: Specification of the web API that allow users to query leaks information
  description: |-
    Service that processes read/query operations requests.

    Some useful links:
    - [Use Cases](https://github.com/palavrapasse/docs/blob/master/core/use-cases.md)
    - [Entities](https://github.com/palavrapasse/docs/blob/master/core/entities.md)
    - [Data Model](https://github.com/palavrapasse/docs/blob/master/core/data-model.md)
  license:
    name: MIT License
    url: https://github.com/palavrapasse/query/blob/master/LICENSE
  version: 0.0.1
tags:
  - name: leaks
    description: Leaks information query endpoints
  - name: platforms
    description: Leaks platforms information query endpoints
paths:
  /leaks:
    get:
      tags:
        - leaks
      summary: Finds leaks
      operationId: findLeaks
      parameters:
        - name: type
          in: query
          description: Type of information provided in affected
          required: false
          explode: true
          schema:
            type: string
            default: email
            enum:
              - email
              - password
        - name: affected
          in: query
          description: Values that need to be considered for filter
          required: false
          explode: true
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Email'
        - name: target
          in: query
          description: Specifies the target leaks considered for filter
          required: false
          explode: true
          schema:
            type: string
            default: all
            enum:
              - all
              - newest
              - oldest
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Leak'
  /platforms:
    get:
      tags:
        - platforms
      summary: Finds affected platforms
      operationId: findPlatforms
      parameters:
        - name: target
          in: query
          description: Specifies the target affected platforms considered for filter
          required: false
          explode: true
          schema:
            type: string
            default: all
            enum:
              - all
              - newest
              - oldest
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Platform'
components:
  schemas:
    Leak:
      type: object
      properties:
        context:
          type: string
          example: "Leak context"
        shareDateMSEpoch:
          type: number
    Platform:
      type: string
      example: "Platform1"
    Email:
      type: string
      format: email
      example: "test@mail.com"