aboutsummaryrefslogtreecommitdiff
path: root/schemas_openapi/main.yaml
blob: 3c710e44bde0e1e9c865a1795058c071a0bec396 (plain) (blame)
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
---
openapi: 3.1.0
info:
    title: restlog
    version: 0.0.1
paths:
    '/entries':
        get:
            parameters:
              - name: source
                in: query
              - name: type
                in: query
              - name: last_entry_id
                in: query
              - max_results:
                in: query
            responses:
                "200":
                    "$ref": "#/components/responses/entries"
                default:
                    description: error
    '/entry/{entry_id}':
        get:
            parameters:
              - name: entry_id
                in: path
                required: true
            responses:
                "200":
                    "$ref": "#/components/responses/entry"
                default:
                    description: error
    '/entry/{source}/{type}':
        post:
            parameters:
              - name: source
                in: path
                required: true
              - name: type
                in: path
                required: true
            requestBody:
                content:
                    application/json:
                        schema:
                            description: entry data
            responses:
                "200":
                    "$ref": "#/components/responses/entry"
                default:
                    description: error
components:
    schemas:
        entry:
            type: object
            required:
                - entry_id
                - timestamp
                - address
                - source
                - type
                - data
            properties:
                entry_id:
                    type: integer
                timestamp:
                    type: number
                address:
                    type: string
                source:
                    type: string
                type:
                    type: string
                data: {}
    responses:
        entries:
            decription: list of entries
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - entires
                            - more
                        properties:
                            entires:
                                type: array
                                items:
                                    "$ref": "#/components/schemas/entry"
                            more:
                                type: boolean
        entry:
            decription: single entry
            content:
                application/json:
                    schema:
                        "$ref": "#/components/schemas/entry"
...