databox-java/src/api/openapi.yaml at d43a5f5ce32db70da65fff6aeac2fa0a8d56d6fc · databox/databox-java · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
openapi: 3.0.3
info:
  description: Push API resources Open API documentation
  title: Static OpenAPI document of Push API resource
  version: 0.4.0
servers:
- description: Dev mode server description
  url: https://push.databox.com
security:
- basicAuth: []
paths:
  /metrickeys:
    get:
      responses:
        "200":
          description: OK
      x-accepts:
      - application/json
    post:
      requestBody:
        content:
          application/json:
            schema:
              type: object
          application/vnd.databox.v2+json:
            schema:
              type: object
      responses:
        "200":
          description: OK
      x-content-type: application/json
      x-accepts:
      - application/json
  /ping:
    get:
      responses:
        "200":
          description: OK
      x-accepts:
      - application/json
  /data:
    delete:
      responses:
        "200":
          description: OK
      x-accepts:
      - application/json
    post:
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/PushData'
              type: array
          application/vnd.databox.v2+json:
            schema:
              items:
                $ref: '#/components/schemas/PushData'
              type: array
      responses:
        "200":
          description: OK
      x-content-type: application/json
      x-accepts:
      - application/json
  /data/{metricKey}:
    delete:
      parameters:
      - explode: false
        in: path
        name: metricKey
        required: true
        schema:
          type: string
        style: simple
      responses:
        "200":
          description: OK
      x-accepts:
      - application/json
components:
  schemas:
    ApiResponse:
      properties:
        status:
          type: string
        message:
          type: string
      type: object
    PushData:
      example:
        date: date
        periodTo: periodTo
        unit: unit
        periodFrom: periodFrom
        attributes:
        - value: value
          key: key
        - value: value
          key: key
        value: 0.8008282
        key: key
      properties:
        attributes:
          items:
            $ref: '#/components/schemas/PushDataAttribute'
          type: array
        date:
          type: string
        key:
          type: string
        periodFrom:
          type: string
        periodTo:
          type: string
        unit:
          type: string
        value:
          format: float
          type: number
      type: object
    PushDataAttribute:
      example:
        value: value
        key: key
      properties:
        key:
          type: string
        value:
          type: string
      type: object
    State:
      enum:
      - DOWN
      - UP
      type: string
  securitySchemes:
    basicAuth:
      scheme: basic
      type: http