@celigo/api-specs 0.2.202 → 0.2.204

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.
package/dist/agent.yml CHANGED
@@ -253,10 +253,39 @@ paths:
253
253
  _agentExtensionId: 68fb235610b42b2eaa6525c2
254
254
  port: '7020'
255
255
  lastHeartbeatAt: '2026-05-15T12:00:00.000Z'
256
+ '400':
257
+ description: '`_id` is not a valid ObjectId.'
258
+ content:
259
+ application/json:
260
+ schema:
261
+ $ref: '#/components/schemas/Error'
262
+ examples:
263
+ malformed-id:
264
+ value:
265
+ errors:
266
+ - code: invalid_ref
267
+ message: Please provide a valid _id.
256
268
  '401':
257
269
  $ref: '#/components/responses/401-unauthorized'
258
270
  '404':
259
- $ref: '#/components/responses/404-not-found'
271
+ description: |-
272
+ No agent has this id in the account. An agent in the recycle bin
273
+ answers with the recycle-bin message instead.
274
+ content:
275
+ application/json:
276
+ schema:
277
+ $ref: '#/components/schemas/Error'
278
+ examples:
279
+ not-found:
280
+ value:
281
+ errors:
282
+ - code: invalid_ref
283
+ message: On-premise agent not found for the given id.
284
+ in-recycle-bin:
285
+ value:
286
+ errors:
287
+ - code: invalid_ref
288
+ message: You are trying to access an on-premise agent that is already in the Recycle Bin. Please restore it from the Recycle Bin and try your request again.
260
289
  put:
261
290
  x-internal: false
262
291
  summary: Update an on-premise agent
@@ -310,11 +339,26 @@ paths:
310
339
  port: '7020'
311
340
  lastHeartbeatAt: '2026-05-15T12:00:00.000Z'
312
341
  '400':
313
- $ref: '#/components/responses/400-bad-request'
342
+ description: The body is not a JSON object, or `_id` is not a valid ObjectId.
343
+ content:
344
+ application/json:
345
+ schema:
346
+ $ref: '#/components/schemas/Error'
347
+ examples:
348
+ body-not-object:
349
+ value:
350
+ errors:
351
+ - code: invalid_request
352
+ message: Agent document should be a JSON object.
353
+ malformed-id:
354
+ value:
355
+ errors:
356
+ - code: invalid_ref
357
+ message: Please provide a valid _id.
314
358
  '401':
315
359
  $ref: '#/components/responses/401-unauthorized'
316
360
  '404':
317
- $ref: '#/components/responses/404-not-found'
361
+ $ref: '#/components/responses/404-agent-not-found'
318
362
  delete:
319
363
  x-internal: false
320
364
  summary: Delete an on-premise agent
@@ -338,10 +382,34 @@ paths:
338
382
  responses:
339
383
  '204':
340
384
  description: Agent deleted.
385
+ '400':
386
+ description: '`_id` is not a valid ObjectId.'
387
+ content:
388
+ application/json:
389
+ schema:
390
+ $ref: '#/components/schemas/Error'
391
+ examples:
392
+ malformed-id:
393
+ value:
394
+ errors:
395
+ - code: invalid_ref
396
+ message: Please provide a valid _id.
341
397
  '401':
342
398
  $ref: '#/components/responses/401-unauthorized'
343
399
  '404':
344
- $ref: '#/components/responses/404-not-found'
400
+ description: |-
401
+ No active agent has this id. An unknown id and an agent already in the
402
+ recycle bin both answer with the recycle-bin message.
403
+ content:
404
+ application/json:
405
+ schema:
406
+ $ref: '#/components/schemas/Error'
407
+ examples:
408
+ not-active:
409
+ value:
410
+ errors:
411
+ - code: invalid_ref
412
+ message: You are trying to access an on-premise agent that is already in the Recycle Bin. Please restore it from the Recycle Bin and try your request again.
345
413
  '422':
346
414
  $ref: '#/components/responses/422-dependency-conflict'
347
415
  /v1/agents/{_id}/display-token:
@@ -379,7 +447,7 @@ paths:
379
447
  '401':
380
448
  $ref: '#/components/responses/401-unauthorized'
381
449
  '404':
382
- $ref: '#/components/responses/404-not-found'
450
+ $ref: '#/components/responses/404-agent-not-found'
383
451
  /v1/agents/{_id}/change-token:
384
452
  put:
385
453
  x-internal: false
@@ -416,7 +484,7 @@ paths:
416
484
  '401':
417
485
  $ref: '#/components/responses/401-unauthorized'
418
486
  '404':
419
- $ref: '#/components/responses/404-not-found'
487
+ $ref: '#/components/responses/404-agent-not-found'
420
488
  /v1/agents/{_id}/installer/signedURL:
421
489
  get:
422
490
  x-internal: false
@@ -467,7 +535,7 @@ paths:
467
535
  '401':
468
536
  $ref: '#/components/responses/401-unauthorized'
469
537
  '404':
470
- $ref: '#/components/responses/404-not-found'
538
+ $ref: '#/components/responses/404-agent-not-found'
471
539
  '422':
472
540
  $ref: '#/components/responses/422-unprocessable-entity'
473
541
  /v1/agents/{_id}/dependencies:
@@ -888,19 +956,18 @@ components:
888
956
  errors:
889
957
  - code: invalid_request
890
958
  message: The request body failed validation.
891
- 404-not-found:
892
- description: |
893
- Not found. The requested resource does not exist or is not visible to the caller.
959
+ 404-agent-not-found:
960
+ description: No on-premise agent has this id in the account.
894
961
  content:
895
962
  application/json:
896
963
  schema:
897
964
  $ref: '#/components/schemas/Error'
898
965
  examples:
899
- default:
966
+ not-found:
900
967
  value:
901
968
  errors:
902
- - code: not_found
903
- message: The requested resource was not found.
969
+ - code: invalid_ref
970
+ message: On-premise agent not found for the given id.
904
971
  422-dependency-conflict:
905
972
  description: |-
906
973
  The resource has dependents that must be deleted first. Each entry