@algolia/n8n-nodes-algolia 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/README.md +140 -68
  2. package/dist/credentials/AlgoliaApi.credentials.js +1 -41
  3. package/dist/nodes/Algolia/Algolia.node.js +854 -17999
  4. package/package.json +10 -11
  5. package/dist/nodes/Algolia/specs/abtesting-v3.json +0 -1701
  6. package/dist/nodes/Algolia/specs/abtesting.json +0 -1580
  7. package/dist/nodes/Algolia/specs/advanced-personalization.json +0 -1667
  8. package/dist/nodes/Algolia/specs/analytics.json +0 -3138
  9. package/dist/nodes/Algolia/specs/composition.json +0 -4193
  10. package/dist/nodes/Algolia/specs/crawler.json +0 -3354
  11. package/dist/nodes/Algolia/specs/ingestion.json +0 -6368
  12. package/dist/nodes/Algolia/specs/insights.json +0 -1843
  13. package/dist/nodes/Algolia/specs/monitoring.json +0 -1263
  14. package/dist/nodes/Algolia/specs/personalization.json +0 -716
  15. package/dist/nodes/Algolia/specs/query-suggestions.json +0 -1143
  16. package/dist/nodes/Algolia/specs/recommend.json +0 -3681
  17. package/dist/nodes/Algolia/specs/search.json +0 -9458
  18. /package/dist/{nodes/Algolia/algolia.svg → algolia.svg} +0 -0
