api-schema/artemis.v1.yaml at master · TheInteract/api-schema · 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
swagger: '2.0'
info:
  version: "1.1.0"
  title: Project Artemis
  description: collector + feature toggle
host: interact.com
basePath: /api
produces:
  - application/json
paths:
  /event/oninit:
    post:
      parameters:
        - name: initInformation
          in: body
          required: true
          schema:
            $ref: "#/definitions/InitInformation"
      responses:
        200:
          description: Success
          schema:
            type: object
            required:
            - featureList
            - initCode
            properties:
              featureList:
                type: array
                description: List of features with version to render
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: feature name
                    version:
                      type: string
                      description: feature version to render
              deviceCode:
                type: string
              initCode:
                type: string
        default:
          description: Error
          schema:
            $ref: "#/definitions/Error"
  /event/onload:
    post:
      summary: Get config for client side and collecting OnLoad event from browser
      parameters:
        - name: rawData
          in: body
          required: true
          schema:
            type: object
            required:
              - customerCode
              - eventData
            properties:
              customerCode:
                type: string
                description: customer code
              hashedUserId:
                type: string
                description: hashed user id (unique)
              eventData:
                type: object
                description: data from browser onload event
                properties:
                  appCodeName:
                    type: string
                  appName:
                    type: string
                  appVersion:
                    type: string
                  cookieEnabled:
                    type: boolean
                  href:
                    type: string
                  innerHeight:
                    type: integer
                  innerWidth:
                    type: integer
                  scrollX:
                    type: integer
                  scrollY:
                    type: integer
                  timeStamp:
                    type: integer
                    description: Unix Timestamp (milliseconds)
      responses:
        200:
          description: Success
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: "#/definitions/Error"
  /event/onclick:
    post:
      summary: Collecting OnClick event from browser
      parameters:
        - name: rawData
          in: body
          required: true
          schema:
            type: object
      responses:
        200:
          description: Success
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: "#/definitions/Error"
  /event/onscroll:
    post:
      summary: Collecting OnScroll event from browser
      parameters:
        - name: rawData
          in: body
          required: true
          schema:
            type: object
      responses:
        200:
          description: Success
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: "#/definitions/Error"
  /event/onapicall:
    post:
      summary: Collecting OnApiCall event from browser
      parameters:
        - name: rawData
          in: body
          required: true
          schema:
            type: object
            required:
              - method
              - url
            properties:
              method:
                type: string
                enum:
                  - GET
                  - POST
                  - PUT
                  - DELETE
                  - PATCH
              url:
                type: string
      responses:
        200:
          description: Success
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: "#/definitions/Error"
definitions:
  InitInformation:
    type: object
    required:
      - customerCode
      - userIdentity
    properties:
      customerCode:
        type: string
        description: customer code
      userIdentity:
        type: object
        description: user identity of device and user
        properties:
          deviceCode:
            type: string
            description: device cookie
          hashedUserId:
            type: string
            description: hashed user id (unique)
  Error:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string