@confighub/api 0.9.14 → 0.9.16
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 +61 -5
- package/dist/index.d.ts +61 -5
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -871,7 +871,7 @@ interface paths {
|
|
|
871
871
|
put?: never;
|
|
872
872
|
/**
|
|
873
873
|
* Bulk create (copy) multiple links
|
|
874
|
-
* @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where, or
|
|
874
|
+
* @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters.
|
|
875
875
|
*/
|
|
876
876
|
post: operations["BulkCreateLinks"];
|
|
877
877
|
/**
|
|
@@ -2952,7 +2952,7 @@ interface paths {
|
|
|
2952
2952
|
put?: never;
|
|
2953
2953
|
/**
|
|
2954
2954
|
* Set path protection on a unit
|
|
2955
|
-
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. A merge's WhereMutation protects further paths on top of these. UnprotectAll clears every Protected value before ResourceProtection is applied. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2955
|
+
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. The empty path protects a resource as a whole: a merge then withholds every change to it, including its deletion and replacement. A merge's WhereMutation protects further paths on top of these. UnprotectAll clears every Protected value before ResourceProtection is applied. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2956
2956
|
*/
|
|
2957
2957
|
post: operations["SetUnitProtection"];
|
|
2958
2958
|
delete?: never;
|
|
@@ -7873,11 +7873,11 @@ interface components {
|
|
|
7873
7873
|
ResourceAnnotations?: components["schemas"]["PathAnnotations"];
|
|
7874
7874
|
};
|
|
7875
7875
|
ResourceProtection: {
|
|
7876
|
-
/** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update */
|
|
7876
|
+
/** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
|
|
7877
7877
|
Protected?: {
|
|
7878
7878
|
[key: string]: boolean;
|
|
7879
7879
|
} | null;
|
|
7880
|
-
/** @description Identifies the resource within the unit whose
|
|
7880
|
+
/** @description Identifies the resource within the unit whose protection is being set */
|
|
7881
7881
|
Resource?: components["schemas"]["ResourceInfo"];
|
|
7882
7882
|
};
|
|
7883
7883
|
ResourceTypePathsEntry: {
|
|
@@ -23849,7 +23849,7 @@ interface operations {
|
|
|
23849
23849
|
*
|
|
23850
23850
|
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
23851
23851
|
*
|
|
23852
|
-
* Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match.
|
|
23852
|
+
* Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match. Exactly one of reverse, from_downstream_where and where_space/filter_space is required.
|
|
23853
23853
|
*
|
|
23854
23854
|
* The whole string must be query-encoded.
|
|
23855
23855
|
*/
|
|
@@ -23896,6 +23896,62 @@ interface operations {
|
|
|
23896
23896
|
* The whole string must be query-encoded.
|
|
23897
23897
|
*/
|
|
23898
23898
|
to_downstream_where?: string;
|
|
23899
|
+
/**
|
|
23900
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
23901
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
23902
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
23903
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
23904
|
+
* as in the JSON encoding.
|
|
23905
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
23906
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
23907
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
23908
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
23909
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
23910
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
23911
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
23912
|
+
* UUID and time literals must be quoted as string literals.
|
|
23913
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
23914
|
+
* Time literals use the same form as when serialized as JSON,
|
|
23915
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
23916
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
23917
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
23918
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
23919
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
23920
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
23921
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
23922
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
23923
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
23924
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
23925
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
23926
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
23927
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
23928
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
23929
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
23930
|
+
* Conjunctions are supported using the `AND` operator.
|
|
23931
|
+
* An example conjunction is:
|
|
23932
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
23933
|
+
*
|
|
23934
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
|
|
23935
|
+
*
|
|
23936
|
+
* Where expression selecting spaces to copy each source link to, from and to the units of the same slugs there. A link to a unit in another space keeps that unit. A space with no unit of a slug the link needs gets an error for that copy. UpgradeUnit links are not copied.
|
|
23937
|
+
*
|
|
23938
|
+
* The whole string must be query-encoded.
|
|
23939
|
+
*/
|
|
23940
|
+
where_space?: string;
|
|
23941
|
+
/**
|
|
23942
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
23943
|
+
*
|
|
23944
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
23945
|
+
*
|
|
23946
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
23947
|
+
*
|
|
23948
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
23949
|
+
*
|
|
23950
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
23951
|
+
*
|
|
23952
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
23953
|
+
*/
|
|
23954
|
+
filter_space?: string;
|
|
23899
23955
|
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
23900
23956
|
allow_exists?: string;
|
|
23901
23957
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -871,7 +871,7 @@ interface paths {
|
|
|
871
871
|
put?: never;
|
|
872
872
|
/**
|
|
873
873
|
* Bulk create (copy) multiple links
|
|
874
|
-
* @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where, or
|
|
874
|
+
* @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters.
|
|
875
875
|
*/
|
|
876
876
|
post: operations["BulkCreateLinks"];
|
|
877
877
|
/**
|
|
@@ -2952,7 +2952,7 @@ interface paths {
|
|
|
2952
2952
|
put?: never;
|
|
2953
2953
|
/**
|
|
2954
2954
|
* Set path protection on a unit
|
|
2955
|
-
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. A merge's WhereMutation protects further paths on top of these. UnprotectAll clears every Protected value before ResourceProtection is applied. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2955
|
+
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. The empty path protects a resource as a whole: a merge then withholds every change to it, including its deletion and replacement. A merge's WhereMutation protects further paths on top of these. UnprotectAll clears every Protected value before ResourceProtection is applied. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2956
2956
|
*/
|
|
2957
2957
|
post: operations["SetUnitProtection"];
|
|
2958
2958
|
delete?: never;
|
|
@@ -7873,11 +7873,11 @@ interface components {
|
|
|
7873
7873
|
ResourceAnnotations?: components["schemas"]["PathAnnotations"];
|
|
7874
7874
|
};
|
|
7875
7875
|
ResourceProtection: {
|
|
7876
|
-
/** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update */
|
|
7876
|
+
/** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
|
|
7877
7877
|
Protected?: {
|
|
7878
7878
|
[key: string]: boolean;
|
|
7879
7879
|
} | null;
|
|
7880
|
-
/** @description Identifies the resource within the unit whose
|
|
7880
|
+
/** @description Identifies the resource within the unit whose protection is being set */
|
|
7881
7881
|
Resource?: components["schemas"]["ResourceInfo"];
|
|
7882
7882
|
};
|
|
7883
7883
|
ResourceTypePathsEntry: {
|
|
@@ -23849,7 +23849,7 @@ interface operations {
|
|
|
23849
23849
|
*
|
|
23850
23850
|
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
23851
23851
|
*
|
|
23852
|
-
* Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match.
|
|
23852
|
+
* Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match. Exactly one of reverse, from_downstream_where and where_space/filter_space is required.
|
|
23853
23853
|
*
|
|
23854
23854
|
* The whole string must be query-encoded.
|
|
23855
23855
|
*/
|
|
@@ -23896,6 +23896,62 @@ interface operations {
|
|
|
23896
23896
|
* The whole string must be query-encoded.
|
|
23897
23897
|
*/
|
|
23898
23898
|
to_downstream_where?: string;
|
|
23899
|
+
/**
|
|
23900
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
23901
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
23902
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
23903
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
23904
|
+
* as in the JSON encoding.
|
|
23905
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
23906
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
23907
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
23908
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
23909
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
23910
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
23911
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
23912
|
+
* UUID and time literals must be quoted as string literals.
|
|
23913
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
23914
|
+
* Time literals use the same form as when serialized as JSON,
|
|
23915
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
23916
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
23917
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
23918
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
23919
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
23920
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
23921
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
23922
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
23923
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
23924
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
23925
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
23926
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
23927
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
23928
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
23929
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
23930
|
+
* Conjunctions are supported using the `AND` operator.
|
|
23931
|
+
* An example conjunction is:
|
|
23932
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
23933
|
+
*
|
|
23934
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
|
|
23935
|
+
*
|
|
23936
|
+
* Where expression selecting spaces to copy each source link to, from and to the units of the same slugs there. A link to a unit in another space keeps that unit. A space with no unit of a slug the link needs gets an error for that copy. UpgradeUnit links are not copied.
|
|
23937
|
+
*
|
|
23938
|
+
* The whole string must be query-encoded.
|
|
23939
|
+
*/
|
|
23940
|
+
where_space?: string;
|
|
23941
|
+
/**
|
|
23942
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
23943
|
+
*
|
|
23944
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
23945
|
+
*
|
|
23946
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
23947
|
+
*
|
|
23948
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
23949
|
+
*
|
|
23950
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
23951
|
+
*
|
|
23952
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
23953
|
+
*/
|
|
23954
|
+
filter_space?: string;
|
|
23899
23955
|
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
23900
23956
|
allow_exists?: string;
|
|
23901
23957
|
/**
|