package/dist/nodes/Algolia/specs/monitoring.json DELETED
@@ -1,1263 +0,0 @@
1
- {
2
- "openapi": "3.0.2",
3
- "info": {
4
- "title": "Algolia Monitoring API",
5
- "description": "The Monitoring API lets you check the status of your Algolia infrastructure.\n\n## Base URLs\n\nThe base URL for requests to the Monitoring API is:\n\n- `https://status.algolia.com`\n\n**All requests must use HTTPS.**\n\n## Availability and authentication\n\nAccess to the [Infrastructure](#tag/infrastructure) endpoints\nis available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\n\nTo authenticate requests to the Infrastructure endpoints, add these headers:\n\n- `x-algolia-application-id`. Your Algolia application ID.\n- `x-algolia-api-key`. Your Monitoring API key.\n\nYou can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).\n\nOther endpoints don't require authentication.\n\n## Response status and errors\n\nThe Monitoring API returns JSON responses.\nSince JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.\n\nSuccessful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.\nError responses have a `message` property with more information.\n\n## Version\n\nThe current version of the Monitoring API is version 1, as indicated by the `/1/` in each endpoint's URL.\n",
6
- "version": "1.0.0"
7
- },
8
- "servers": [
9
- {
10
- "url": "https://status.algolia.com"
11
- }
12
- ],
13
- "tags": [
14
- {
15
- "name": "incidents",
16
- "description": "List the known incidents.",
17
- "x-displayName": "Incidents"
18
- },
19
- {
20
- "name": "infrastructure",
21
- "description": "Return information about the Algolia infrastructure used by your application.",
22
- "x-displayName": "Infrastructure"
23
- },
24
- {
25
- "name": "monitoring-tag",
26
- "description": "Report search and indexing times for your clusters, and get a list of servers.",
27
- "x-displayName": "Monitoring"
28
- },
29
- {
30
- "name": "status",
31
- "description": "Report the status of Algolia clusters.",
32
- "x-displayName": "Status"
33
- }
34
- ],
35
- "paths": {
36
- "/{path}": {
37
- "get": {
38
- "operationId": "customGet",
39
- "summary": "Send requests to the Algolia REST API",
40
- "description": "This method lets you send requests to the Algolia REST API.",
41
- "parameters": [
42
- {
43
- "$ref": "#/components/parameters/PathInPath"
44
- },
45
- {
46
- "$ref": "#/components/parameters/Parameters"
47
- }
48
- ],
49
- "responses": {
50
- "200": {
51
- "description": "OK",
52
- "content": {
53
- "application/json": {
54
- "schema": {
55
- "type": "object"
56
- }
57
- }
58
- }
59
- },
60
- "400": {
61
- "$ref": "#/components/responses/BadRequest"
62
- },
63
- "402": {
64
- "$ref": "#/components/responses/FeatureNotEnabled"
65
- },
66
- "403": {
67
- "$ref": "#/components/responses/MethodNotAllowed"
68
- },
69
- "404": {
70
- "$ref": "#/components/responses/IndexNotFound"
71
- }
72
- }
73
- },
74
- "post": {
75
- "operationId": "customPost",
76
- "requestBody": {
77
- "description": "Parameters to send with the custom request.",
78
- "content": {
79
- "application/json": {
80
- "schema": {
81
- "type": "object"
82
- }
83
- }
84
- }
85
- },
86
- "summary": "Send requests to the Algolia REST API",
87
- "description": "This method lets you send requests to the Algolia REST API.",
88
- "parameters": [
89
- {
90
- "$ref": "#/components/parameters/PathInPath"
91
- },
92
- {
93
- "$ref": "#/components/parameters/Parameters"
94
- }
95
- ],
96
- "responses": {
97
- "200": {
98
- "description": "OK",
99
- "content": {
100
- "application/json": {
101
- "schema": {
102
- "type": "object"
103
- }
104
- }
105
- }
106
- },
107
- "400": {
108
- "$ref": "#/components/responses/BadRequest"
109
- },
110
- "402": {
111
- "$ref": "#/components/responses/FeatureNotEnabled"
112
- },
113
- "403": {
114
- "$ref": "#/components/responses/MethodNotAllowed"
115
- },
116
- "404": {
117
- "$ref": "#/components/responses/IndexNotFound"
118
- }
119
- }
120
- },
121
- "put": {
122
- "operationId": "customPut",
123
- "requestBody": {
124
- "description": "Parameters to send with the custom request.",
125
- "content": {
126
- "application/json": {
127
- "schema": {
128
- "type": "object"
129
- }
130
- }
131
- }
132
- },
133
- "summary": "Send requests to the Algolia REST API",
134
- "description": "This method lets you send requests to the Algolia REST API.",
135
- "parameters": [
136
- {
137
- "$ref": "#/components/parameters/PathInPath"
138
- },
139
- {
140
- "$ref": "#/components/parameters/Parameters"
141
- }
142
- ],
143
- "responses": {
144
- "200": {
145
- "description": "OK",
146
- "content": {
147
- "application/json": {
148
- "schema": {
149
- "type": "object"
150
- }
151
- }
152
- }
153
- },
154
- "400": {
155
- "$ref": "#/components/responses/BadRequest"
156
- },
157
- "402": {
158
- "$ref": "#/components/responses/FeatureNotEnabled"
159
- },
160
- "403": {
161
- "$ref": "#/components/responses/MethodNotAllowed"
162
- },
163
- "404": {
164
- "$ref": "#/components/responses/IndexNotFound"
165
- }
166
- }
167
- },
168
- "delete": {
169
- "operationId": "customDelete",
170
- "summary": "Send requests to the Algolia REST API",
171
- "description": "This method lets you send requests to the Algolia REST API.",
172
- "parameters": [
173
- {
174
- "$ref": "#/components/parameters/PathInPath"
175
- },
176
- {
177
- "$ref": "#/components/parameters/Parameters"
178
- }
179
- ],
180
- "responses": {
181
- "200": {
182
- "description": "OK",
183
- "content": {
184
- "application/json": {
185
- "schema": {
186
- "type": "object"
187
- }
188
- }
189
- }
190
- },
191
- "400": {
192
- "$ref": "#/components/responses/BadRequest"
193
- },
194
- "402": {
195
- "$ref": "#/components/responses/FeatureNotEnabled"
196
- },
197
- "403": {
198
- "$ref": "#/components/responses/MethodNotAllowed"
199
- },
200
- "404": {
201
- "$ref": "#/components/responses/IndexNotFound"
202
- }
203
- }
204
- }
205
- },
206
- "/1/status": {
207
- "get": {
208
- "operationId": "getStatus",
209
- "summary": "Retrieve status of all clusters",
210
- "security": [],
211
- "tags": [
212
- "status"
213
- ],
214
- "description": "Retrieves the status of all Algolia clusters and instances.",
215
- "responses": {
216
- "200": {
217
- "$ref": "#/components/responses/StatusResponse"
218
- },
219
- "401": {
220
- "$ref": "#/components/responses/UnauthorizedResponse"
221
- }
222
- }
223
- }
224
- },
225
- "/1/status/{clusters}": {
226
- "get": {
227
- "summary": "Retrieve cluster status",
228
- "description": "Retrieves the status of selected clusters.",
229
- "operationId": "getClusterStatus",
230
- "x-mcp-tool": true,
231
- "tags": [
232
- "status"
233
- ],
234
- "security": [],
235
- "parameters": [
236
- {
237
- "$ref": "#/components/parameters/Clusters"
238
- }
239
- ],
240
- "responses": {
241
- "200": {
242
- "$ref": "#/components/responses/StatusResponse"
243
- },
244
- "401": {
245
- "$ref": "#/components/responses/UnauthorizedResponse"
246
- },
247
- "404": {
248
- "$ref": "#/components/responses/NotFoundResponse"
249
- }
250
- }
251
- }
252
- },
253
- "/1/incidents": {
254
- "get": {
255
- "summary": "Retrieve all incidents",
256
- "description": "Retrieves known incidents for all clusters.",
257
- "operationId": "getIncidents",
258
- "x-mcp-tool": true,
259
- "security": [],
260
- "tags": [
261
- "incidents"
262
- ],
263
- "responses": {
264
- "200": {
265
- "$ref": "#/components/responses/IncidentsResponse"
266
- },
267
- "401": {
268
- "$ref": "#/components/responses/UnauthorizedResponse"
269
- }
270
- }
271
- }
272
- },
273
- "/1/incidents/{clusters}": {
274
- "get": {
275
- "summary": "Retrieve cluster incidents",
276
- "description": "Retrieves known incidents for the selected clusters.",
277
- "operationId": "getClusterIncidents",
278
- "tags": [
279
- "incidents"
280
- ],
281
- "security": [],
282
- "parameters": [
283
- {
284
- "$ref": "#/components/parameters/Clusters"
285
- }
286
- ],
287
- "responses": {
288
- "200": {
289
- "$ref": "#/components/responses/IncidentsResponse"
290
- },
291
- "401": {
292
- "$ref": "#/components/responses/UnauthorizedResponse"
293
- },
294
- "404": {
295
- "$ref": "#/components/responses/NotFoundResponse"
296
- }
297
- }
298
- }
299
- },
300
- "/1/inventory/servers": {
301
- "get": {
302
- "summary": "Retrieve servers",
303
- "operationId": "getServers",
304
- "security": [
305
- {
306
- "applicationId": []
307
- },
308
- {
309
- "apiKey": []
310
- }
311
- ],
312
- "description": "Retrieves the servers that belong to clusters.\n\nThe response depends on whether you authenticate your API request:\n\n- With authentication, the response lists the servers assigned to your\nAlgolia application's cluster.\n\n- Without authentication, the response lists the servers for all Algolia\nclusters.\n",
313
- "tags": [
314
- "monitoring-tag"
315
- ],
316
- "responses": {
317
- "200": {
318
- "$ref": "#/components/responses/InventoryResponse"
319
- },
320
- "403": {
321
- "$ref": "#/components/responses/ForbiddenResponse"
322
- }
323
- }
324
- }
325
- },
326
- "/1/latency/{clusters}": {
327
- "get": {
328
- "summary": "Retrieve search latency times",
329
- "description": "Retrieves the average latency for search requests for selected clusters.",
330
- "operationId": "getLatency",
331
- "security": [],
332
- "tags": [
333
- "monitoring-tag"
334
- ],
335
- "parameters": [
336
- {
337
- "$ref": "#/components/parameters/Clusters"
338
- }
339
- ],
340
- "responses": {
341
- "200": {
342
- "$ref": "#/components/responses/LatencyResponse"
343
- },
344
- "400": {
345
- "$ref": "#/components/responses/BadRequestResponse"
346
- }
347
- }
348
- }
349
- },
350
- "/1/indexing/{clusters}": {
351
- "get": {
352
- "summary": "Retrieve indexing times",
353
- "description": "Retrieves average times for indexing operations for selected clusters.",
354
- "operationId": "getIndexingTime",
355
- "security": [],
356
- "tags": [
357
- "monitoring-tag"
358
- ],
359
- "parameters": [
360
- {
361
- "$ref": "#/components/parameters/Clusters"
362
- }
363
- ],
364
- "responses": {
365
- "200": {
366
- "$ref": "#/components/responses/IndexingResponse"
367
- },
368
- "400": {
369
- "$ref": "#/components/responses/BadRequestResponse"
370
- }
371
- }
372
- }
373
- },
374
- "/1/reachability/{clusters}/probes": {
375
- "get": {
376
- "summary": "Test the reachability of clusters",
377
- "description": "Test whether clusters are reachable or not.",
378
- "operationId": "getReachability",
379
- "security": [],
380
- "tags": [
381
- "monitoring-tag"
382
- ],
383
- "parameters": [
384
- {
385
- "$ref": "#/components/parameters/Clusters"
386
- }
387
- ],
388
- "responses": {
389
- "200": {
390
- "$ref": "#/components/responses/ReachabilityResponse"
391
- },
392
- "400": {
393
- "$ref": "#/components/responses/BadRequestResponse"
394
- }
395
- }
396
- }
397
- },
398
- "/1/infrastructure/{metric}/period/{period}": {
399
- "get": {
400
- "summary": "Retrieve metrics",
401
- "description": "Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.\n\nAccess to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).\nYou must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).\n",
402
- "operationId": "getMetrics",
403
- "tags": [
404
- "infrastructure"
405
- ],
406
- "parameters": [
407
- {
408
- "$ref": "#/components/parameters/MetricInPath"
409
- },
410
- {
411
- "$ref": "#/components/parameters/PeriodInPath"
412
- }
413
- ],
414
- "responses": {
415
- "200": {
416
- "$ref": "#/components/responses/InfrastructureResponse"
417
- },
418
- "401": {
419
- "$ref": "#/components/responses/InfrastructureAPIUnauthorized"
420
- }
421
- }
422
- }
423
- },
424
- "/setClientApiKey": {
425
- "get": {
426
- "x-helper": true,
427
- "x-asynchronous-helper": false,
428
- "tags": [
429
- "Api Key"
430
- ],
431
- "operationId": "setClientApiKey",
432
- "summary": "Switch the API key used to authenticate requests",
433
- "description": "Switch the API key used to authenticate requests.\n",
434
- "parameters": [
435
- {
436
- "in": "query",
437
- "name": "apiKey",
438
- "description": "API key to be used from now on.",
439
- "required": true,
440
- "schema": {
441
- "type": "string"
442
- }
443
- }
444
- ],
445
- "responses": {
446
- "204": {
447
- "description": "No content."
448
- }
449
- }
450
- }
451
- }
452
- },
453
- "components": {
454
- "securitySchemes": {
455
- "applicationId": {
456
- "type": "apiKey",
457
- "in": "header",
458
- "name": "X-Algolia-Application-Id",
459
- "description": "Your Algolia application ID."
460
- },
461
- "apiKey": {
462
- "type": "apiKey",
463
- "in": "header",
464
- "name": "X-Algolia-API-Key",
465
- "description": "Your Algolia Monitoring API key."
466
- }
467
- },
468
- "parameters": {
469
- "PathInPath": {
470
- "name": "path",
471
- "in": "path",
472
- "description": "Path of the endpoint, for example `1/newFeature`.",
473
- "required": true,
474
- "schema": {
475
- "type": "string",
476
- "example": "/keys"
477
- }
478
- },
479
- "Parameters": {
480
- "name": "parameters",
481
- "in": "query",
482
- "description": "Query parameters to apply to the current query.",
483
- "schema": {
484
- "type": "object",
485
- "additionalProperties": true
486
- }
487
- },
488
- "Clusters": {
489
- "name": "clusters",
490
- "in": "path",
491
- "required": true,
492
- "description": "Subset of clusters, separated by commas.",
493
- "schema": {
494
- "type": "string",
495
- "example": "c1-de,c2-de,c3-de"
496
- }
497
- },
498
- "MetricInPath": {
499
- "name": "metric",
500
- "in": "path",
501
- "required": true,
502
- "description": "Metric to report.\n\nFor more information about the individual metrics, see the description of the API response.\nTo include all metrics, use `*`.\n",
503
- "schema": {
504
- "$ref": "#/components/schemas/Metric"
505
- }
506
- },
507
- "PeriodInPath": {
508
- "name": "period",
509
- "in": "path",
510
- "required": true,
511
- "description": "Period over which to aggregate the metrics:\n\n- `minute`. Aggregate the last minute. 1 data point per 10 seconds.\n- `hour`. Aggregate the last hour. 1 data point per minute.\n- `day`. Aggregate the last day. 1 data point per 10 minutes.\n- `week`. Aggregate the last week. 1 data point per hour.\n- `month`. Aggregate the last month. 1 data point per day.\n",
512
- "schema": {
513
- "$ref": "#/components/schemas/Period"
514
- }
515
- }
516
- },
517
- "schemas": {
518
- "ErrorBase": {
519
- "description": "Error.",
520
- "type": "object",
521
- "x-keep-model": true,
522
- "additionalProperties": true,
523
- "properties": {
524
- "message": {
525
- "type": "string",
526
- "example": "Invalid Application-Id or API-Key"
527
- }
528
- }
529
- },
530
- "Status": {
531
- "title": "status",
532
- "type": "string",
533
- "description": "Status of the cluster.",
534
- "enum": [
535
- "operational",
536
- "degraded_performance",
537
- "partial_outage",
538
- "major_outage"
539
- ]
540
- },
541
- "Timestamp": {
542
- "type": "integer",
543
- "format": "int64",
544
- "description": "Timestamp, measured in milliseconds since the Unix epoch."
545
- },
546
- "Incident": {
547
- "title": "incident",
548
- "description": "Incident details.",
549
- "type": "object",
550
- "properties": {
551
- "title": {
552
- "type": "string",
553
- "description": "Description of the incident."
554
- },
555
- "status": {
556
- "$ref": "#/components/schemas/Status"
557
- }
558
- }
559
- },
560
- "Incidents": {
561
- "title": "incidents",
562
- "description": "Key-value pairs with the cluster names as keys and the list of incidents reported for this cluster as values.",
563
- "type": "array",
564
- "items": {
565
- "title": "incidentEntry",
566
- "type": "object",
567
- "properties": {
568
- "t": {
569
- "$ref": "#/components/schemas/Timestamp"
570
- },
571
- "v": {
572
- "$ref": "#/components/schemas/Incident"
573
- }
574
- }
575
- }
576
- },
577
- "Region": {
578
- "title": "region",
579
- "type": "string",
580
- "description": "Region where the cluster is located.",
581
- "enum": [
582
- "au",
583
- "br",
584
- "ca",
585
- "de",
586
- "eu",
587
- "hk",
588
- "in",
589
- "jp",
590
- "sg",
591
- "uae",
592
- "uk",
593
- "usc",
594
- "use",
595
- "usw",
596
- "za"
597
- ],
598
- "example": "de"
599
- },
600
- "ServerStatus": {
601
- "title": "status",
602
- "type": "string",
603
- "enum": [
604
- "PRODUCTION"
605
- ]
606
- },
607
- "Type": {
608
- "title": "type",
609
- "type": "string",
610
- "enum": [
611
- "cluster"
612
- ]
613
- },
614
- "Server": {
615
- "title": "server",
616
- "type": "object",
617
- "additionalProperties": false,
618
- "properties": {
619
- "name": {
620
- "type": "string",
621
- "description": "Server name.",
622
- "example": "c16-de-1"
623
- },
624
- "region": {
625
- "$ref": "#/components/schemas/Region"
626
- },
627
- "is_slave": {
628
- "type": "boolean",
629
- "default": false,
630
- "deprecated": true,
631
- "description": "Included to support legacy applications.\nUse `is_replica` instead.\n",
632
- "example": false
633
- },
634
- "is_replica": {
635
- "type": "boolean",
636
- "default": false,
637
- "description": "Whether this server is a replica of another server.",
638
- "example": false
639
- },
640
- "cluster": {
641
- "type": "string",
642
- "description": "Name of the cluster to which this server belongs.",
643
- "example": "c16-de"
644
- },
645
- "status": {
646
- "$ref": "#/components/schemas/ServerStatus"
647
- },
648
- "type": {
649
- "$ref": "#/components/schemas/Type"
650
- }
651
- }
652
- },
653
- "Time": {
654
- "title": "times",
655
- "description": "Time measured by a probe.",
656
- "type": "array",
657
- "items": {
658
- "title": "timeEntry",
659
- "type": "object",
660
- "additionalProperties": false,
661
- "properties": {
662
- "t": {
663
- "$ref": "#/components/schemas/Timestamp"
664
- },
665
- "v": {
666
- "type": "integer",
667
- "description": "Time in ms."
668
- }
669
- }
670
- }
671
- },
672
- "Probes": {
673
- "title": "probes",
674
- "description": "Probes and their response.",
675
- "type": "object",
676
- "additionalProperties": {
677
- "x-additionalPropertiesName": "probe",
678
- "type": "boolean",
679
- "description": "Key-value pair with the probe name as the key and the reachability status as the value."
680
- }
681
- },
682
- "Metric": {
683
- "type": "string",
684
- "enum": [
685
- "avg_build_time",
686
- "ssd_usage",
687
- "ram_search_usage",
688
- "ram_indexing_usage",
689
- "cpu_usage",
690
- "*"
691
- ],
692
- "example": "*"
693
- },
694
- "Period": {
695
- "type": "string",
696
- "enum": [
697
- "minute",
698
- "hour",
699
- "day",
700
- "week",
701
- "month"
702
- ],
703
- "example": "week"
704
- },
705
- "ProbesMetric": {
706
- "title": "metric",
707
- "type": "object",
708
- "additionalProperties": false,
709
- "properties": {
710
- "t": {
711
- "$ref": "#/components/schemas/Timestamp"
712
- },
713
- "v": {
714
- "type": "integer",
715
- "description": "Value of the metric."
716
- }
717
- }
718
- },
719
- "InfraProbes": {
720
- "title": "probes",
721
- "type": "array",
722
- "items": {
723
- "$ref": "#/components/schemas/ProbesMetric"
724
- }
725
- }
726
- },
727
- "responses": {
728
- "BadRequest": {
729
- "description": "Bad request or request arguments.",
730
- "content": {
731
- "application/json": {
732
- "schema": {
733
- "$ref": "#/components/schemas/ErrorBase"
734
- }
735
- }
736
- }
737
- },
738
- "FeatureNotEnabled": {
739
- "description": "This feature is not enabled on your Algolia account.",
740
- "content": {
741
- "application/json": {
742
- "schema": {
743
- "$ref": "#/components/schemas/ErrorBase"
744
- }
745
- }
746
- }
747
- },
748
- "MethodNotAllowed": {
749
- "description": "Method not allowed with this API key.",
750
- "content": {
751
- "application/json": {
752
- "schema": {
753
- "$ref": "#/components/schemas/ErrorBase"
754
- }
755
- }
756
- }
757
- },
758
- "IndexNotFound": {
759
- "description": "Index not found.",
760
- "content": {
761
- "application/json": {
762
- "schema": {
763
- "$ref": "#/components/schemas/ErrorBase"
764
- }
765
- }
766
- }
767
- },
768
- "StatusResponse": {
769
- "description": "OK",
770
- "content": {
771
- "application/json": {
772
- "schema": {
773
- "title": "statusResponse",
774
- "type": "object",
775
- "properties": {
776
- "status": {
777
- "type": "object",
778
- "additionalProperties": {
779
- "x-additionalPropertiesName": "cluster",
780
- "$ref": "#/components/schemas/Status"
781
- }
782
- }
783
- }
784
- },
785
- "examples": {
786
- "Success": {
787
- "value": {
788
- "status": {
789
- "c16-de": "operational"
790
- }
791
- }
792
- }
793
- }
794
- }
795
- }
796
- },
797
- "UnauthorizedResponse": {
798
- "description": "Unauthorized",
799
- "content": {
800
- "text/plain": {
801
- "schema": {
802
- "type": "string"
803
- },
804
- "examples": {
805
- "Unauthorized": {
806
- "summary": "Invalid credentials",
807
- "description": "Use the Monitoring API key.",
808
- "value": "Invalid credentials"
809
- }
810
- }
811
- }
812
- }
813
- },
814
- "NotFoundResponse": {
815
- "description": "Not Found.",
816
- "content": {
817
- "text/plain": {
818
- "schema": {
819
- "type": "string"
820
- },
821
- "examples": {
822
- "NotFound": {
823
- "value": "Unknown cluster \"test\""
824
- }
825
- }
826
- }
827
- }
828
- },
829
- "IncidentsResponse": {
830
- "description": "OK",
831
- "content": {
832
- "application/json": {
833
- "schema": {
834
- "title": "incidentsResponse",
835
- "type": "object",
836
- "properties": {
837
- "incidents": {
838
- "type": "object",
839
- "additionalProperties": {
840
- "x-additionalPropertiesName": "cluster",
841
- "$ref": "#/components/schemas/Incidents"
842
- }
843
- }
844
- }
845
- },
846
- "examples": {
847
- "success": {
848
- "value": {
849
- "incidents": {
850
- "m134-de": [
851
- {
852
- "t": 1687441685000,
853
- "v": {
854
- "title": "Incident on cluster m134-de: Everything operating normally.\n",
855
- "status": "operational"
856
- }
857
- },
858
- {
859
- "t": 1687441579000,
860
- "v": {
861
- "title": "Incident on cluster m134-de: We are encountering a major\nissue that impact all API calls.\n",
862
- "status": "major_outage"
863
- }
864
- }
865
- ]
866
- }
867
- }
868
- }
869
- }
870
- }
871
- }
872
- },
873
- "InventoryResponse": {
874
- "description": "OK",
875
- "content": {
876
- "application/json": {
877
- "schema": {
878
- "title": "inventoryResponse",
879
- "type": "object",
880
- "properties": {
881
- "inventory": {
882
- "type": "array",
883
- "items": {
884
- "$ref": "#/components/schemas/Server"
885
- }
886
- }
887
- }
888
- },
889
- "examples": {
890
- "Success": {
891
- "value": {
892
- "inventory": [
893
- {
894
- "name": "c16-de-3",
895
- "region": "de",
896
- "is_slave": false,
897
- "is_replica": false,
898
- "cluster": "c16-de",
899
- "status": "PRODUCTION",
900
- "type": "cluster"
901
- },
902
- {
903
- "name": "c16-de-2",
904
- "region": "de",
905
- "is_slave": false,
906
- "is_replica": false,
907
- "cluster": "c16-de",
908
- "status": "PRODUCTION",
909
- "type": "cluster"
910
- },
911
- {
912
- "name": "c16-de-1",
913
- "region": "de",
914
- "is_slave": false,
915
- "is_replica": false,
916
- "cluster": "c16-de",
917
- "status": "PRODUCTION",
918
- "type": "cluster"
919
- }
920
- ]
921
- }
922
- }
923
- }
924
- }
925
- }
926
- },
927
- "ForbiddenResponse": {
928
- "description": "Forbidden",
929
- "content": {
930
- "application/json": {
931
- "schema": {
932
- "title": "forbidden",
933
- "type": "object",
934
- "additionalProperties": false,
935
- "properties": {
936
- "reason": {
937
- "type": "string"
938
- }
939
- }
940
- },
941
- "examples": {
942
- "Forbidden": {
943
- "value": {
944
- "reason": "invalid credentials"
945
- }
946
- }
947
- }
948
- }
949
- }
950
- },
951
- "LatencyResponse": {
952
- "description": "OK",
953
- "content": {
954
- "application/json": {
955
- "schema": {
956
- "title": "latencyResponse",
957
- "type": "object",
958
- "properties": {
959
- "metrics": {
960
- "title": "latencyMetric",
961
- "type": "object",
962
- "additionalProperties": false,
963
- "properties": {
964
- "latency": {
965
- "additionalProperties": {
966
- "x-additionalPropertiesName": "latencies",
967
- "$ref": "#/components/schemas/Time"
968
- }
969
- }
970
- }
971
- }
972
- }
973
- },
974
- "examples": {
975
- "Success": {
976
- "value": {
977
- "metrics": {
978
- "latency": {
979
- "c16-de": [
980
- {
981
- "t": 1688056200000,
982
- "v": 64
983
- },
984
- {
985
- "t": 1688056800000,
986
- "v": 59
987
- },
988
- {
989
- "t": 1688057400000,
990
- "v": 55
991
- }
992
- ]
993
- }
994
- }
995
- }
996
- }
997
- }
998
- }
999
- }
1000
- },
1001
- "BadRequestResponse": {
1002
- "description": "Bad Request.",
1003
- "content": {
1004
- "application/json": {
1005
- "schema": {
1006
- "title": "badRequest",
1007
- "type": "object",
1008
- "additionalProperties": false,
1009
- "properties": {
1010
- "reason": {
1011
- "type": "string"
1012
- }
1013
- }
1014
- },
1015
- "examples": {
1016
- "BadRequest": {
1017
- "value": {
1018
- "reason": "Unknown servers"
1019
- }
1020
- }
1021
- }
1022
- }
1023
- }
1024
- },
1025
- "IndexingResponse": {
1026
- "description": "OK",
1027
- "content": {
1028
- "application/json": {
1029
- "schema": {
1030
- "title": "indexingTimeResponse",
1031
- "type": "object",
1032
- "properties": {
1033
- "metrics": {
1034
- "title": "indexingMetric",
1035
- "type": "object",
1036
- "additionalProperties": false,
1037
- "properties": {
1038
- "indexing": {
1039
- "additionalProperties": {
1040
- "x-additionalPropertiesName": "cluster",
1041
- "$ref": "#/components/schemas/Time"
1042
- }
1043
- }
1044
- }
1045
- }
1046
- }
1047
- },
1048
- "examples": {
1049
- "Success": {
1050
- "value": {
1051
- "metrics": {
1052
- "indexing": {
1053
- "c16-de": [
1054
- {
1055
- "t": 1688056200000,
1056
- "v": 1562
1057
- },
1058
- {
1059
- "t": 1688056800000,
1060
- "v": 1637
1061
- },
1062
- {
1063
- "t": 1688057400000,
1064
- "v": 1754
1065
- }
1066
- ]
1067
- }
1068
- }
1069
- }
1070
- }
1071
- }
1072
- }
1073
- }
1074
- },
1075
- "ReachabilityResponse": {
1076
- "description": "OK",
1077
- "content": {
1078
- "application/json": {
1079
- "schema": {
1080
- "title": "reachabilityResponse",
1081
- "type": "object",
1082
- "additionalProperties": {
1083
- "x-additionalPropertiesName": "cluster",
1084
- "$ref": "#/components/schemas/Probes"
1085
- }
1086
- },
1087
- "examples": {
1088
- "Success": {
1089
- "value": {
1090
- "c16-de": {
1091
- "sdn-probe-frankfurt": false,
1092
- "monitoring-2": false,
1093
- "sdn-probe-awswest1": false
1094
- }
1095
- }
1096
- }
1097
- }
1098
- }
1099
- }
1100
- },
1101
- "InfrastructureResponse": {
1102
- "description": "OK",
1103
- "content": {
1104
- "application/json": {
1105
- "schema": {
1106
- "title": "infrastructureResponse",
1107
- "type": "object",
1108
- "additionalProperties": false,
1109
- "properties": {
1110
- "metrics": {
1111
- "title": "metrics",
1112
- "type": "object",
1113
- "additionalProperties": false,
1114
- "properties": {
1115
- "cpu_usage": {
1116
- "type": "object",
1117
- "description": "CPU idleness in %.",
1118
- "additionalProperties": {
1119
- "x-additionalPropertiesName": "probes",
1120
- "$ref": "#/components/schemas/InfraProbes"
1121
- }
1122
- },
1123
- "ram_indexing_usage": {
1124
- "type": "object",
1125
- "description": "RAM used for indexing in MB.",
1126
- "additionalProperties": {
1127
- "x-additionalPropertiesName": "probes",
1128
- "$ref": "#/components/schemas/InfraProbes"
1129
- }
1130
- },
1131
- "ram_search_usage": {
1132
- "type": "object",
1133
- "description": "RAM used for search in MB.",
1134
- "additionalProperties": {
1135
- "x-additionalPropertiesName": "probes",
1136
- "$ref": "#/components/schemas/InfraProbes"
1137
- }
1138
- },
1139
- "ssd_usage": {
1140
- "type": "object",
1141
- "description": "Solid-state disk (SSD) usage expressed as % of RAM. \n0% means no SSD usage. A value of 50% indicates 32 GB SSD usage for a machine with 64 RAM.\n",
1142
- "additionalProperties": {
1143
- "x-additionalPropertiesName": "probes",
1144
- "$ref": "#/components/schemas/InfraProbes"
1145
- }
1146
- },
1147
- "avg_build_time": {
1148
- "type": "object",
1149
- "description": "Average build time of the indices in seconds.",
1150
- "additionalProperties": {
1151
- "x-additionalPropertiesName": "probes",
1152
- "$ref": "#/components/schemas/InfraProbes"
1153
- }
1154
- }
1155
- }
1156
- }
1157
- }
1158
- },
1159
- "examples": {
1160
- "success": {
1161
- "value": {
1162
- "metrics": {
1163
- "cpu_usage": {
1164
- "s4-fr": [
1165
- {
1166
- "t": 1455101280,
1167
- "v": 46
1168
- },
1169
- {
1170
- "t": 1455101290,
1171
- "v": 46
1172
- },
1173
- {
1174
- "t": 1455101300,
1175
- "v": 46
1176
- }
1177
- ],
1178
- "c3-use-1": [
1179
- {
1180
- "t": 1455101280,
1181
- "v": 42
1182
- },
1183
- {
1184
- "t": 1455101290,
1185
- "v": 42
1186
- },
1187
- {
1188
- "t": 1455101300,
1189
- "v": 42
1190
- },
1191
- {
1192
- "t": 1455101310,
1193
- "v": 37
1194
- }
1195
- ],
1196
- "c3-use-2": [
1197
- {
1198
- "t": 1455101280,
1199
- "v": 56
1200
- },
1201
- {
1202
- "t": 1455101290,
1203
- "v": 56
1204
- },
1205
- {
1206
- "t": 1455101300,
1207
- "v": 56
1208
- },
1209
- {
1210
- "t": 1455101310,
1211
- "v": 56
1212
- },
1213
- {
1214
- "t": 1455101320,
1215
- "v": 51
1216
- }
1217
- ]
1218
- }
1219
- }
1220
- }
1221
- }
1222
- }
1223
- }
1224
- }
1225
- },
1226
- "InfrastructureAPIUnauthorized": {
1227
- "description": "Unauthorized",
1228
- "content": {
1229
- "application/json": {
1230
- "schema": {
1231
- "title": "unauthorized",
1232
- "type": "object",
1233
- "additionalProperties": false,
1234
- "properties": {
1235
- "reason": {
1236
- "type": "string"
1237
- }
1238
- }
1239
- },
1240
- "examples": {
1241
- "Unauthorized": {
1242
- "value": {
1243
- "reason": "The infrastructure usage API is only available on Enterprise plans. Please contact enterprise@algolia.com for more detail."
1244
- }
1245
- }
1246
- }
1247
- }
1248
- }
1249
- }
1250
- }
1251
- },
1252
- "x-tagGroups": [
1253
- {
1254
- "name": "General",
1255
- "tags": [
1256
- "status",
1257
- "incidents",
1258
- "infrastructure",
1259
- "monitoring-tag"
1260
- ]
1261
- }
1262
- ]
1263
- }