@confighub/api 0.4.10 → 0.4.11
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/index.d.cts +297 -14
- package/dist/index.d.ts +297 -14
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2303,6 +2303,26 @@ interface paths {
|
|
|
2303
2303
|
patch?: never;
|
|
2304
2304
|
trace?: never;
|
|
2305
2305
|
};
|
|
2306
|
+
"/upload": {
|
|
2307
|
+
parameters: {
|
|
2308
|
+
query?: never;
|
|
2309
|
+
header?: never;
|
|
2310
|
+
path?: never;
|
|
2311
|
+
cookie?: never;
|
|
2312
|
+
};
|
|
2313
|
+
get?: never;
|
|
2314
|
+
put?: never;
|
|
2315
|
+
/**
|
|
2316
|
+
* Upload a bundle of configuration
|
|
2317
|
+
* @description Takes a bundle of rendered configuration files, splits it into resources, and makes a Space's Units, Links, and Invocations match it. Creates what is missing, 3-way merges what changed, and empties the Units of resources the bundle no longer contains, so uploading the same bundle again changes nothing. Every resource becomes its own Unit.
|
|
2318
|
+
*/
|
|
2319
|
+
post: operations["Upload"];
|
|
2320
|
+
delete?: never;
|
|
2321
|
+
options?: never;
|
|
2322
|
+
head?: never;
|
|
2323
|
+
patch?: never;
|
|
2324
|
+
trace?: never;
|
|
2325
|
+
};
|
|
2306
2326
|
"/user": {
|
|
2307
2327
|
parameters: {
|
|
2308
2328
|
query?: never;
|
|
@@ -5424,20 +5444,7 @@ interface components {
|
|
|
5424
5444
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5425
5445
|
*/
|
|
5426
5446
|
UUID: string;
|
|
5427
|
-
/**
|
|
5428
|
-
* @description Unit is the core unit of operation in ConfigHub. It contains a blob of configuration Data
|
|
5429
|
-
* of a single supported Toolchain Type (configuration format). This blob is typically a text document
|
|
5430
|
-
* that contains a collection of Kubernetes or infrastructure resources, or an application configuration
|
|
5431
|
-
* file. Applying / deploying or destroying the configuration happens as a single *transaction*
|
|
5432
|
-
* from ConfigHub's perspective. In reality, it is most often a multi-step workflow performed by
|
|
5433
|
-
* the underlying configuration / deployment tool. The resources must belong to a single
|
|
5434
|
-
* infrastructure provider and the actuation mechanism must be able to resolve references and
|
|
5435
|
-
* ordering dependencies among the resources within the document. For example, if one resource
|
|
5436
|
-
* needs to be fully provisioned to provide input to another resource, then the actuation code is
|
|
5437
|
-
* responsible for handling this. Revisions store historical copies of the configuration data.
|
|
5438
|
-
* Configuration data can be restored from prior Revisions. Units can also be cloned to create
|
|
5439
|
-
* new variants of a configuration.
|
|
5440
|
-
*/
|
|
5447
|
+
/** @description Unit is the core unit of operation in ConfigHub. It contains a blob of configuration Data of a single supported Config Type (configuration format). This blob is typically a text document that contains a collection of Kubernetes or infrastructure resources, or an application configuration file. Applying / deploying or destroying the configuration happens as a single *transaction* from ConfigHub's perspective. In reality, it is most often a multi-step workflow performed by the underlying configuration / deployment tool. The resources must belong to a single infrastructure provider and the actuation mechanism must be able to resolve references and ordering dependencies among the resources within the document. For example, if one resource needs to be fully provisioned to provide input to another resource, then the actuation code is responsible for handling this. Revisions store historical copies of the configuration data. Configuration data can be restored from prior Revisions. Units can also be cloned to create new variants of a configuration. */
|
|
5441
5448
|
Unit: {
|
|
5442
5449
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
5443
5450
|
Annotations?: {
|
|
@@ -5917,6 +5924,183 @@ interface components {
|
|
|
5917
5924
|
Error?: components["schemas"]["ResponseError"];
|
|
5918
5925
|
Message?: string;
|
|
5919
5926
|
};
|
|
5927
|
+
UploadBrokenEdge: {
|
|
5928
|
+
Cycle?: string[];
|
|
5929
|
+
From?: string;
|
|
5930
|
+
Kind?: string;
|
|
5931
|
+
Reason?: string;
|
|
5932
|
+
To?: string;
|
|
5933
|
+
};
|
|
5934
|
+
UploadComponentRequest: {
|
|
5935
|
+
/** @description Synthesize the release Namespace if the bundle lacks it. Off by default. */
|
|
5936
|
+
CreateNamespace?: boolean;
|
|
5937
|
+
/** @description The component name. */
|
|
5938
|
+
Name?: string;
|
|
5939
|
+
/** @description The release namespace. Required when the bundle has namespaced resources that name no namespace. */
|
|
5940
|
+
Namespace?: string;
|
|
5941
|
+
/** @description Prepended to the slugs of new Units, so two releases can share one Space. */
|
|
5942
|
+
SlugPrefix?: string;
|
|
5943
|
+
/** @description Ownership name within the component's Spaces. Default: Name. */
|
|
5944
|
+
SourceName?: string;
|
|
5945
|
+
/** @description Explicit Space slug, overriding SpacePattern. */
|
|
5946
|
+
Space?: string;
|
|
5947
|
+
SpaceAnnotations?: {
|
|
5948
|
+
[key: string]: string;
|
|
5949
|
+
};
|
|
5950
|
+
/** @description Set on Spaces the upload creates. */
|
|
5951
|
+
SpaceDeleteGates?: {
|
|
5952
|
+
[key: string]: boolean;
|
|
5953
|
+
};
|
|
5954
|
+
/** @description Merged over UploadRequest.SpaceLabels. */
|
|
5955
|
+
SpaceLabels?: {
|
|
5956
|
+
[key: string]: string;
|
|
5957
|
+
};
|
|
5958
|
+
/**
|
|
5959
|
+
* Format: uuid
|
|
5960
|
+
* @description Applies to the component's Spaces. New Units are created on it, except AppConfig and record Units.
|
|
5961
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5962
|
+
*/
|
|
5963
|
+
TargetID?: string;
|
|
5964
|
+
UnitAnnotations?: {
|
|
5965
|
+
[key: string]: string;
|
|
5966
|
+
};
|
|
5967
|
+
/** @description Set on Units the upload creates. */
|
|
5968
|
+
UnitDeleteGates?: {
|
|
5969
|
+
[key: string]: boolean;
|
|
5970
|
+
};
|
|
5971
|
+
/** @description Set on Units the upload creates. */
|
|
5972
|
+
UnitDestroyGates?: {
|
|
5973
|
+
[key: string]: boolean;
|
|
5974
|
+
};
|
|
5975
|
+
/** @description Set on every Unit the source writes. */
|
|
5976
|
+
UnitLabels?: {
|
|
5977
|
+
[key: string]: string;
|
|
5978
|
+
};
|
|
5979
|
+
};
|
|
5980
|
+
UploadComponentResult: {
|
|
5981
|
+
/** @description Inferred links dropped to keep the link graph acyclic. */
|
|
5982
|
+
BrokenLinks?: components["schemas"]["UploadBrokenEdge"][];
|
|
5983
|
+
Name?: string;
|
|
5984
|
+
NamespaceCollision?: components["schemas"]["UploadNamespaceCollision"];
|
|
5985
|
+
/**
|
|
5986
|
+
* Format: uuid
|
|
5987
|
+
* @description The record Unit holding what was uploaded and from where. Absent on a dry run.
|
|
5988
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5989
|
+
*/
|
|
5990
|
+
RecordUnitID?: string;
|
|
5991
|
+
/** @description Secret resources dropped from the bundle, as Kind/namespace/name. Secrets are never uploaded. */
|
|
5992
|
+
SkippedSecrets?: string[];
|
|
5993
|
+
SourceName?: string;
|
|
5994
|
+
Spaces?: components["schemas"]["UploadSpaceResult"][];
|
|
5995
|
+
/** @description References that resolved to no resource in the bundle. */
|
|
5996
|
+
UnmatchedReferences?: components["schemas"]["UploadUnmatchedReference"][];
|
|
5997
|
+
};
|
|
5998
|
+
UploadLinkResult: {
|
|
5999
|
+
/** @description Create or Unchanged. */
|
|
6000
|
+
Action?: string;
|
|
6001
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6002
|
+
FromUnit?: string;
|
|
6003
|
+
/**
|
|
6004
|
+
* Format: uuid
|
|
6005
|
+
* @description Absent for a Link a dry run would create.
|
|
6006
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6007
|
+
*/
|
|
6008
|
+
LinkID?: string;
|
|
6009
|
+
/** @description Why the link was inferred, e.g. reference:v1/ConfigMap. */
|
|
6010
|
+
Reason?: string;
|
|
6011
|
+
ToUnit?: string;
|
|
6012
|
+
};
|
|
6013
|
+
UploadNamespaceCollision: {
|
|
6014
|
+
/** @description The release Namespace the bundle already carries. */
|
|
6015
|
+
Namespace?: string;
|
|
6016
|
+
};
|
|
6017
|
+
UploadRequest: {
|
|
6018
|
+
/** @description Recorded on each Unit write. */
|
|
6019
|
+
ChangeDescription?: string;
|
|
6020
|
+
ChangeSetDescription?: string;
|
|
6021
|
+
/**
|
|
6022
|
+
* Format: uuid
|
|
6023
|
+
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space.
|
|
6024
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6025
|
+
*/
|
|
6026
|
+
ChangeSetID?: string;
|
|
6027
|
+
/** @description Placement of each component. Exactly one is supported. */
|
|
6028
|
+
Components?: components["schemas"]["UploadComponentRequest"][];
|
|
6029
|
+
/** @description The bundle's files. Paths must be relative and may not contain "..". */
|
|
6030
|
+
Files?: components["schemas"]["UploadRequestFile"][];
|
|
6031
|
+
Source?: components["schemas"]["UploadSourceInfo"];
|
|
6032
|
+
/** @description Labels applied to every Space, merge-patch: keys given are set, keys omitted are left alone. */
|
|
6033
|
+
SpaceLabels?: {
|
|
6034
|
+
[key: string]: string;
|
|
6035
|
+
};
|
|
6036
|
+
/** @description Slug pattern for created Spaces, over the Space's labels. Default {{.Labels.Component}}-{{.Labels.Variant}}. */
|
|
6037
|
+
SpacePattern?: string;
|
|
6038
|
+
};
|
|
6039
|
+
UploadRequestFile: {
|
|
6040
|
+
/** @description The file's contents. */
|
|
6041
|
+
Content?: string;
|
|
6042
|
+
/** @description Relative path within the bundle, e.g. backend.yaml. */
|
|
6043
|
+
Path?: string;
|
|
6044
|
+
};
|
|
6045
|
+
UploadResult: {
|
|
6046
|
+
Components?: components["schemas"]["UploadComponentResult"][];
|
|
6047
|
+
/** @description True when nothing was written. */
|
|
6048
|
+
DryRun?: boolean;
|
|
6049
|
+
/** @description Digest of the planned actions. */
|
|
6050
|
+
Plan?: string;
|
|
6051
|
+
};
|
|
6052
|
+
UploadSourceInfo: {
|
|
6053
|
+
/** @description The client that uploaded: cub, installer, ui. */
|
|
6054
|
+
Client?: string;
|
|
6055
|
+
ClientVersion?: string;
|
|
6056
|
+
/** @description The resolved digest, when the transport has one. */
|
|
6057
|
+
Digest?: string;
|
|
6058
|
+
/** @description Where the bundle came from, e.g. oci://ghcr.io/confighub/configs/cubbychat:1.4.0 or a local path. */
|
|
6059
|
+
Ref?: string;
|
|
6060
|
+
};
|
|
6061
|
+
UploadSpaceResult: {
|
|
6062
|
+
/** @description Create, Update, or Unchanged. */
|
|
6063
|
+
Action?: string;
|
|
6064
|
+
/**
|
|
6065
|
+
* Format: uuid
|
|
6066
|
+
* @description The ChangeSet the writes were recorded in. Absent on a dry run.
|
|
6067
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6068
|
+
*/
|
|
6069
|
+
ChangeSetID?: string;
|
|
6070
|
+
Links?: components["schemas"]["UploadLinkResult"][];
|
|
6071
|
+
Namespace?: string;
|
|
6072
|
+
/**
|
|
6073
|
+
* Format: uuid
|
|
6074
|
+
* @description Absent for a Space a dry run would create.
|
|
6075
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6076
|
+
*/
|
|
6077
|
+
SpaceID?: string;
|
|
6078
|
+
SpaceSlug?: string;
|
|
6079
|
+
Units?: components["schemas"]["UploadUnitResult"][];
|
|
6080
|
+
};
|
|
6081
|
+
UploadUnitResult: {
|
|
6082
|
+
/** @description Create, Update, Unchanged, Empty, Revive, or Adopt. */
|
|
6083
|
+
Action?: string;
|
|
6084
|
+
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
6085
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6086
|
+
Mutations?: components["schemas"]["MutationMap"];
|
|
6087
|
+
/** @description The resource identity this Unit is keyed by. */
|
|
6088
|
+
Resource?: string;
|
|
6089
|
+
/** @description Resource, AppConfig, AppConfigRendered, or Record. */
|
|
6090
|
+
Role?: string;
|
|
6091
|
+
Slug?: string;
|
|
6092
|
+
/**
|
|
6093
|
+
* Format: uuid
|
|
6094
|
+
* @description Absent for a Unit a dry run would create.
|
|
6095
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6096
|
+
*/
|
|
6097
|
+
UnitID?: string;
|
|
6098
|
+
};
|
|
6099
|
+
UploadUnmatchedReference: {
|
|
6100
|
+
FromUnit?: string;
|
|
6101
|
+
TargetName?: string;
|
|
6102
|
+
TargetType?: string;
|
|
6103
|
+
};
|
|
5920
6104
|
/** @description a User in Confighub. */
|
|
5921
6105
|
User: {
|
|
5922
6106
|
/**
|
|
@@ -34114,6 +34298,105 @@ interface operations {
|
|
|
34114
34298
|
};
|
|
34115
34299
|
};
|
|
34116
34300
|
};
|
|
34301
|
+
Upload: {
|
|
34302
|
+
parameters: {
|
|
34303
|
+
query?: {
|
|
34304
|
+
/** @description Plan the upload and return the same response without writing anything. */
|
|
34305
|
+
dry_run?: boolean;
|
|
34306
|
+
};
|
|
34307
|
+
header?: never;
|
|
34308
|
+
path?: never;
|
|
34309
|
+
cookie?: never;
|
|
34310
|
+
};
|
|
34311
|
+
requestBody?: {
|
|
34312
|
+
content: {
|
|
34313
|
+
"application/json": components["schemas"]["UploadRequest"];
|
|
34314
|
+
};
|
|
34315
|
+
};
|
|
34316
|
+
responses: {
|
|
34317
|
+
/** @description OK */
|
|
34318
|
+
200: {
|
|
34319
|
+
headers: {
|
|
34320
|
+
[name: string]: unknown;
|
|
34321
|
+
};
|
|
34322
|
+
content: {
|
|
34323
|
+
"application/json": components["schemas"]["UploadResult"];
|
|
34324
|
+
};
|
|
34325
|
+
};
|
|
34326
|
+
/** @description Multi-Status: some Unit or Link writes failed, each carrying its own error */
|
|
34327
|
+
207: {
|
|
34328
|
+
headers: {
|
|
34329
|
+
[name: string]: unknown;
|
|
34330
|
+
};
|
|
34331
|
+
content: {
|
|
34332
|
+
"application/json": components["schemas"]["UploadResult"];
|
|
34333
|
+
};
|
|
34334
|
+
};
|
|
34335
|
+
/** @description Upload request is invalid (Bad Request). */
|
|
34336
|
+
400: {
|
|
34337
|
+
headers: {
|
|
34338
|
+
[name: string]: unknown;
|
|
34339
|
+
};
|
|
34340
|
+
content: {
|
|
34341
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34342
|
+
};
|
|
34343
|
+
};
|
|
34344
|
+
/** @description Unauthorized access. */
|
|
34345
|
+
401: {
|
|
34346
|
+
headers: {
|
|
34347
|
+
[name: string]: unknown;
|
|
34348
|
+
};
|
|
34349
|
+
content: {
|
|
34350
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34351
|
+
};
|
|
34352
|
+
};
|
|
34353
|
+
/** @description Forbidden access. */
|
|
34354
|
+
403: {
|
|
34355
|
+
headers: {
|
|
34356
|
+
[name: string]: unknown;
|
|
34357
|
+
};
|
|
34358
|
+
content: {
|
|
34359
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34360
|
+
};
|
|
34361
|
+
};
|
|
34362
|
+
/** @description Upload not found. */
|
|
34363
|
+
404: {
|
|
34364
|
+
headers: {
|
|
34365
|
+
[name: string]: unknown;
|
|
34366
|
+
};
|
|
34367
|
+
content: {
|
|
34368
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34369
|
+
};
|
|
34370
|
+
};
|
|
34371
|
+
/** @description Upload data conflict. Data has changed since last read. */
|
|
34372
|
+
409: {
|
|
34373
|
+
headers: {
|
|
34374
|
+
[name: string]: unknown;
|
|
34375
|
+
};
|
|
34376
|
+
content: {
|
|
34377
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34378
|
+
};
|
|
34379
|
+
};
|
|
34380
|
+
/** @description Something went wrong while processing Upload. */
|
|
34381
|
+
500: {
|
|
34382
|
+
headers: {
|
|
34383
|
+
[name: string]: unknown;
|
|
34384
|
+
};
|
|
34385
|
+
content: {
|
|
34386
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34387
|
+
};
|
|
34388
|
+
};
|
|
34389
|
+
/** @description Unexpected error. */
|
|
34390
|
+
default: {
|
|
34391
|
+
headers: {
|
|
34392
|
+
[name: string]: unknown;
|
|
34393
|
+
};
|
|
34394
|
+
content: {
|
|
34395
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34396
|
+
};
|
|
34397
|
+
};
|
|
34398
|
+
};
|
|
34399
|
+
};
|
|
34117
34400
|
ListUsers: {
|
|
34118
34401
|
parameters: {
|
|
34119
34402
|
query?: {
|
package/dist/index.d.ts
CHANGED
|
@@ -2303,6 +2303,26 @@ interface paths {
|
|
|
2303
2303
|
patch?: never;
|
|
2304
2304
|
trace?: never;
|
|
2305
2305
|
};
|
|
2306
|
+
"/upload": {
|
|
2307
|
+
parameters: {
|
|
2308
|
+
query?: never;
|
|
2309
|
+
header?: never;
|
|
2310
|
+
path?: never;
|
|
2311
|
+
cookie?: never;
|
|
2312
|
+
};
|
|
2313
|
+
get?: never;
|
|
2314
|
+
put?: never;
|
|
2315
|
+
/**
|
|
2316
|
+
* Upload a bundle of configuration
|
|
2317
|
+
* @description Takes a bundle of rendered configuration files, splits it into resources, and makes a Space's Units, Links, and Invocations match it. Creates what is missing, 3-way merges what changed, and empties the Units of resources the bundle no longer contains, so uploading the same bundle again changes nothing. Every resource becomes its own Unit.
|
|
2318
|
+
*/
|
|
2319
|
+
post: operations["Upload"];
|
|
2320
|
+
delete?: never;
|
|
2321
|
+
options?: never;
|
|
2322
|
+
head?: never;
|
|
2323
|
+
patch?: never;
|
|
2324
|
+
trace?: never;
|
|
2325
|
+
};
|
|
2306
2326
|
"/user": {
|
|
2307
2327
|
parameters: {
|
|
2308
2328
|
query?: never;
|
|
@@ -5424,20 +5444,7 @@ interface components {
|
|
|
5424
5444
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5425
5445
|
*/
|
|
5426
5446
|
UUID: string;
|
|
5427
|
-
/**
|
|
5428
|
-
* @description Unit is the core unit of operation in ConfigHub. It contains a blob of configuration Data
|
|
5429
|
-
* of a single supported Toolchain Type (configuration format). This blob is typically a text document
|
|
5430
|
-
* that contains a collection of Kubernetes or infrastructure resources, or an application configuration
|
|
5431
|
-
* file. Applying / deploying or destroying the configuration happens as a single *transaction*
|
|
5432
|
-
* from ConfigHub's perspective. In reality, it is most often a multi-step workflow performed by
|
|
5433
|
-
* the underlying configuration / deployment tool. The resources must belong to a single
|
|
5434
|
-
* infrastructure provider and the actuation mechanism must be able to resolve references and
|
|
5435
|
-
* ordering dependencies among the resources within the document. For example, if one resource
|
|
5436
|
-
* needs to be fully provisioned to provide input to another resource, then the actuation code is
|
|
5437
|
-
* responsible for handling this. Revisions store historical copies of the configuration data.
|
|
5438
|
-
* Configuration data can be restored from prior Revisions. Units can also be cloned to create
|
|
5439
|
-
* new variants of a configuration.
|
|
5440
|
-
*/
|
|
5447
|
+
/** @description Unit is the core unit of operation in ConfigHub. It contains a blob of configuration Data of a single supported Config Type (configuration format). This blob is typically a text document that contains a collection of Kubernetes or infrastructure resources, or an application configuration file. Applying / deploying or destroying the configuration happens as a single *transaction* from ConfigHub's perspective. In reality, it is most often a multi-step workflow performed by the underlying configuration / deployment tool. The resources must belong to a single infrastructure provider and the actuation mechanism must be able to resolve references and ordering dependencies among the resources within the document. For example, if one resource needs to be fully provisioned to provide input to another resource, then the actuation code is responsible for handling this. Revisions store historical copies of the configuration data. Configuration data can be restored from prior Revisions. Units can also be cloned to create new variants of a configuration. */
|
|
5441
5448
|
Unit: {
|
|
5442
5449
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
5443
5450
|
Annotations?: {
|
|
@@ -5917,6 +5924,183 @@ interface components {
|
|
|
5917
5924
|
Error?: components["schemas"]["ResponseError"];
|
|
5918
5925
|
Message?: string;
|
|
5919
5926
|
};
|
|
5927
|
+
UploadBrokenEdge: {
|
|
5928
|
+
Cycle?: string[];
|
|
5929
|
+
From?: string;
|
|
5930
|
+
Kind?: string;
|
|
5931
|
+
Reason?: string;
|
|
5932
|
+
To?: string;
|
|
5933
|
+
};
|
|
5934
|
+
UploadComponentRequest: {
|
|
5935
|
+
/** @description Synthesize the release Namespace if the bundle lacks it. Off by default. */
|
|
5936
|
+
CreateNamespace?: boolean;
|
|
5937
|
+
/** @description The component name. */
|
|
5938
|
+
Name?: string;
|
|
5939
|
+
/** @description The release namespace. Required when the bundle has namespaced resources that name no namespace. */
|
|
5940
|
+
Namespace?: string;
|
|
5941
|
+
/** @description Prepended to the slugs of new Units, so two releases can share one Space. */
|
|
5942
|
+
SlugPrefix?: string;
|
|
5943
|
+
/** @description Ownership name within the component's Spaces. Default: Name. */
|
|
5944
|
+
SourceName?: string;
|
|
5945
|
+
/** @description Explicit Space slug, overriding SpacePattern. */
|
|
5946
|
+
Space?: string;
|
|
5947
|
+
SpaceAnnotations?: {
|
|
5948
|
+
[key: string]: string;
|
|
5949
|
+
};
|
|
5950
|
+
/** @description Set on Spaces the upload creates. */
|
|
5951
|
+
SpaceDeleteGates?: {
|
|
5952
|
+
[key: string]: boolean;
|
|
5953
|
+
};
|
|
5954
|
+
/** @description Merged over UploadRequest.SpaceLabels. */
|
|
5955
|
+
SpaceLabels?: {
|
|
5956
|
+
[key: string]: string;
|
|
5957
|
+
};
|
|
5958
|
+
/**
|
|
5959
|
+
* Format: uuid
|
|
5960
|
+
* @description Applies to the component's Spaces. New Units are created on it, except AppConfig and record Units.
|
|
5961
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5962
|
+
*/
|
|
5963
|
+
TargetID?: string;
|
|
5964
|
+
UnitAnnotations?: {
|
|
5965
|
+
[key: string]: string;
|
|
5966
|
+
};
|
|
5967
|
+
/** @description Set on Units the upload creates. */
|
|
5968
|
+
UnitDeleteGates?: {
|
|
5969
|
+
[key: string]: boolean;
|
|
5970
|
+
};
|
|
5971
|
+
/** @description Set on Units the upload creates. */
|
|
5972
|
+
UnitDestroyGates?: {
|
|
5973
|
+
[key: string]: boolean;
|
|
5974
|
+
};
|
|
5975
|
+
/** @description Set on every Unit the source writes. */
|
|
5976
|
+
UnitLabels?: {
|
|
5977
|
+
[key: string]: string;
|
|
5978
|
+
};
|
|
5979
|
+
};
|
|
5980
|
+
UploadComponentResult: {
|
|
5981
|
+
/** @description Inferred links dropped to keep the link graph acyclic. */
|
|
5982
|
+
BrokenLinks?: components["schemas"]["UploadBrokenEdge"][];
|
|
5983
|
+
Name?: string;
|
|
5984
|
+
NamespaceCollision?: components["schemas"]["UploadNamespaceCollision"];
|
|
5985
|
+
/**
|
|
5986
|
+
* Format: uuid
|
|
5987
|
+
* @description The record Unit holding what was uploaded and from where. Absent on a dry run.
|
|
5988
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5989
|
+
*/
|
|
5990
|
+
RecordUnitID?: string;
|
|
5991
|
+
/** @description Secret resources dropped from the bundle, as Kind/namespace/name. Secrets are never uploaded. */
|
|
5992
|
+
SkippedSecrets?: string[];
|
|
5993
|
+
SourceName?: string;
|
|
5994
|
+
Spaces?: components["schemas"]["UploadSpaceResult"][];
|
|
5995
|
+
/** @description References that resolved to no resource in the bundle. */
|
|
5996
|
+
UnmatchedReferences?: components["schemas"]["UploadUnmatchedReference"][];
|
|
5997
|
+
};
|
|
5998
|
+
UploadLinkResult: {
|
|
5999
|
+
/** @description Create or Unchanged. */
|
|
6000
|
+
Action?: string;
|
|
6001
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6002
|
+
FromUnit?: string;
|
|
6003
|
+
/**
|
|
6004
|
+
* Format: uuid
|
|
6005
|
+
* @description Absent for a Link a dry run would create.
|
|
6006
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6007
|
+
*/
|
|
6008
|
+
LinkID?: string;
|
|
6009
|
+
/** @description Why the link was inferred, e.g. reference:v1/ConfigMap. */
|
|
6010
|
+
Reason?: string;
|
|
6011
|
+
ToUnit?: string;
|
|
6012
|
+
};
|
|
6013
|
+
UploadNamespaceCollision: {
|
|
6014
|
+
/** @description The release Namespace the bundle already carries. */
|
|
6015
|
+
Namespace?: string;
|
|
6016
|
+
};
|
|
6017
|
+
UploadRequest: {
|
|
6018
|
+
/** @description Recorded on each Unit write. */
|
|
6019
|
+
ChangeDescription?: string;
|
|
6020
|
+
ChangeSetDescription?: string;
|
|
6021
|
+
/**
|
|
6022
|
+
* Format: uuid
|
|
6023
|
+
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space.
|
|
6024
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6025
|
+
*/
|
|
6026
|
+
ChangeSetID?: string;
|
|
6027
|
+
/** @description Placement of each component. Exactly one is supported. */
|
|
6028
|
+
Components?: components["schemas"]["UploadComponentRequest"][];
|
|
6029
|
+
/** @description The bundle's files. Paths must be relative and may not contain "..". */
|
|
6030
|
+
Files?: components["schemas"]["UploadRequestFile"][];
|
|
6031
|
+
Source?: components["schemas"]["UploadSourceInfo"];
|
|
6032
|
+
/** @description Labels applied to every Space, merge-patch: keys given are set, keys omitted are left alone. */
|
|
6033
|
+
SpaceLabels?: {
|
|
6034
|
+
[key: string]: string;
|
|
6035
|
+
};
|
|
6036
|
+
/** @description Slug pattern for created Spaces, over the Space's labels. Default {{.Labels.Component}}-{{.Labels.Variant}}. */
|
|
6037
|
+
SpacePattern?: string;
|
|
6038
|
+
};
|
|
6039
|
+
UploadRequestFile: {
|
|
6040
|
+
/** @description The file's contents. */
|
|
6041
|
+
Content?: string;
|
|
6042
|
+
/** @description Relative path within the bundle, e.g. backend.yaml. */
|
|
6043
|
+
Path?: string;
|
|
6044
|
+
};
|
|
6045
|
+
UploadResult: {
|
|
6046
|
+
Components?: components["schemas"]["UploadComponentResult"][];
|
|
6047
|
+
/** @description True when nothing was written. */
|
|
6048
|
+
DryRun?: boolean;
|
|
6049
|
+
/** @description Digest of the planned actions. */
|
|
6050
|
+
Plan?: string;
|
|
6051
|
+
};
|
|
6052
|
+
UploadSourceInfo: {
|
|
6053
|
+
/** @description The client that uploaded: cub, installer, ui. */
|
|
6054
|
+
Client?: string;
|
|
6055
|
+
ClientVersion?: string;
|
|
6056
|
+
/** @description The resolved digest, when the transport has one. */
|
|
6057
|
+
Digest?: string;
|
|
6058
|
+
/** @description Where the bundle came from, e.g. oci://ghcr.io/confighub/configs/cubbychat:1.4.0 or a local path. */
|
|
6059
|
+
Ref?: string;
|
|
6060
|
+
};
|
|
6061
|
+
UploadSpaceResult: {
|
|
6062
|
+
/** @description Create, Update, or Unchanged. */
|
|
6063
|
+
Action?: string;
|
|
6064
|
+
/**
|
|
6065
|
+
* Format: uuid
|
|
6066
|
+
* @description The ChangeSet the writes were recorded in. Absent on a dry run.
|
|
6067
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6068
|
+
*/
|
|
6069
|
+
ChangeSetID?: string;
|
|
6070
|
+
Links?: components["schemas"]["UploadLinkResult"][];
|
|
6071
|
+
Namespace?: string;
|
|
6072
|
+
/**
|
|
6073
|
+
* Format: uuid
|
|
6074
|
+
* @description Absent for a Space a dry run would create.
|
|
6075
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6076
|
+
*/
|
|
6077
|
+
SpaceID?: string;
|
|
6078
|
+
SpaceSlug?: string;
|
|
6079
|
+
Units?: components["schemas"]["UploadUnitResult"][];
|
|
6080
|
+
};
|
|
6081
|
+
UploadUnitResult: {
|
|
6082
|
+
/** @description Create, Update, Unchanged, Empty, Revive, or Adopt. */
|
|
6083
|
+
Action?: string;
|
|
6084
|
+
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
6085
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6086
|
+
Mutations?: components["schemas"]["MutationMap"];
|
|
6087
|
+
/** @description The resource identity this Unit is keyed by. */
|
|
6088
|
+
Resource?: string;
|
|
6089
|
+
/** @description Resource, AppConfig, AppConfigRendered, or Record. */
|
|
6090
|
+
Role?: string;
|
|
6091
|
+
Slug?: string;
|
|
6092
|
+
/**
|
|
6093
|
+
* Format: uuid
|
|
6094
|
+
* @description Absent for a Unit a dry run would create.
|
|
6095
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6096
|
+
*/
|
|
6097
|
+
UnitID?: string;
|
|
6098
|
+
};
|
|
6099
|
+
UploadUnmatchedReference: {
|
|
6100
|
+
FromUnit?: string;
|
|
6101
|
+
TargetName?: string;
|
|
6102
|
+
TargetType?: string;
|
|
6103
|
+
};
|
|
5920
6104
|
/** @description a User in Confighub. */
|
|
5921
6105
|
User: {
|
|
5922
6106
|
/**
|
|
@@ -34114,6 +34298,105 @@ interface operations {
|
|
|
34114
34298
|
};
|
|
34115
34299
|
};
|
|
34116
34300
|
};
|
|
34301
|
+
Upload: {
|
|
34302
|
+
parameters: {
|
|
34303
|
+
query?: {
|
|
34304
|
+
/** @description Plan the upload and return the same response without writing anything. */
|
|
34305
|
+
dry_run?: boolean;
|
|
34306
|
+
};
|
|
34307
|
+
header?: never;
|
|
34308
|
+
path?: never;
|
|
34309
|
+
cookie?: never;
|
|
34310
|
+
};
|
|
34311
|
+
requestBody?: {
|
|
34312
|
+
content: {
|
|
34313
|
+
"application/json": components["schemas"]["UploadRequest"];
|
|
34314
|
+
};
|
|
34315
|
+
};
|
|
34316
|
+
responses: {
|
|
34317
|
+
/** @description OK */
|
|
34318
|
+
200: {
|
|
34319
|
+
headers: {
|
|
34320
|
+
[name: string]: unknown;
|
|
34321
|
+
};
|
|
34322
|
+
content: {
|
|
34323
|
+
"application/json": components["schemas"]["UploadResult"];
|
|
34324
|
+
};
|
|
34325
|
+
};
|
|
34326
|
+
/** @description Multi-Status: some Unit or Link writes failed, each carrying its own error */
|
|
34327
|
+
207: {
|
|
34328
|
+
headers: {
|
|
34329
|
+
[name: string]: unknown;
|
|
34330
|
+
};
|
|
34331
|
+
content: {
|
|
34332
|
+
"application/json": components["schemas"]["UploadResult"];
|
|
34333
|
+
};
|
|
34334
|
+
};
|
|
34335
|
+
/** @description Upload request is invalid (Bad Request). */
|
|
34336
|
+
400: {
|
|
34337
|
+
headers: {
|
|
34338
|
+
[name: string]: unknown;
|
|
34339
|
+
};
|
|
34340
|
+
content: {
|
|
34341
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34342
|
+
};
|
|
34343
|
+
};
|
|
34344
|
+
/** @description Unauthorized access. */
|
|
34345
|
+
401: {
|
|
34346
|
+
headers: {
|
|
34347
|
+
[name: string]: unknown;
|
|
34348
|
+
};
|
|
34349
|
+
content: {
|
|
34350
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34351
|
+
};
|
|
34352
|
+
};
|
|
34353
|
+
/** @description Forbidden access. */
|
|
34354
|
+
403: {
|
|
34355
|
+
headers: {
|
|
34356
|
+
[name: string]: unknown;
|
|
34357
|
+
};
|
|
34358
|
+
content: {
|
|
34359
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34360
|
+
};
|
|
34361
|
+
};
|
|
34362
|
+
/** @description Upload not found. */
|
|
34363
|
+
404: {
|
|
34364
|
+
headers: {
|
|
34365
|
+
[name: string]: unknown;
|
|
34366
|
+
};
|
|
34367
|
+
content: {
|
|
34368
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34369
|
+
};
|
|
34370
|
+
};
|
|
34371
|
+
/** @description Upload data conflict. Data has changed since last read. */
|
|
34372
|
+
409: {
|
|
34373
|
+
headers: {
|
|
34374
|
+
[name: string]: unknown;
|
|
34375
|
+
};
|
|
34376
|
+
content: {
|
|
34377
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34378
|
+
};
|
|
34379
|
+
};
|
|
34380
|
+
/** @description Something went wrong while processing Upload. */
|
|
34381
|
+
500: {
|
|
34382
|
+
headers: {
|
|
34383
|
+
[name: string]: unknown;
|
|
34384
|
+
};
|
|
34385
|
+
content: {
|
|
34386
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34387
|
+
};
|
|
34388
|
+
};
|
|
34389
|
+
/** @description Unexpected error. */
|
|
34390
|
+
default: {
|
|
34391
|
+
headers: {
|
|
34392
|
+
[name: string]: unknown;
|
|
34393
|
+
};
|
|
34394
|
+
content: {
|
|
34395
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34396
|
+
};
|
|
34397
|
+
};
|
|
34398
|
+
};
|
|
34399
|
+
};
|
|
34117
34400
|
ListUsers: {
|
|
34118
34401
|
parameters: {
|
|
34119
34402
|
query?: {
|