@openkaiden/kdn-api 0.2.3 → 0.4.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.
- package/index.d.ts +203 -0
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -415,6 +415,193 @@ export type paths = {
|
|
|
415
415
|
patch?: never;
|
|
416
416
|
trace?: never;
|
|
417
417
|
};
|
|
418
|
+
"/secret/create": {
|
|
419
|
+
parameters: {
|
|
420
|
+
query?: never;
|
|
421
|
+
header?: never;
|
|
422
|
+
path?: never;
|
|
423
|
+
cookie?: never;
|
|
424
|
+
};
|
|
425
|
+
/** Create a secret */
|
|
426
|
+
get: {
|
|
427
|
+
parameters: {
|
|
428
|
+
query?: never;
|
|
429
|
+
header?: never;
|
|
430
|
+
path?: never;
|
|
431
|
+
cookie?: never;
|
|
432
|
+
};
|
|
433
|
+
requestBody?: never;
|
|
434
|
+
responses: {
|
|
435
|
+
/** @description Successful response */
|
|
436
|
+
200: {
|
|
437
|
+
headers: {
|
|
438
|
+
[name: string]: unknown;
|
|
439
|
+
};
|
|
440
|
+
content: {
|
|
441
|
+
/**
|
|
442
|
+
* @example {
|
|
443
|
+
* "name": "my-secret"
|
|
444
|
+
* }
|
|
445
|
+
*/
|
|
446
|
+
"application/json": components["schemas"]["SecretName"];
|
|
447
|
+
};
|
|
448
|
+
};
|
|
449
|
+
/** @description Error response */
|
|
450
|
+
400: {
|
|
451
|
+
headers: {
|
|
452
|
+
[name: string]: unknown;
|
|
453
|
+
};
|
|
454
|
+
content: {
|
|
455
|
+
/**
|
|
456
|
+
* @example {
|
|
457
|
+
* "error": "Error: secret already exists: my-secret"
|
|
458
|
+
* }
|
|
459
|
+
*/
|
|
460
|
+
"application/json": components["schemas"]["Error"];
|
|
461
|
+
};
|
|
462
|
+
};
|
|
463
|
+
};
|
|
464
|
+
};
|
|
465
|
+
put?: never;
|
|
466
|
+
post?: never;
|
|
467
|
+
delete?: never;
|
|
468
|
+
options?: never;
|
|
469
|
+
head?: never;
|
|
470
|
+
patch?: never;
|
|
471
|
+
trace?: never;
|
|
472
|
+
};
|
|
473
|
+
"/secret/list": {
|
|
474
|
+
parameters: {
|
|
475
|
+
query?: never;
|
|
476
|
+
header?: never;
|
|
477
|
+
path?: never;
|
|
478
|
+
cookie?: never;
|
|
479
|
+
};
|
|
480
|
+
/** List secrets */
|
|
481
|
+
get: {
|
|
482
|
+
parameters: {
|
|
483
|
+
query?: never;
|
|
484
|
+
header?: never;
|
|
485
|
+
path?: never;
|
|
486
|
+
cookie?: never;
|
|
487
|
+
};
|
|
488
|
+
requestBody?: never;
|
|
489
|
+
responses: {
|
|
490
|
+
/** @description Successful response */
|
|
491
|
+
200: {
|
|
492
|
+
headers: {
|
|
493
|
+
[name: string]: unknown;
|
|
494
|
+
};
|
|
495
|
+
content: {
|
|
496
|
+
/**
|
|
497
|
+
* @example {
|
|
498
|
+
* "items": [
|
|
499
|
+
* {
|
|
500
|
+
* "name": "my-secret",
|
|
501
|
+
* "type": "github",
|
|
502
|
+
* "description": "GitHub token"
|
|
503
|
+
* },
|
|
504
|
+
* {
|
|
505
|
+
* "name": "my-other-secret",
|
|
506
|
+
* "type": "other",
|
|
507
|
+
* "description": "a secret for example.com API",
|
|
508
|
+
* "envs": [
|
|
509
|
+
* "EXAMPLE_API_KEY",
|
|
510
|
+
* "EX_API_KEY"
|
|
511
|
+
* ],
|
|
512
|
+
* "hosts": [
|
|
513
|
+
* "api.example.com",
|
|
514
|
+
* "dev.example.com"
|
|
515
|
+
* ],
|
|
516
|
+
* "path": "/",
|
|
517
|
+
* "header": "Authorization",
|
|
518
|
+
* "headerTemplate": "Bearer ${value}"
|
|
519
|
+
* }
|
|
520
|
+
* ]
|
|
521
|
+
* }
|
|
522
|
+
*/
|
|
523
|
+
"application/json": components["schemas"]["SecretsList"];
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
/** @description Error response */
|
|
527
|
+
400: {
|
|
528
|
+
headers: {
|
|
529
|
+
[name: string]: unknown;
|
|
530
|
+
};
|
|
531
|
+
content: {
|
|
532
|
+
/**
|
|
533
|
+
* @example {
|
|
534
|
+
* "error": "Error: failed to list secrets"
|
|
535
|
+
* }
|
|
536
|
+
*/
|
|
537
|
+
"application/json": components["schemas"]["Error"];
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
put?: never;
|
|
543
|
+
post?: never;
|
|
544
|
+
delete?: never;
|
|
545
|
+
options?: never;
|
|
546
|
+
head?: never;
|
|
547
|
+
patch?: never;
|
|
548
|
+
trace?: never;
|
|
549
|
+
};
|
|
550
|
+
"/secret/remove": {
|
|
551
|
+
parameters: {
|
|
552
|
+
query?: never;
|
|
553
|
+
header?: never;
|
|
554
|
+
path?: never;
|
|
555
|
+
cookie?: never;
|
|
556
|
+
};
|
|
557
|
+
/** Remove a secret */
|
|
558
|
+
get: {
|
|
559
|
+
parameters: {
|
|
560
|
+
query?: never;
|
|
561
|
+
header?: never;
|
|
562
|
+
path?: never;
|
|
563
|
+
cookie?: never;
|
|
564
|
+
};
|
|
565
|
+
requestBody?: never;
|
|
566
|
+
responses: {
|
|
567
|
+
/** @description Successful response */
|
|
568
|
+
200: {
|
|
569
|
+
headers: {
|
|
570
|
+
[name: string]: unknown;
|
|
571
|
+
};
|
|
572
|
+
content: {
|
|
573
|
+
/**
|
|
574
|
+
* @example {
|
|
575
|
+
* "name": "my-secret"
|
|
576
|
+
* }
|
|
577
|
+
*/
|
|
578
|
+
"application/json": components["schemas"]["SecretName"];
|
|
579
|
+
};
|
|
580
|
+
};
|
|
581
|
+
/** @description Error response */
|
|
582
|
+
400: {
|
|
583
|
+
headers: {
|
|
584
|
+
[name: string]: unknown;
|
|
585
|
+
};
|
|
586
|
+
content: {
|
|
587
|
+
/**
|
|
588
|
+
* @example {
|
|
589
|
+
* "error": "Error: secret not found: my-secret"
|
|
590
|
+
* }
|
|
591
|
+
*/
|
|
592
|
+
"application/json": components["schemas"]["Error"];
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
};
|
|
596
|
+
};
|
|
597
|
+
put?: never;
|
|
598
|
+
post?: never;
|
|
599
|
+
delete?: never;
|
|
600
|
+
options?: never;
|
|
601
|
+
head?: never;
|
|
602
|
+
patch?: never;
|
|
603
|
+
trace?: never;
|
|
604
|
+
};
|
|
418
605
|
};
|
|
419
606
|
export type webhooks = Record<string, never>;
|
|
420
607
|
export type components = {
|
|
@@ -448,6 +635,22 @@ export type components = {
|
|
|
448
635
|
WorkspacesList: {
|
|
449
636
|
items: components["schemas"]["Workspace"][];
|
|
450
637
|
};
|
|
638
|
+
SecretName: {
|
|
639
|
+
name: string;
|
|
640
|
+
};
|
|
641
|
+
SecretInfo: {
|
|
642
|
+
name: string;
|
|
643
|
+
type: string;
|
|
644
|
+
description: string;
|
|
645
|
+
envs?: string[];
|
|
646
|
+
hosts?: string[];
|
|
647
|
+
path?: string;
|
|
648
|
+
header?: string;
|
|
649
|
+
headerTemplate?: string;
|
|
650
|
+
};
|
|
651
|
+
SecretsList: {
|
|
652
|
+
items: components["schemas"]["SecretInfo"][];
|
|
653
|
+
};
|
|
451
654
|
};
|
|
452
655
|
responses: never;
|
|
453
656
|
parameters: never;
|