@confighub/api 0.8.25 → 0.8.26
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 +1489 -194
- package/dist/index.d.ts +1489 -194
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -415,7 +415,11 @@ interface paths {
|
|
|
415
415
|
*/
|
|
416
416
|
get: operations["ListAllChannels"];
|
|
417
417
|
put?: never;
|
|
418
|
-
|
|
418
|
+
/**
|
|
419
|
+
* Bulk create (clone) multiple channels
|
|
420
|
+
* @description Clone multiple channels selected by query parameters with optional name prefixes and destination spaces
|
|
421
|
+
*/
|
|
422
|
+
post: operations["BulkCreateChannels"];
|
|
419
423
|
/**
|
|
420
424
|
* Bulk delete multiple channels
|
|
421
425
|
* @description Delete multiple channels selected by query parameters
|
|
@@ -430,6 +434,26 @@ interface paths {
|
|
|
430
434
|
patch: operations["BulkPatchChannels"];
|
|
431
435
|
trace?: never;
|
|
432
436
|
};
|
|
437
|
+
"/channel/move": {
|
|
438
|
+
parameters: {
|
|
439
|
+
query?: never;
|
|
440
|
+
header?: never;
|
|
441
|
+
path?: never;
|
|
442
|
+
cookie?: never;
|
|
443
|
+
};
|
|
444
|
+
get?: never;
|
|
445
|
+
put?: never;
|
|
446
|
+
/**
|
|
447
|
+
* Move channels to another space
|
|
448
|
+
* @description Move the selected Channels, with their command runs, to another Space. A Channel a client holds the lease of is not moved: its polls name the Space it is in. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved.
|
|
449
|
+
*/
|
|
450
|
+
post: operations["BulkMoveChannels"];
|
|
451
|
+
delete?: never;
|
|
452
|
+
options?: never;
|
|
453
|
+
head?: never;
|
|
454
|
+
patch?: never;
|
|
455
|
+
trace?: never;
|
|
456
|
+
};
|
|
433
457
|
"/command": {
|
|
434
458
|
parameters: {
|
|
435
459
|
query?: never;
|
|
@@ -1888,6 +1912,30 @@ interface paths {
|
|
|
1888
1912
|
patch?: never;
|
|
1889
1913
|
trace?: never;
|
|
1890
1914
|
};
|
|
1915
|
+
"/space/{space_id}/channel/{channel_id}/document": {
|
|
1916
|
+
parameters: {
|
|
1917
|
+
query?: never;
|
|
1918
|
+
header?: never;
|
|
1919
|
+
path?: never;
|
|
1920
|
+
cookie?: never;
|
|
1921
|
+
};
|
|
1922
|
+
/**
|
|
1923
|
+
* Get the document of a Channel to edit
|
|
1924
|
+
* @description Returns the Channel as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version.
|
|
1925
|
+
*/
|
|
1926
|
+
get: operations["GetChannelDocument"];
|
|
1927
|
+
put?: never;
|
|
1928
|
+
/**
|
|
1929
|
+
* Update a Channel from an edit of its document
|
|
1930
|
+
* @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Channel: a field the edit leaves alone keeps what the Channel holds, and a field it removes is cleared. A Version other than the Channel's is a conflict.
|
|
1931
|
+
*/
|
|
1932
|
+
post: operations["UpdateChannelDocument"];
|
|
1933
|
+
delete?: never;
|
|
1934
|
+
options?: never;
|
|
1935
|
+
head?: never;
|
|
1936
|
+
patch?: never;
|
|
1937
|
+
trace?: never;
|
|
1938
|
+
};
|
|
1891
1939
|
"/space/{space_id}/channel/{channel_id}/lease": {
|
|
1892
1940
|
parameters: {
|
|
1893
1941
|
query?: never;
|
|
@@ -5034,6 +5082,11 @@ interface components {
|
|
|
5034
5082
|
Annotations?: {
|
|
5035
5083
|
[key: string]: string;
|
|
5036
5084
|
};
|
|
5085
|
+
/**
|
|
5086
|
+
* Format: uuid
|
|
5087
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5088
|
+
*/
|
|
5089
|
+
readonly BackingUnitID?: string;
|
|
5037
5090
|
/**
|
|
5038
5091
|
* Format: uuid
|
|
5039
5092
|
* @description ChannelID uniquely identifies a channel.
|
|
@@ -5073,7 +5126,7 @@ interface components {
|
|
|
5073
5126
|
readonly EntityType?: string;
|
|
5074
5127
|
/**
|
|
5075
5128
|
* Format: int64
|
|
5076
|
-
* @description The channel's bookmark into the event log. Set to the log's tail at creation; change it to replay or skip.
|
|
5129
|
+
* @description The channel's bookmark into the event log. Set to the log's tail at creation, a clone's too; change it to replay or skip.
|
|
5077
5130
|
*/
|
|
5078
5131
|
EventPosition: number;
|
|
5079
5132
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
@@ -5118,6 +5171,12 @@ interface components {
|
|
|
5118
5171
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5119
5172
|
*/
|
|
5120
5173
|
readonly UpdatedAt?: string;
|
|
5174
|
+
/**
|
|
5175
|
+
* Format: uuid
|
|
5176
|
+
* @description The Channel this Channel was cloned from, if any.
|
|
5177
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5178
|
+
*/
|
|
5179
|
+
readonly UpstreamChannelID?: string;
|
|
5121
5180
|
/**
|
|
5122
5181
|
* Format: int64
|
|
5123
5182
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
@@ -5646,14 +5705,17 @@ interface components {
|
|
|
5646
5705
|
Version?: number;
|
|
5647
5706
|
};
|
|
5648
5707
|
EventSubscription: {
|
|
5708
|
+
/** @description The event types to deliver, such as release.published. Empty means all. */
|
|
5649
5709
|
EventTypes?: string[];
|
|
5650
5710
|
/**
|
|
5651
5711
|
* Format: uuid
|
|
5712
|
+
* @description Restricts delivery to events about one Space. It has to name a Space when the Channel is written; a Space deleted later leaves the subscription matching nothing.
|
|
5652
5713
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5653
5714
|
*/
|
|
5654
5715
|
SpaceID?: string;
|
|
5655
5716
|
/**
|
|
5656
5717
|
* Format: uuid
|
|
5718
|
+
* @description Restricts delivery to events about one Target. It has to name a Target when the Channel is written; a Target deleted later leaves the subscription matching nothing.
|
|
5657
5719
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5658
5720
|
*/
|
|
5659
5721
|
TargetID?: string;
|
|
@@ -5665,18 +5727,24 @@ interface components {
|
|
|
5665
5727
|
Organization?: components["schemas"]["Organization"];
|
|
5666
5728
|
/** @description The Space the Attestation belongs to. */
|
|
5667
5729
|
Space?: components["schemas"]["Space"];
|
|
5730
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5731
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5668
5732
|
};
|
|
5669
5733
|
ExtendedAttribute: {
|
|
5670
5734
|
Attribute?: components["schemas"]["Attribute"];
|
|
5671
5735
|
Error?: components["schemas"]["ResponseError"];
|
|
5672
5736
|
Organization?: components["schemas"]["Organization"];
|
|
5673
5737
|
Space?: components["schemas"]["Space"];
|
|
5738
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5739
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5674
5740
|
};
|
|
5675
5741
|
ExtendedBridgeWorker: {
|
|
5676
5742
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
5677
5743
|
Error?: components["schemas"]["ResponseError"];
|
|
5678
5744
|
Organization?: components["schemas"]["Organization"];
|
|
5679
5745
|
Space?: components["schemas"]["Space"];
|
|
5746
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5747
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5680
5748
|
};
|
|
5681
5749
|
ExtendedChangeOrder: {
|
|
5682
5750
|
ChangeOrder?: components["schemas"]["ChangeOrder"];
|
|
@@ -5690,6 +5758,8 @@ interface components {
|
|
|
5690
5758
|
SpaceFilter?: components["schemas"]["Filter"];
|
|
5691
5759
|
StartTag?: components["schemas"]["Tag"];
|
|
5692
5760
|
UnitFilter?: components["schemas"]["Filter"];
|
|
5761
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5762
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5693
5763
|
};
|
|
5694
5764
|
ExtendedChangeSet: {
|
|
5695
5765
|
ChangeSet?: components["schemas"]["ChangeSet"];
|
|
@@ -5698,23 +5768,31 @@ interface components {
|
|
|
5698
5768
|
Organization?: components["schemas"]["Organization"];
|
|
5699
5769
|
Space?: components["schemas"]["Space"];
|
|
5700
5770
|
StartTag?: components["schemas"]["Tag"];
|
|
5771
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5772
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5701
5773
|
};
|
|
5702
5774
|
ExtendedChangeWorkflow: {
|
|
5703
5775
|
ChangeWorkflow?: components["schemas"]["ChangeWorkflow"];
|
|
5704
5776
|
Error?: components["schemas"]["ResponseError"];
|
|
5705
5777
|
Organization?: components["schemas"]["Organization"];
|
|
5706
5778
|
Space?: components["schemas"]["Space"];
|
|
5779
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5780
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5707
5781
|
};
|
|
5708
5782
|
ExtendedChannel: {
|
|
5709
5783
|
Channel?: components["schemas"]["Channel"];
|
|
5710
5784
|
Error?: components["schemas"]["ResponseError"];
|
|
5711
5785
|
Organization?: components["schemas"]["Organization"];
|
|
5712
5786
|
Space?: components["schemas"]["Space"];
|
|
5787
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5788
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5713
5789
|
};
|
|
5714
5790
|
ExtendedComponent: {
|
|
5715
5791
|
Component?: components["schemas"]["Component"];
|
|
5716
5792
|
Error?: components["schemas"]["ResponseError"];
|
|
5717
5793
|
Organization?: components["schemas"]["Organization"];
|
|
5794
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5795
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5718
5796
|
};
|
|
5719
5797
|
ExtendedFilter: {
|
|
5720
5798
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5722,12 +5800,16 @@ interface components {
|
|
|
5722
5800
|
FromSpace?: components["schemas"]["Space"];
|
|
5723
5801
|
Organization?: components["schemas"]["Organization"];
|
|
5724
5802
|
Space?: components["schemas"]["Space"];
|
|
5803
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5804
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5725
5805
|
};
|
|
5726
5806
|
/** @description Group with additional related entities expanded based on the request's include parameter. */
|
|
5727
5807
|
ExtendedGroup: {
|
|
5728
5808
|
Error?: components["schemas"]["ResponseError"];
|
|
5729
5809
|
/** @description The Group. */
|
|
5730
5810
|
Group?: components["schemas"]["Group"];
|
|
5811
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5812
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5731
5813
|
};
|
|
5732
5814
|
ExtendedInvocation: {
|
|
5733
5815
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
@@ -5735,6 +5817,8 @@ interface components {
|
|
|
5735
5817
|
Invocation?: components["schemas"]["Invocation"];
|
|
5736
5818
|
Organization?: components["schemas"]["Organization"];
|
|
5737
5819
|
Space?: components["schemas"]["Space"];
|
|
5820
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5821
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5738
5822
|
};
|
|
5739
5823
|
ExtendedLink: {
|
|
5740
5824
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5745,6 +5829,8 @@ interface components {
|
|
|
5745
5829
|
ToSpace?: components["schemas"]["Space"];
|
|
5746
5830
|
ToUnit?: components["schemas"]["Unit"];
|
|
5747
5831
|
TransformInvocation?: components["schemas"]["Invocation"];
|
|
5832
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5833
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5748
5834
|
};
|
|
5749
5835
|
ExtendedMutation: {
|
|
5750
5836
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5757,14 +5843,20 @@ interface components {
|
|
|
5757
5843
|
Space?: components["schemas"]["Space"];
|
|
5758
5844
|
Trigger?: components["schemas"]["Trigger"];
|
|
5759
5845
|
Unit?: components["schemas"]["Unit"];
|
|
5846
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5847
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5760
5848
|
};
|
|
5761
5849
|
ExtendedOrganization: {
|
|
5762
5850
|
Error?: components["schemas"]["ResponseError"];
|
|
5763
5851
|
Organization?: components["schemas"]["Organization"];
|
|
5852
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5853
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5764
5854
|
};
|
|
5765
5855
|
ExtendedOrganizationMember: {
|
|
5766
5856
|
Error?: components["schemas"]["ResponseError"];
|
|
5767
5857
|
OrganizationMember?: components["schemas"]["OrganizationMember"];
|
|
5858
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5859
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5768
5860
|
};
|
|
5769
5861
|
/** @description Release with additional related entities expanded based on the request's include parameter. */
|
|
5770
5862
|
ExtendedRelease: {
|
|
@@ -5781,6 +5873,8 @@ interface components {
|
|
|
5781
5873
|
Target?: components["schemas"]["Target"];
|
|
5782
5874
|
/** @description The User who published the Release. Expanded when requested via the include parameter. */
|
|
5783
5875
|
User?: components["schemas"]["User"];
|
|
5876
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5877
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5784
5878
|
};
|
|
5785
5879
|
ExtendedResource: {
|
|
5786
5880
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5794,7 +5888,7 @@ interface components {
|
|
|
5794
5888
|
Space?: components["schemas"]["Space"];
|
|
5795
5889
|
Target?: components["schemas"]["Target"];
|
|
5796
5890
|
Unit?: components["schemas"]["Unit"];
|
|
5797
|
-
View
|
|
5891
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5798
5892
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5799
5893
|
};
|
|
5800
5894
|
ExtendedReviewComment: {
|
|
@@ -5804,6 +5898,8 @@ interface components {
|
|
|
5804
5898
|
Revision?: components["schemas"]["Revision"];
|
|
5805
5899
|
Space?: components["schemas"]["Space"];
|
|
5806
5900
|
Unit?: components["schemas"]["Unit"];
|
|
5901
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5902
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5807
5903
|
};
|
|
5808
5904
|
ExtendedRevision: {
|
|
5809
5905
|
Attestations?: components["schemas"]["Attestation"][];
|
|
@@ -5817,11 +5913,15 @@ interface components {
|
|
|
5817
5913
|
Tags?: components["schemas"]["Tag"][];
|
|
5818
5914
|
Unit?: components["schemas"]["Unit"];
|
|
5819
5915
|
User?: components["schemas"]["User"];
|
|
5916
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5917
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5820
5918
|
};
|
|
5821
5919
|
ExtendedServiceAccount: {
|
|
5822
5920
|
Error?: components["schemas"]["ResponseError"];
|
|
5823
5921
|
Organization?: components["schemas"]["Organization"];
|
|
5824
5922
|
ServiceAccount?: components["schemas"]["ServiceAccount"];
|
|
5923
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5924
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5825
5925
|
};
|
|
5826
5926
|
ExtendedSpace: {
|
|
5827
5927
|
AttributeFilter?: components["schemas"]["Filter"];
|
|
@@ -5844,6 +5944,8 @@ interface components {
|
|
|
5844
5944
|
/** Format: int64 */
|
|
5845
5945
|
TotalChangeWorkflowCount?: number;
|
|
5846
5946
|
/** Format: int64 */
|
|
5947
|
+
TotalChannelCount?: number;
|
|
5948
|
+
/** Format: int64 */
|
|
5847
5949
|
TotalFilterCount?: number;
|
|
5848
5950
|
/** Format: int64 */
|
|
5849
5951
|
TotalInvocationCount?: number;
|
|
@@ -5870,6 +5972,8 @@ interface components {
|
|
|
5870
5972
|
UnreleasedUnitCount?: number;
|
|
5871
5973
|
/** Format: int64 */
|
|
5872
5974
|
UpgradableUnitCount?: number;
|
|
5975
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5976
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5873
5977
|
/** Format: int64 */
|
|
5874
5978
|
WarnedUnitCount?: number;
|
|
5875
5979
|
};
|
|
@@ -5879,6 +5983,8 @@ interface components {
|
|
|
5879
5983
|
Organization?: components["schemas"]["Organization"];
|
|
5880
5984
|
Space?: components["schemas"]["Space"];
|
|
5881
5985
|
Tag?: components["schemas"]["Tag"];
|
|
5986
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5987
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5882
5988
|
};
|
|
5883
5989
|
ExtendedTarget: {
|
|
5884
5990
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5887,6 +5993,8 @@ interface components {
|
|
|
5887
5993
|
Target?: components["schemas"]["Target"];
|
|
5888
5994
|
TriggerFilter?: components["schemas"]["Filter"];
|
|
5889
5995
|
Triggers?: components["schemas"]["Trigger"][];
|
|
5996
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5997
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5890
5998
|
};
|
|
5891
5999
|
ExtendedTrigger: {
|
|
5892
6000
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
@@ -5896,6 +6004,8 @@ interface components {
|
|
|
5896
6004
|
Space?: components["schemas"]["Space"];
|
|
5897
6005
|
Trigger?: components["schemas"]["Trigger"];
|
|
5898
6006
|
UnitFilter?: components["schemas"]["Filter"];
|
|
6007
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
6008
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5899
6009
|
};
|
|
5900
6010
|
/** @description Unit with capability to extend additional related entities. */
|
|
5901
6011
|
ExtendedUnit: {
|
|
@@ -5922,12 +6032,14 @@ interface components {
|
|
|
5922
6032
|
UpstreamSpace?: components["schemas"]["Space"];
|
|
5923
6033
|
/** @description If this Unit is a clone, the Upstream Unit it was cloned from. Optional. */
|
|
5924
6034
|
UpstreamUnit?: components["schemas"]["Unit"];
|
|
5925
|
-
View
|
|
6035
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5926
6036
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5927
6037
|
};
|
|
5928
6038
|
ExtendedUser: {
|
|
5929
6039
|
Error?: components["schemas"]["ResponseError"];
|
|
5930
6040
|
User?: components["schemas"]["User"];
|
|
6041
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
6042
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5931
6043
|
};
|
|
5932
6044
|
ExtendedView: {
|
|
5933
6045
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5935,6 +6047,8 @@ interface components {
|
|
|
5935
6047
|
Organization?: components["schemas"]["Organization"];
|
|
5936
6048
|
Space?: components["schemas"]["Space"];
|
|
5937
6049
|
View?: components["schemas"]["View"];
|
|
6050
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
6051
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5938
6052
|
};
|
|
5939
6053
|
/** @description Defines an entity filter. */
|
|
5940
6054
|
Filter: {
|
|
@@ -5967,7 +6081,7 @@ interface components {
|
|
|
5967
6081
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5968
6082
|
*/
|
|
5969
6083
|
FilterID?: string;
|
|
5970
|
-
/** @description From specifies the type of entity (Unit, Space, etc.) to filter, in PascalCase. */
|
|
6084
|
+
/** @description From specifies the type of entity (Unit, Space, etc.) to filter, in PascalCase. Required on create, and immutable. */
|
|
5971
6085
|
From: string;
|
|
5972
6086
|
/**
|
|
5973
6087
|
* Format: uuid
|
|
@@ -11422,7 +11536,7 @@ interface operations {
|
|
|
11422
11536
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
11423
11537
|
* If not specified, all fields are returned.
|
|
11424
11538
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
11425
|
-
* Fields used in where and contains filters,
|
|
11539
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
11426
11540
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
11427
11541
|
* The whole string must be query-encoded.
|
|
11428
11542
|
*/
|
|
@@ -11437,6 +11551,16 @@ interface operations {
|
|
|
11437
11551
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
11438
11552
|
*/
|
|
11439
11553
|
include_hidden?: string;
|
|
11554
|
+
/**
|
|
11555
|
+
* @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns.
|
|
11556
|
+
*
|
|
11557
|
+
* The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation.
|
|
11558
|
+
*
|
|
11559
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
11560
|
+
*
|
|
11561
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
11562
|
+
*/
|
|
11563
|
+
view?: string;
|
|
11440
11564
|
/** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
11441
11565
|
limit?: number;
|
|
11442
11566
|
/**
|
|
@@ -11626,7 +11750,7 @@ interface operations {
|
|
|
11626
11750
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
11627
11751
|
* If not specified, all fields are returned.
|
|
11628
11752
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
|
|
11629
|
-
* Fields used in where and contains filters,
|
|
11753
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
11630
11754
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
11631
11755
|
* The whole string must be query-encoded.
|
|
11632
11756
|
*/
|
|
@@ -11641,6 +11765,16 @@ interface operations {
|
|
|
11641
11765
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
11642
11766
|
*/
|
|
11643
11767
|
include_hidden?: string;
|
|
11768
|
+
/**
|
|
11769
|
+
* @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns.
|
|
11770
|
+
*
|
|
11771
|
+
* The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute.
|
|
11772
|
+
*
|
|
11773
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
11774
|
+
*
|
|
11775
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
11776
|
+
*/
|
|
11777
|
+
view?: string;
|
|
11644
11778
|
/** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
11645
11779
|
limit?: number;
|
|
11646
11780
|
/**
|
|
@@ -12805,7 +12939,7 @@ interface operations {
|
|
|
12805
12939
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
12806
12940
|
* If not specified, all fields are returned.
|
|
12807
12941
|
* Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
|
|
12808
|
-
* Fields used in where and contains filters,
|
|
12942
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
12809
12943
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
12810
12944
|
* The whole string must be query-encoded.
|
|
12811
12945
|
*/
|
|
@@ -12820,6 +12954,16 @@ interface operations {
|
|
|
12820
12954
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
12821
12955
|
*/
|
|
12822
12956
|
include_hidden?: string;
|
|
12957
|
+
/**
|
|
12958
|
+
* @description UUID of a View whose columns to compute for each BridgeWorker, returned as ViewColumns.
|
|
12959
|
+
*
|
|
12960
|
+
* The View must be in the same Organization as the user credentials, and be a View of BridgeWorker: its Of, or the From of its Filter, must be BridgeWorker.
|
|
12961
|
+
*
|
|
12962
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
12963
|
+
*
|
|
12964
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
12965
|
+
*/
|
|
12966
|
+
view?: string;
|
|
12823
12967
|
/** @description Maximum number of BridgeWorker entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
12824
12968
|
limit?: number;
|
|
12825
12969
|
/**
|
|
@@ -13781,7 +13925,7 @@ interface operations {
|
|
|
13781
13925
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13782
13926
|
* If not specified, all fields are returned.
|
|
13783
13927
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
|
|
13784
|
-
* Fields used in where and contains filters,
|
|
13928
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
13785
13929
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
13786
13930
|
* The whole string must be query-encoded.
|
|
13787
13931
|
*/
|
|
@@ -13796,6 +13940,16 @@ interface operations {
|
|
|
13796
13940
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
13797
13941
|
*/
|
|
13798
13942
|
include_hidden?: string;
|
|
13943
|
+
/**
|
|
13944
|
+
* @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns.
|
|
13945
|
+
*
|
|
13946
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder.
|
|
13947
|
+
*
|
|
13948
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
13949
|
+
*
|
|
13950
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
13951
|
+
*/
|
|
13952
|
+
view?: string;
|
|
13799
13953
|
/** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
13800
13954
|
limit?: number;
|
|
13801
13955
|
/**
|
|
@@ -14735,7 +14889,7 @@ interface operations {
|
|
|
14735
14889
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
14736
14890
|
* If not specified, all fields are returned.
|
|
14737
14891
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
|
|
14738
|
-
* Fields used in where and contains filters,
|
|
14892
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
14739
14893
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
14740
14894
|
* The whole string must be query-encoded.
|
|
14741
14895
|
*/
|
|
@@ -14750,6 +14904,16 @@ interface operations {
|
|
|
14750
14904
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
14751
14905
|
*/
|
|
14752
14906
|
include_hidden?: string;
|
|
14907
|
+
/**
|
|
14908
|
+
* @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns.
|
|
14909
|
+
*
|
|
14910
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet.
|
|
14911
|
+
*
|
|
14912
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
14913
|
+
*
|
|
14914
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
14915
|
+
*/
|
|
14916
|
+
view?: string;
|
|
14753
14917
|
/** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
14754
14918
|
limit?: number;
|
|
14755
14919
|
/**
|
|
@@ -15840,7 +16004,7 @@ interface operations {
|
|
|
15840
16004
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
15841
16005
|
* If not specified, all fields are returned.
|
|
15842
16006
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
|
|
15843
|
-
* Fields used in where and contains filters,
|
|
16007
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
15844
16008
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
15845
16009
|
* The whole string must be query-encoded.
|
|
15846
16010
|
*/
|
|
@@ -15855,6 +16019,16 @@ interface operations {
|
|
|
15855
16019
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
15856
16020
|
*/
|
|
15857
16021
|
include_hidden?: string;
|
|
16022
|
+
/**
|
|
16023
|
+
* @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns.
|
|
16024
|
+
*
|
|
16025
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow.
|
|
16026
|
+
*
|
|
16027
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
16028
|
+
*
|
|
16029
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
16030
|
+
*/
|
|
16031
|
+
view?: string;
|
|
15858
16032
|
/** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
15859
16033
|
limit?: number;
|
|
15860
16034
|
/**
|
|
@@ -16978,7 +17152,7 @@ interface operations {
|
|
|
16978
17152
|
* An example conjunction is:
|
|
16979
17153
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16980
17154
|
*
|
|
16981
|
-
* Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
|
|
17155
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
16982
17156
|
*
|
|
16983
17157
|
* The whole string must be query-encoded.
|
|
16984
17158
|
*/
|
|
@@ -17031,7 +17205,7 @@ interface operations {
|
|
|
17031
17205
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
17032
17206
|
* If not specified, all fields are returned.
|
|
17033
17207
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
|
|
17034
|
-
* Fields used in where and contains filters,
|
|
17208
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
17035
17209
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
17036
17210
|
* The whole string must be query-encoded.
|
|
17037
17211
|
*/
|
|
@@ -17046,6 +17220,16 @@ interface operations {
|
|
|
17046
17220
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
17047
17221
|
*/
|
|
17048
17222
|
include_hidden?: string;
|
|
17223
|
+
/**
|
|
17224
|
+
* @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns.
|
|
17225
|
+
*
|
|
17226
|
+
* The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel.
|
|
17227
|
+
*
|
|
17228
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
17229
|
+
*
|
|
17230
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
17231
|
+
*/
|
|
17232
|
+
view?: string;
|
|
17049
17233
|
/** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
17050
17234
|
limit?: number;
|
|
17051
17235
|
/**
|
|
@@ -17053,7 +17237,7 @@ interface operations {
|
|
|
17053
17237
|
*
|
|
17054
17238
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
17055
17239
|
*
|
|
17056
|
-
* Supported attributes for ordering Channel: ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt.
|
|
17240
|
+
* Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID.
|
|
17057
17241
|
*
|
|
17058
17242
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
17059
17243
|
*
|
|
@@ -17144,7 +17328,7 @@ interface operations {
|
|
|
17144
17328
|
};
|
|
17145
17329
|
};
|
|
17146
17330
|
};
|
|
17147
|
-
|
|
17331
|
+
BulkCreateChannels: {
|
|
17148
17332
|
parameters: {
|
|
17149
17333
|
query?: {
|
|
17150
17334
|
/**
|
|
@@ -17182,7 +17366,7 @@ interface operations {
|
|
|
17182
17366
|
* An example conjunction is:
|
|
17183
17367
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17184
17368
|
*
|
|
17185
|
-
* Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
|
|
17369
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
17186
17370
|
*
|
|
17187
17371
|
* The whole string must be query-encoded.
|
|
17188
17372
|
*/
|
|
@@ -17243,12 +17427,161 @@ interface operations {
|
|
|
17243
17427
|
limit?: number;
|
|
17244
17428
|
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
17245
17429
|
continue?: string;
|
|
17430
|
+
/** @description Comma-separated list of prefixes to apply to cloned Channel names */
|
|
17431
|
+
name_prefixes?: string;
|
|
17432
|
+
/** @description Comma-separated list of labels with multiple values for cloned Channel labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
|
|
17433
|
+
variant_labels?: string;
|
|
17434
|
+
/** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
|
|
17435
|
+
name_pattern?: string;
|
|
17436
|
+
/**
|
|
17437
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
17438
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
17439
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
17440
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
17441
|
+
* as in the JSON encoding.
|
|
17442
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
17443
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
17444
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
17445
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
17446
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
17447
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
17448
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
17449
|
+
* UUID and time literals must be quoted as string literals.
|
|
17450
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
17451
|
+
* Time literals use the same form as when serialized as JSON,
|
|
17452
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
17453
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
17454
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
17455
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
17456
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
17457
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
17458
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
17459
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
17460
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
17461
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
17462
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
17463
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
17464
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
17465
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
17466
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
17467
|
+
* Conjunctions are supported using the `AND` operator.
|
|
17468
|
+
* An example conjunction is:
|
|
17469
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17470
|
+
*
|
|
17471
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
|
|
17472
|
+
*
|
|
17473
|
+
* Where expression to select destination spaces for cloning channels
|
|
17474
|
+
*
|
|
17475
|
+
* The whole string must be query-encoded.
|
|
17476
|
+
*/
|
|
17477
|
+
where_space?: string;
|
|
17478
|
+
/**
|
|
17479
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
17480
|
+
*
|
|
17481
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
17482
|
+
*
|
|
17483
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
17484
|
+
*
|
|
17485
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
17486
|
+
*
|
|
17487
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
17488
|
+
*
|
|
17489
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
17490
|
+
*/
|
|
17491
|
+
filter_space?: string;
|
|
17492
|
+
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
17493
|
+
allow_exists?: string;
|
|
17494
|
+
/** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
|
|
17495
|
+
with_backing_units?: boolean;
|
|
17496
|
+
/** @description Create Channels from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
|
|
17497
|
+
from_backing_units?: boolean;
|
|
17498
|
+
/**
|
|
17499
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
17500
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
17501
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
17502
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
17503
|
+
* as in the JSON encoding.
|
|
17504
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
17505
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
17506
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
17507
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
17508
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
17509
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
17510
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
17511
|
+
* UUID and time literals must be quoted as string literals.
|
|
17512
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
17513
|
+
* Time literals use the same form as when serialized as JSON,
|
|
17514
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
17515
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
17516
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
17517
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
17518
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
17519
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
17520
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
17521
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
17522
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
17523
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
17524
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
17525
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
17526
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
17527
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
17528
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
17529
|
+
* Conjunctions are supported using the `AND` operator.
|
|
17530
|
+
* An example conjunction is:
|
|
17531
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17532
|
+
*
|
|
17533
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
17534
|
+
*
|
|
17535
|
+
* The Units to create entities from, with from_backing_units.
|
|
17536
|
+
*
|
|
17537
|
+
* The whole string must be query-encoded.
|
|
17538
|
+
*/
|
|
17539
|
+
where_unit?: string;
|
|
17540
|
+
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
17541
|
+
filter_unit?: string;
|
|
17542
|
+
/** @description With from_backing_units, patch a Channel a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Channel is returned as it is. */
|
|
17543
|
+
patch_existing?: boolean;
|
|
17544
|
+
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
17545
|
+
dry_run?: boolean;
|
|
17246
17546
|
};
|
|
17247
17547
|
header?: never;
|
|
17248
17548
|
path?: never;
|
|
17249
17549
|
cookie?: never;
|
|
17250
17550
|
};
|
|
17251
|
-
requestBody?:
|
|
17551
|
+
requestBody?: {
|
|
17552
|
+
content: {
|
|
17553
|
+
"application/merge-patch+json": {
|
|
17554
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
17555
|
+
Annotations?: {
|
|
17556
|
+
[key: string]: string | null;
|
|
17557
|
+
} | null;
|
|
17558
|
+
Commands?: {
|
|
17559
|
+
[key: string]: Record<string, never> | null;
|
|
17560
|
+
} | null;
|
|
17561
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
17562
|
+
DeleteGates?: {
|
|
17563
|
+
[key: string]: boolean | null;
|
|
17564
|
+
} | null;
|
|
17565
|
+
/** @description Friendly name for the entity. */
|
|
17566
|
+
DisplayName?: string | null;
|
|
17567
|
+
EventPosition?: number | null;
|
|
17568
|
+
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
17569
|
+
HiddenReason?: string | null;
|
|
17570
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
17571
|
+
Labels?: {
|
|
17572
|
+
[key: string]: string | null;
|
|
17573
|
+
} | null;
|
|
17574
|
+
Permissions?: {
|
|
17575
|
+
[key: string]: Record<string, never> | null;
|
|
17576
|
+
} | null;
|
|
17577
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
17578
|
+
Slug?: string | null;
|
|
17579
|
+
Subscriptions?: (Record<string, never> | null)[] | null;
|
|
17580
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
17581
|
+
Version?: number | null;
|
|
17582
|
+
};
|
|
17583
|
+
};
|
|
17584
|
+
};
|
|
17252
17585
|
responses: {
|
|
17253
17586
|
/** @description OK */
|
|
17254
17587
|
200: {
|
|
@@ -17258,16 +17591,218 @@ interface operations {
|
|
|
17258
17591
|
[name: string]: unknown;
|
|
17259
17592
|
};
|
|
17260
17593
|
content: {
|
|
17261
|
-
"application/json": components["schemas"]["
|
|
17594
|
+
"application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][];
|
|
17262
17595
|
};
|
|
17263
17596
|
};
|
|
17264
|
-
/** @description Multi-Status
|
|
17597
|
+
/** @description Multi-Status (partial success) */
|
|
17265
17598
|
207: {
|
|
17266
17599
|
headers: {
|
|
17267
17600
|
[name: string]: unknown;
|
|
17268
17601
|
};
|
|
17269
17602
|
content: {
|
|
17270
|
-
"application/json": components["schemas"]["
|
|
17603
|
+
"application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][];
|
|
17604
|
+
};
|
|
17605
|
+
};
|
|
17606
|
+
/** @description Channel request is invalid (Bad Request). */
|
|
17607
|
+
400: {
|
|
17608
|
+
headers: {
|
|
17609
|
+
[name: string]: unknown;
|
|
17610
|
+
};
|
|
17611
|
+
content: {
|
|
17612
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17613
|
+
};
|
|
17614
|
+
};
|
|
17615
|
+
/** @description Unauthorized access. */
|
|
17616
|
+
401: {
|
|
17617
|
+
headers: {
|
|
17618
|
+
[name: string]: unknown;
|
|
17619
|
+
};
|
|
17620
|
+
content: {
|
|
17621
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17622
|
+
};
|
|
17623
|
+
};
|
|
17624
|
+
/** @description Forbidden access. */
|
|
17625
|
+
403: {
|
|
17626
|
+
headers: {
|
|
17627
|
+
[name: string]: unknown;
|
|
17628
|
+
};
|
|
17629
|
+
content: {
|
|
17630
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17631
|
+
};
|
|
17632
|
+
};
|
|
17633
|
+
/** @description Channel not found. */
|
|
17634
|
+
404: {
|
|
17635
|
+
headers: {
|
|
17636
|
+
[name: string]: unknown;
|
|
17637
|
+
};
|
|
17638
|
+
content: {
|
|
17639
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17640
|
+
};
|
|
17641
|
+
};
|
|
17642
|
+
/** @description Channel data conflict. Data has changed since last read. */
|
|
17643
|
+
409: {
|
|
17644
|
+
headers: {
|
|
17645
|
+
[name: string]: unknown;
|
|
17646
|
+
};
|
|
17647
|
+
content: {
|
|
17648
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17649
|
+
};
|
|
17650
|
+
};
|
|
17651
|
+
/** @description A backing Unit has outstanding ValidationErrors */
|
|
17652
|
+
422: {
|
|
17653
|
+
headers: {
|
|
17654
|
+
[name: string]: unknown;
|
|
17655
|
+
};
|
|
17656
|
+
content: {
|
|
17657
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17658
|
+
};
|
|
17659
|
+
};
|
|
17660
|
+
/** @description Something went wrong while processing Channel. */
|
|
17661
|
+
500: {
|
|
17662
|
+
headers: {
|
|
17663
|
+
[name: string]: unknown;
|
|
17664
|
+
};
|
|
17665
|
+
content: {
|
|
17666
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17667
|
+
};
|
|
17668
|
+
};
|
|
17669
|
+
/** @description Unexpected error. */
|
|
17670
|
+
default: {
|
|
17671
|
+
headers: {
|
|
17672
|
+
[name: string]: unknown;
|
|
17673
|
+
};
|
|
17674
|
+
content: {
|
|
17675
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17676
|
+
};
|
|
17677
|
+
};
|
|
17678
|
+
};
|
|
17679
|
+
};
|
|
17680
|
+
BulkDeleteChannels: {
|
|
17681
|
+
parameters: {
|
|
17682
|
+
query?: {
|
|
17683
|
+
/**
|
|
17684
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
17685
|
+
* the list of Channels returned. The expression syntax was inspired by SQL.
|
|
17686
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
17687
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
17688
|
+
* as in the JSON encoding.
|
|
17689
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
17690
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
17691
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
17692
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
17693
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
17694
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
17695
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
17696
|
+
* UUID and time literals must be quoted as string literals.
|
|
17697
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
17698
|
+
* Time literals use the same form as when serialized as JSON,
|
|
17699
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
17700
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
17701
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
17702
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
17703
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
17704
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
17705
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
17706
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
17707
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
17708
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
17709
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
17710
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
17711
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
17712
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
17713
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
17714
|
+
* Conjunctions are supported using the `AND` operator.
|
|
17715
|
+
* An example conjunction is:
|
|
17716
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17717
|
+
*
|
|
17718
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
17719
|
+
*
|
|
17720
|
+
* The whole string must be query-encoded.
|
|
17721
|
+
*/
|
|
17722
|
+
where?: string;
|
|
17723
|
+
/**
|
|
17724
|
+
* @description UUID of a Filter entity to apply to the Channel list.
|
|
17725
|
+
*
|
|
17726
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
17727
|
+
*
|
|
17728
|
+
* The Filter's From field must match the entity type being filtered (Channel).
|
|
17729
|
+
*
|
|
17730
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
17731
|
+
*
|
|
17732
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
17733
|
+
*
|
|
17734
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
17735
|
+
*/
|
|
17736
|
+
filter?: string;
|
|
17737
|
+
/**
|
|
17738
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
17739
|
+
*
|
|
17740
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
17741
|
+
*
|
|
17742
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
17743
|
+
*
|
|
17744
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
17745
|
+
*
|
|
17746
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
17747
|
+
*
|
|
17748
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
17749
|
+
*
|
|
17750
|
+
* Searchable fields for Channel include string and map-type attributes from the queryable attributes list.
|
|
17751
|
+
*
|
|
17752
|
+
* The whole string must be query-encoded.
|
|
17753
|
+
*/
|
|
17754
|
+
contains?: string;
|
|
17755
|
+
/**
|
|
17756
|
+
* @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
17757
|
+
*
|
|
17758
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
17759
|
+
*
|
|
17760
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
17761
|
+
*
|
|
17762
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
17763
|
+
*/
|
|
17764
|
+
include_hidden?: string;
|
|
17765
|
+
/**
|
|
17766
|
+
* @description Include clause for expanding related entities in the response for Channel.
|
|
17767
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
17768
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
17769
|
+
*
|
|
17770
|
+
* Supported attributes for Channel are OrganizationID, SpaceID.
|
|
17771
|
+
*
|
|
17772
|
+
* The whole string must be query-encoded.
|
|
17773
|
+
*/
|
|
17774
|
+
include?: string;
|
|
17775
|
+
/** @description Maximum number of Channel entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
17776
|
+
limit?: number;
|
|
17777
|
+
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
17778
|
+
continue?: string;
|
|
17779
|
+
/** @description Prune: of the Channels selected, delete those whose backing Unit is empty, which says the Channel should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Channel's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */
|
|
17780
|
+
from_backing_units?: boolean;
|
|
17781
|
+
};
|
|
17782
|
+
header?: never;
|
|
17783
|
+
path?: never;
|
|
17784
|
+
cookie?: never;
|
|
17785
|
+
};
|
|
17786
|
+
requestBody?: never;
|
|
17787
|
+
responses: {
|
|
17788
|
+
/** @description OK */
|
|
17789
|
+
200: {
|
|
17790
|
+
headers: {
|
|
17791
|
+
/** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
|
|
17792
|
+
"ConfigHub-Continue"?: string;
|
|
17793
|
+
[name: string]: unknown;
|
|
17794
|
+
};
|
|
17795
|
+
content: {
|
|
17796
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
17797
|
+
};
|
|
17798
|
+
};
|
|
17799
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
17800
|
+
207: {
|
|
17801
|
+
headers: {
|
|
17802
|
+
[name: string]: unknown;
|
|
17803
|
+
};
|
|
17804
|
+
content: {
|
|
17805
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
17271
17806
|
};
|
|
17272
17807
|
};
|
|
17273
17808
|
/** @description Channel request is invalid (Bad Request). */
|
|
@@ -17382,7 +17917,7 @@ interface operations {
|
|
|
17382
17917
|
* An example conjunction is:
|
|
17383
17918
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17384
17919
|
*
|
|
17385
|
-
* Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
|
|
17920
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
17386
17921
|
*
|
|
17387
17922
|
* The whole string must be query-encoded.
|
|
17388
17923
|
*/
|
|
@@ -17443,6 +17978,10 @@ interface operations {
|
|
|
17443
17978
|
limit?: number;
|
|
17444
17979
|
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
17445
17980
|
continue?: string;
|
|
17981
|
+
/** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
|
|
17982
|
+
with_backing_units?: boolean;
|
|
17983
|
+
/** @description Patch each selected Channel with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */
|
|
17984
|
+
from_backing_units?: boolean;
|
|
17446
17985
|
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
17447
17986
|
dry_run?: boolean;
|
|
17448
17987
|
};
|
|
@@ -17550,6 +18089,206 @@ interface operations {
|
|
|
17550
18089
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17551
18090
|
};
|
|
17552
18091
|
};
|
|
18092
|
+
/** @description A backing Unit has outstanding ValidationErrors */
|
|
18093
|
+
422: {
|
|
18094
|
+
headers: {
|
|
18095
|
+
[name: string]: unknown;
|
|
18096
|
+
};
|
|
18097
|
+
content: {
|
|
18098
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18099
|
+
};
|
|
18100
|
+
};
|
|
18101
|
+
/** @description Something went wrong while processing Channel. */
|
|
18102
|
+
500: {
|
|
18103
|
+
headers: {
|
|
18104
|
+
[name: string]: unknown;
|
|
18105
|
+
};
|
|
18106
|
+
content: {
|
|
18107
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18108
|
+
};
|
|
18109
|
+
};
|
|
18110
|
+
/** @description Unexpected error. */
|
|
18111
|
+
default: {
|
|
18112
|
+
headers: {
|
|
18113
|
+
[name: string]: unknown;
|
|
18114
|
+
};
|
|
18115
|
+
content: {
|
|
18116
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18117
|
+
};
|
|
18118
|
+
};
|
|
18119
|
+
};
|
|
18120
|
+
};
|
|
18121
|
+
BulkMoveChannels: {
|
|
18122
|
+
parameters: {
|
|
18123
|
+
query?: {
|
|
18124
|
+
/**
|
|
18125
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
18126
|
+
* the list of Channels returned. The expression syntax was inspired by SQL.
|
|
18127
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
18128
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
18129
|
+
* as in the JSON encoding.
|
|
18130
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
18131
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
18132
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
18133
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
18134
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
18135
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
18136
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
18137
|
+
* UUID and time literals must be quoted as string literals.
|
|
18138
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
18139
|
+
* Time literals use the same form as when serialized as JSON,
|
|
18140
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
18141
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
18142
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
18143
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
18144
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
18145
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
18146
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
18147
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
18148
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
18149
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
18150
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
18151
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
18152
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
18153
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
18154
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
18155
|
+
* Conjunctions are supported using the `AND` operator.
|
|
18156
|
+
* An example conjunction is:
|
|
18157
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18158
|
+
*
|
|
18159
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
18160
|
+
*
|
|
18161
|
+
* The whole string must be query-encoded.
|
|
18162
|
+
*/
|
|
18163
|
+
where?: string;
|
|
18164
|
+
/**
|
|
18165
|
+
* @description UUID of a Filter entity to apply to the Channel list.
|
|
18166
|
+
*
|
|
18167
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
18168
|
+
*
|
|
18169
|
+
* The Filter's From field must match the entity type being filtered (Channel).
|
|
18170
|
+
*
|
|
18171
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
18172
|
+
*
|
|
18173
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
18174
|
+
*
|
|
18175
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
18176
|
+
*/
|
|
18177
|
+
filter?: string;
|
|
18178
|
+
/**
|
|
18179
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
18180
|
+
*
|
|
18181
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
18182
|
+
*
|
|
18183
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
18184
|
+
*
|
|
18185
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
18186
|
+
*
|
|
18187
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
18188
|
+
*
|
|
18189
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
18190
|
+
*
|
|
18191
|
+
* Searchable fields for Channel include string and map-type attributes from the queryable attributes list.
|
|
18192
|
+
*
|
|
18193
|
+
* The whole string must be query-encoded.
|
|
18194
|
+
*/
|
|
18195
|
+
contains?: string;
|
|
18196
|
+
/**
|
|
18197
|
+
* @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
18198
|
+
*
|
|
18199
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
18200
|
+
*
|
|
18201
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
18202
|
+
*
|
|
18203
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
18204
|
+
*/
|
|
18205
|
+
include_hidden?: string;
|
|
18206
|
+
/**
|
|
18207
|
+
* @description Include clause for expanding related entities in the response for Channel.
|
|
18208
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
18209
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
18210
|
+
*
|
|
18211
|
+
* Supported attributes for Channel are OrganizationID, SpaceID.
|
|
18212
|
+
*
|
|
18213
|
+
* The whole string must be query-encoded.
|
|
18214
|
+
*/
|
|
18215
|
+
include?: string;
|
|
18216
|
+
/** @description Report what the move would do, and what would stop it, without moving anything */
|
|
18217
|
+
dry_run?: boolean;
|
|
18218
|
+
};
|
|
18219
|
+
header?: never;
|
|
18220
|
+
path?: never;
|
|
18221
|
+
cookie?: never;
|
|
18222
|
+
};
|
|
18223
|
+
requestBody?: {
|
|
18224
|
+
content: {
|
|
18225
|
+
"application/json": components["schemas"]["MoveRequest"];
|
|
18226
|
+
};
|
|
18227
|
+
};
|
|
18228
|
+
responses: {
|
|
18229
|
+
/** @description OK */
|
|
18230
|
+
200: {
|
|
18231
|
+
headers: {
|
|
18232
|
+
[name: string]: unknown;
|
|
18233
|
+
};
|
|
18234
|
+
content: {
|
|
18235
|
+
"application/json": components["schemas"]["MoveResponse"][];
|
|
18236
|
+
};
|
|
18237
|
+
};
|
|
18238
|
+
/** @description Multi-Status: nothing was moved, or some moved and others did not */
|
|
18239
|
+
207: {
|
|
18240
|
+
headers: {
|
|
18241
|
+
[name: string]: unknown;
|
|
18242
|
+
};
|
|
18243
|
+
content: {
|
|
18244
|
+
"application/json": components["schemas"]["MoveResponse"][];
|
|
18245
|
+
};
|
|
18246
|
+
};
|
|
18247
|
+
/** @description Channel request is invalid (Bad Request). */
|
|
18248
|
+
400: {
|
|
18249
|
+
headers: {
|
|
18250
|
+
[name: string]: unknown;
|
|
18251
|
+
};
|
|
18252
|
+
content: {
|
|
18253
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18254
|
+
};
|
|
18255
|
+
};
|
|
18256
|
+
/** @description Unauthorized access. */
|
|
18257
|
+
401: {
|
|
18258
|
+
headers: {
|
|
18259
|
+
[name: string]: unknown;
|
|
18260
|
+
};
|
|
18261
|
+
content: {
|
|
18262
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18263
|
+
};
|
|
18264
|
+
};
|
|
18265
|
+
/** @description Forbidden access. */
|
|
18266
|
+
403: {
|
|
18267
|
+
headers: {
|
|
18268
|
+
[name: string]: unknown;
|
|
18269
|
+
};
|
|
18270
|
+
content: {
|
|
18271
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18272
|
+
};
|
|
18273
|
+
};
|
|
18274
|
+
/** @description Channel not found. */
|
|
18275
|
+
404: {
|
|
18276
|
+
headers: {
|
|
18277
|
+
[name: string]: unknown;
|
|
18278
|
+
};
|
|
18279
|
+
content: {
|
|
18280
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18281
|
+
};
|
|
18282
|
+
};
|
|
18283
|
+
/** @description Channel data conflict. Data has changed since last read. */
|
|
18284
|
+
409: {
|
|
18285
|
+
headers: {
|
|
18286
|
+
[name: string]: unknown;
|
|
18287
|
+
};
|
|
18288
|
+
content: {
|
|
18289
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
18290
|
+
};
|
|
18291
|
+
};
|
|
17553
18292
|
/** @description Something went wrong while processing Channel. */
|
|
17554
18293
|
500: {
|
|
17555
18294
|
headers: {
|
|
@@ -17738,7 +18477,7 @@ interface operations {
|
|
|
17738
18477
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
17739
18478
|
* If not specified, all fields are returned.
|
|
17740
18479
|
* Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
|
|
17741
|
-
* Fields used in where and contains filters,
|
|
18480
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
17742
18481
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
17743
18482
|
* The whole string must be query-encoded.
|
|
17744
18483
|
*/
|
|
@@ -17750,7 +18489,7 @@ interface operations {
|
|
|
17750
18489
|
*
|
|
17751
18490
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
17752
18491
|
*
|
|
17753
|
-
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID,
|
|
18492
|
+
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status, TargetID, TimeoutAt, UnitID.
|
|
17754
18493
|
*
|
|
17755
18494
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
17756
18495
|
*
|
|
@@ -17932,7 +18671,7 @@ interface operations {
|
|
|
17932
18671
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
17933
18672
|
* If not specified, all fields are returned.
|
|
17934
18673
|
* Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter.
|
|
17935
|
-
* Fields used in where and contains filters,
|
|
18674
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
17936
18675
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
17937
18676
|
* The whole string must be query-encoded.
|
|
17938
18677
|
*/
|
|
@@ -17947,6 +18686,16 @@ interface operations {
|
|
|
17947
18686
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
17948
18687
|
*/
|
|
17949
18688
|
include_hidden?: string;
|
|
18689
|
+
/**
|
|
18690
|
+
* @description UUID of a View whose columns to compute for each Component, returned as ViewColumns.
|
|
18691
|
+
*
|
|
18692
|
+
* The View must be in the same Organization as the user credentials, and be a View of Component: its Of, or the From of its Filter, must be Component.
|
|
18693
|
+
*
|
|
18694
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
18695
|
+
*
|
|
18696
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
18697
|
+
*/
|
|
18698
|
+
view?: string;
|
|
17950
18699
|
/** @description Maximum number of Component entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
17951
18700
|
limit?: number;
|
|
17952
18701
|
/**
|
|
@@ -18160,7 +18909,7 @@ interface operations {
|
|
|
18160
18909
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
18161
18910
|
* If not specified, all fields are returned.
|
|
18162
18911
|
* Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter.
|
|
18163
|
-
* Fields used in where and contains filters,
|
|
18912
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
18164
18913
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
18165
18914
|
* The whole string must be query-encoded.
|
|
18166
18915
|
*/
|
|
@@ -19018,7 +19767,7 @@ interface operations {
|
|
|
19018
19767
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
19019
19768
|
* If not specified, all fields are returned.
|
|
19020
19769
|
* Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
|
|
19021
|
-
* Fields used in where and contains filters,
|
|
19770
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
19022
19771
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
19023
19772
|
* The whole string must be query-encoded.
|
|
19024
19773
|
*/
|
|
@@ -19033,6 +19782,16 @@ interface operations {
|
|
|
19033
19782
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
19034
19783
|
*/
|
|
19035
19784
|
include_hidden?: string;
|
|
19785
|
+
/**
|
|
19786
|
+
* @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns.
|
|
19787
|
+
*
|
|
19788
|
+
* The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter.
|
|
19789
|
+
*
|
|
19790
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
19791
|
+
*
|
|
19792
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
19793
|
+
*/
|
|
19794
|
+
view?: string;
|
|
19036
19795
|
/** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
19037
19796
|
limit?: number;
|
|
19038
19797
|
/**
|
|
@@ -20346,7 +21105,7 @@ interface operations {
|
|
|
20346
21105
|
trigger_filter?: string;
|
|
20347
21106
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
20348
21107
|
triggers_passed?: boolean;
|
|
20349
|
-
/** @description
|
|
21108
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
20350
21109
|
view?: string;
|
|
20351
21110
|
};
|
|
20352
21111
|
header?: never;
|
|
@@ -20559,7 +21318,7 @@ interface operations {
|
|
|
20559
21318
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
20560
21319
|
* If not specified, all fields are returned.
|
|
20561
21320
|
* Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
|
|
20562
|
-
* Fields used in where and contains filters,
|
|
21321
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
20563
21322
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
20564
21323
|
* The whole string must be query-encoded.
|
|
20565
21324
|
*/
|
|
@@ -20574,6 +21333,16 @@ interface operations {
|
|
|
20574
21333
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
20575
21334
|
*/
|
|
20576
21335
|
include_hidden?: string;
|
|
21336
|
+
/**
|
|
21337
|
+
* @description UUID of a View whose columns to compute for each Group, returned as ViewColumns.
|
|
21338
|
+
*
|
|
21339
|
+
* The View must be in the same Organization as the user credentials, and be a View of Group: its Of, or the From of its Filter, must be Group.
|
|
21340
|
+
*
|
|
21341
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
21342
|
+
*
|
|
21343
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
21344
|
+
*/
|
|
21345
|
+
view?: string;
|
|
20577
21346
|
/** @description Maximum number of Group entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
20578
21347
|
limit?: number;
|
|
20579
21348
|
/**
|
|
@@ -20681,7 +21450,7 @@ interface operations {
|
|
|
20681
21450
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
20682
21451
|
* If not specified, all fields are returned.
|
|
20683
21452
|
* Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
|
|
20684
|
-
* Fields used in where and contains filters,
|
|
21453
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
20685
21454
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
20686
21455
|
* The whole string must be query-encoded.
|
|
20687
21456
|
*/
|
|
@@ -21059,7 +21828,7 @@ interface operations {
|
|
|
21059
21828
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
21060
21829
|
* If not specified, all fields are returned.
|
|
21061
21830
|
* Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
|
|
21062
|
-
* Fields used in where and contains filters,
|
|
21831
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
21063
21832
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
21064
21833
|
* The whole string must be query-encoded.
|
|
21065
21834
|
*/
|
|
@@ -21074,6 +21843,16 @@ interface operations {
|
|
|
21074
21843
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
21075
21844
|
*/
|
|
21076
21845
|
include_hidden?: string;
|
|
21846
|
+
/**
|
|
21847
|
+
* @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns.
|
|
21848
|
+
*
|
|
21849
|
+
* The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation.
|
|
21850
|
+
*
|
|
21851
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
21852
|
+
*
|
|
21853
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
21854
|
+
*/
|
|
21855
|
+
view?: string;
|
|
21077
21856
|
/** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
21078
21857
|
limit?: number;
|
|
21079
21858
|
/**
|
|
@@ -22250,7 +23029,7 @@ interface operations {
|
|
|
22250
23029
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
22251
23030
|
* If not specified, all fields are returned.
|
|
22252
23031
|
* Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
|
|
22253
|
-
* Fields used in where and contains filters,
|
|
23032
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
22254
23033
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
22255
23034
|
* The whole string must be query-encoded.
|
|
22256
23035
|
*/
|
|
@@ -22265,6 +23044,16 @@ interface operations {
|
|
|
22265
23044
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
22266
23045
|
*/
|
|
22267
23046
|
include_hidden?: string;
|
|
23047
|
+
/**
|
|
23048
|
+
* @description UUID of a View whose columns to compute for each Link, returned as ViewColumns.
|
|
23049
|
+
*
|
|
23050
|
+
* The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link.
|
|
23051
|
+
*
|
|
23052
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
23053
|
+
*
|
|
23054
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
23055
|
+
*/
|
|
23056
|
+
view?: string;
|
|
22268
23057
|
/** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
22269
23058
|
limit?: number;
|
|
22270
23059
|
/**
|
|
@@ -23772,7 +24561,7 @@ interface operations {
|
|
|
23772
24561
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
23773
24562
|
* If not specified, all fields are returned.
|
|
23774
24563
|
* Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.
|
|
23775
|
-
* Fields used in where and contains filters,
|
|
24564
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
23776
24565
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
23777
24566
|
* The whole string must be query-encoded.
|
|
23778
24567
|
*/
|
|
@@ -23787,6 +24576,16 @@ interface operations {
|
|
|
23787
24576
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
23788
24577
|
*/
|
|
23789
24578
|
include_hidden?: string;
|
|
24579
|
+
/**
|
|
24580
|
+
* @description UUID of a View whose columns to compute for each Organization, returned as ViewColumns.
|
|
24581
|
+
*
|
|
24582
|
+
* The View must be in the same Organization as the user credentials, and be a View of Organization: its Of, or the From of its Filter, must be Organization.
|
|
24583
|
+
*
|
|
24584
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
24585
|
+
*
|
|
24586
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
24587
|
+
*/
|
|
24588
|
+
view?: string;
|
|
23790
24589
|
};
|
|
23791
24590
|
header?: never;
|
|
23792
24591
|
path?: never;
|
|
@@ -23968,7 +24767,7 @@ interface operations {
|
|
|
23968
24767
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
23969
24768
|
* If not specified, all fields are returned.
|
|
23970
24769
|
* Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter.
|
|
23971
|
-
* Fields used in where and contains filters,
|
|
24770
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
23972
24771
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
23973
24772
|
* The whole string must be query-encoded.
|
|
23974
24773
|
*/
|
|
@@ -24311,6 +25110,16 @@ interface operations {
|
|
|
24311
25110
|
* The whole string must be query-encoded.
|
|
24312
25111
|
*/
|
|
24313
25112
|
contains?: string;
|
|
25113
|
+
/**
|
|
25114
|
+
* @description UUID of a View whose columns to compute for each OrganizationMember, returned as ViewColumns.
|
|
25115
|
+
*
|
|
25116
|
+
* The View must be in the same Organization as the user credentials, and be a View of OrganizationMember: its Of, or the From of its Filter, must be OrganizationMember.
|
|
25117
|
+
*
|
|
25118
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
25119
|
+
*
|
|
25120
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
25121
|
+
*/
|
|
25122
|
+
view?: string;
|
|
24314
25123
|
};
|
|
24315
25124
|
header?: never;
|
|
24316
25125
|
path: {
|
|
@@ -24860,7 +25669,7 @@ interface operations {
|
|
|
24860
25669
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
24861
25670
|
* If not specified, all fields are returned.
|
|
24862
25671
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
|
|
24863
|
-
* Fields used in where and contains filters,
|
|
25672
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
24864
25673
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
24865
25674
|
* The whole string must be query-encoded.
|
|
24866
25675
|
*/
|
|
@@ -24875,6 +25684,16 @@ interface operations {
|
|
|
24875
25684
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
24876
25685
|
*/
|
|
24877
25686
|
include_hidden?: string;
|
|
25687
|
+
/**
|
|
25688
|
+
* @description UUID of a View whose columns to compute for each Release, returned as ViewColumns.
|
|
25689
|
+
*
|
|
25690
|
+
* The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release.
|
|
25691
|
+
*
|
|
25692
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
25693
|
+
*
|
|
25694
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
25695
|
+
*/
|
|
25696
|
+
view?: string;
|
|
24878
25697
|
/** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
24879
25698
|
limit?: number;
|
|
24880
25699
|
/**
|
|
@@ -25076,7 +25895,7 @@ interface operations {
|
|
|
25076
25895
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
25077
25896
|
* If not specified, all fields are returned.
|
|
25078
25897
|
* Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
|
|
25079
|
-
* Fields used in where and contains filters,
|
|
25898
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
25080
25899
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
25081
25900
|
* The whole string must be query-encoded.
|
|
25082
25901
|
*/
|
|
@@ -25091,6 +25910,16 @@ interface operations {
|
|
|
25091
25910
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
25092
25911
|
*/
|
|
25093
25912
|
include_hidden?: string;
|
|
25913
|
+
/**
|
|
25914
|
+
* @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns.
|
|
25915
|
+
*
|
|
25916
|
+
* The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource.
|
|
25917
|
+
*
|
|
25918
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
25919
|
+
*
|
|
25920
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
25921
|
+
*/
|
|
25922
|
+
view?: string;
|
|
25094
25923
|
/** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
25095
25924
|
limit?: number;
|
|
25096
25925
|
/**
|
|
@@ -25120,8 +25949,6 @@ interface operations {
|
|
|
25120
25949
|
* @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue.
|
|
25121
25950
|
*/
|
|
25122
25951
|
offset?: number;
|
|
25123
|
-
/** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
|
|
25124
|
-
view?: string;
|
|
25125
25952
|
/** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
|
|
25126
25953
|
raw_data?: boolean;
|
|
25127
25954
|
};
|
|
@@ -25289,7 +26116,7 @@ interface operations {
|
|
|
25289
26116
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
25290
26117
|
* If not specified, all fields are returned.
|
|
25291
26118
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
|
|
25292
|
-
* Fields used in where and contains filters,
|
|
26119
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
25293
26120
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
25294
26121
|
* The whole string must be query-encoded.
|
|
25295
26122
|
*/
|
|
@@ -25304,6 +26131,16 @@ interface operations {
|
|
|
25304
26131
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
25305
26132
|
*/
|
|
25306
26133
|
include_hidden?: string;
|
|
26134
|
+
/**
|
|
26135
|
+
* @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns.
|
|
26136
|
+
*
|
|
26137
|
+
* The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment.
|
|
26138
|
+
*
|
|
26139
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
26140
|
+
*
|
|
26141
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
26142
|
+
*/
|
|
26143
|
+
view?: string;
|
|
25307
26144
|
/** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
25308
26145
|
limit?: number;
|
|
25309
26146
|
/**
|
|
@@ -25907,7 +26744,7 @@ interface operations {
|
|
|
25907
26744
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
25908
26745
|
* If not specified, all fields are returned.
|
|
25909
26746
|
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
25910
|
-
* Fields used in where and contains filters,
|
|
26747
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
25911
26748
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
25912
26749
|
* The whole string must be query-encoded.
|
|
25913
26750
|
*/
|
|
@@ -25922,6 +26759,16 @@ interface operations {
|
|
|
25922
26759
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
25923
26760
|
*/
|
|
25924
26761
|
include_hidden?: string;
|
|
26762
|
+
/**
|
|
26763
|
+
* @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns.
|
|
26764
|
+
*
|
|
26765
|
+
* The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision.
|
|
26766
|
+
*
|
|
26767
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
26768
|
+
*
|
|
26769
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
26770
|
+
*/
|
|
26771
|
+
view?: string;
|
|
25925
26772
|
/** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
25926
26773
|
limit?: number;
|
|
25927
26774
|
/**
|
|
@@ -26128,7 +26975,7 @@ interface operations {
|
|
|
26128
26975
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
26129
26976
|
* If not specified, all fields are returned.
|
|
26130
26977
|
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
26131
|
-
* Fields used in where and contains filters,
|
|
26978
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
26132
26979
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
26133
26980
|
* The whole string must be query-encoded.
|
|
26134
26981
|
*/
|
|
@@ -26349,7 +27196,7 @@ interface operations {
|
|
|
26349
27196
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
26350
27197
|
* If not specified, all fields are returned.
|
|
26351
27198
|
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
26352
|
-
* Fields used in where and contains filters,
|
|
27199
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
26353
27200
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
26354
27201
|
* The whole string must be query-encoded.
|
|
26355
27202
|
*/
|
|
@@ -26568,7 +27415,7 @@ interface operations {
|
|
|
26568
27415
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
26569
27416
|
* If not specified, all fields are returned.
|
|
26570
27417
|
* Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
|
|
26571
|
-
* Fields used in where and contains filters,
|
|
27418
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
26572
27419
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
26573
27420
|
* The whole string must be query-encoded.
|
|
26574
27421
|
*/
|
|
@@ -26583,6 +27430,16 @@ interface operations {
|
|
|
26583
27430
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
26584
27431
|
*/
|
|
26585
27432
|
include_hidden?: string;
|
|
27433
|
+
/**
|
|
27434
|
+
* @description UUID of a View whose columns to compute for each ServiceAccount, returned as ViewColumns.
|
|
27435
|
+
*
|
|
27436
|
+
* The View must be in the same Organization as the user credentials, and be a View of ServiceAccount: its Of, or the From of its Filter, must be ServiceAccount.
|
|
27437
|
+
*
|
|
27438
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
27439
|
+
*
|
|
27440
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
27441
|
+
*/
|
|
27442
|
+
view?: string;
|
|
26586
27443
|
/** @description Maximum number of ServiceAccount entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
26587
27444
|
limit?: number;
|
|
26588
27445
|
/**
|
|
@@ -26792,7 +27649,7 @@ interface operations {
|
|
|
26792
27649
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
26793
27650
|
* If not specified, all fields are returned.
|
|
26794
27651
|
* Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
|
|
26795
|
-
* Fields used in where and contains filters,
|
|
27652
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
26796
27653
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
26797
27654
|
* The whole string must be query-encoded.
|
|
26798
27655
|
*/
|
|
@@ -27803,7 +28660,7 @@ interface operations {
|
|
|
27803
28660
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
27804
28661
|
* If not specified, all fields are returned.
|
|
27805
28662
|
* Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter.
|
|
27806
|
-
* Fields used in where and contains filters,
|
|
28663
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
27807
28664
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
27808
28665
|
* The whole string must be query-encoded.
|
|
27809
28666
|
*/
|
|
@@ -27818,6 +28675,16 @@ interface operations {
|
|
|
27818
28675
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
27819
28676
|
*/
|
|
27820
28677
|
include_hidden?: string;
|
|
28678
|
+
/**
|
|
28679
|
+
* @description UUID of a View whose columns to compute for each Space, returned as ViewColumns.
|
|
28680
|
+
*
|
|
28681
|
+
* The View must be in the same Organization as the user credentials, and be a View of Space: its Of, or the From of its Filter, must be Space.
|
|
28682
|
+
*
|
|
28683
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
28684
|
+
*
|
|
28685
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
28686
|
+
*/
|
|
28687
|
+
view?: string;
|
|
27821
28688
|
/** @description Maximum number of Space entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
27822
28689
|
limit?: number;
|
|
27823
28690
|
/**
|
|
@@ -28033,7 +28900,7 @@ interface operations {
|
|
|
28033
28900
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28034
28901
|
* If not specified, all fields are returned.
|
|
28035
28902
|
* Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter.
|
|
28036
|
-
* Fields used in where and contains filters,
|
|
28903
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28037
28904
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28038
28905
|
* The whole string must be query-encoded.
|
|
28039
28906
|
*/
|
|
@@ -28532,7 +29399,7 @@ interface operations {
|
|
|
28532
29399
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28533
29400
|
* If not specified, all fields are returned.
|
|
28534
29401
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
28535
|
-
* Fields used in where and contains filters,
|
|
29402
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28536
29403
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28537
29404
|
* The whole string must be query-encoded.
|
|
28538
29405
|
*/
|
|
@@ -28547,6 +29414,16 @@ interface operations {
|
|
|
28547
29414
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
28548
29415
|
*/
|
|
28549
29416
|
include_hidden?: string;
|
|
29417
|
+
/**
|
|
29418
|
+
* @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns.
|
|
29419
|
+
*
|
|
29420
|
+
* The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation.
|
|
29421
|
+
*
|
|
29422
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
29423
|
+
*
|
|
29424
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
29425
|
+
*/
|
|
29426
|
+
view?: string;
|
|
28550
29427
|
/** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
28551
29428
|
limit?: number;
|
|
28552
29429
|
/**
|
|
@@ -28760,7 +29637,7 @@ interface operations {
|
|
|
28760
29637
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28761
29638
|
* If not specified, all fields are returned.
|
|
28762
29639
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
28763
|
-
* Fields used in where and contains filters,
|
|
29640
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28764
29641
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28765
29642
|
* The whole string must be query-encoded.
|
|
28766
29643
|
*/
|
|
@@ -28933,7 +29810,7 @@ interface operations {
|
|
|
28933
29810
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28934
29811
|
* If not specified, all fields are returned.
|
|
28935
29812
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
|
|
28936
|
-
* Fields used in where and contains filters,
|
|
29813
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28937
29814
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28938
29815
|
* The whole string must be query-encoded.
|
|
28939
29816
|
*/
|
|
@@ -28948,6 +29825,16 @@ interface operations {
|
|
|
28948
29825
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
28949
29826
|
*/
|
|
28950
29827
|
include_hidden?: string;
|
|
29828
|
+
/**
|
|
29829
|
+
* @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns.
|
|
29830
|
+
*
|
|
29831
|
+
* The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute.
|
|
29832
|
+
*
|
|
29833
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
29834
|
+
*
|
|
29835
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
29836
|
+
*/
|
|
29837
|
+
view?: string;
|
|
28951
29838
|
/** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
28952
29839
|
limit?: number;
|
|
28953
29840
|
/**
|
|
@@ -29170,7 +30057,7 @@ interface operations {
|
|
|
29170
30057
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
29171
30058
|
* If not specified, all fields are returned.
|
|
29172
30059
|
* Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
|
|
29173
|
-
* Fields used in where and contains filters,
|
|
30060
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
29174
30061
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
29175
30062
|
* The whole string must be query-encoded.
|
|
29176
30063
|
*/
|
|
@@ -29848,7 +30735,7 @@ interface operations {
|
|
|
29848
30735
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
29849
30736
|
* If not specified, all fields are returned.
|
|
29850
30737
|
* Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
|
|
29851
|
-
* Fields used in where and contains filters,
|
|
30738
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
29852
30739
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
29853
30740
|
* The whole string must be query-encoded.
|
|
29854
30741
|
*/
|
|
@@ -29863,6 +30750,16 @@ interface operations {
|
|
|
29863
30750
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
29864
30751
|
*/
|
|
29865
30752
|
include_hidden?: string;
|
|
30753
|
+
/**
|
|
30754
|
+
* @description UUID of a View whose columns to compute for each BridgeWorker, returned as ViewColumns.
|
|
30755
|
+
*
|
|
30756
|
+
* The View must be in the same Organization as the user credentials, and be a View of BridgeWorker: its Of, or the From of its Filter, must be BridgeWorker.
|
|
30757
|
+
*
|
|
30758
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
30759
|
+
*
|
|
30760
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
30761
|
+
*/
|
|
30762
|
+
view?: string;
|
|
29866
30763
|
/** @description Maximum number of BridgeWorker entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
29867
30764
|
limit?: number;
|
|
29868
30765
|
/**
|
|
@@ -30087,7 +30984,7 @@ interface operations {
|
|
|
30087
30984
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
30088
30985
|
* If not specified, all fields are returned.
|
|
30089
30986
|
* Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
|
|
30090
|
-
* Fields used in where and contains filters,
|
|
30987
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
30091
30988
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
30092
30989
|
* The whole string must be query-encoded.
|
|
30093
30990
|
*/
|
|
@@ -30783,7 +31680,7 @@ interface operations {
|
|
|
30783
31680
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
30784
31681
|
* If not specified, all fields are returned.
|
|
30785
31682
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
|
|
30786
|
-
* Fields used in where and contains filters,
|
|
31683
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
30787
31684
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
30788
31685
|
* The whole string must be query-encoded.
|
|
30789
31686
|
*/
|
|
@@ -30798,6 +31695,16 @@ interface operations {
|
|
|
30798
31695
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
30799
31696
|
*/
|
|
30800
31697
|
include_hidden?: string;
|
|
31698
|
+
/**
|
|
31699
|
+
* @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns.
|
|
31700
|
+
*
|
|
31701
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder.
|
|
31702
|
+
*
|
|
31703
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
31704
|
+
*
|
|
31705
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
31706
|
+
*/
|
|
31707
|
+
view?: string;
|
|
30801
31708
|
/** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
30802
31709
|
limit?: number;
|
|
30803
31710
|
/**
|
|
@@ -31013,7 +31920,7 @@ interface operations {
|
|
|
31013
31920
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
31014
31921
|
* If not specified, all fields are returned.
|
|
31015
31922
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter.
|
|
31016
|
-
* Fields used in where and contains filters,
|
|
31923
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
31017
31924
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
31018
31925
|
* The whole string must be query-encoded.
|
|
31019
31926
|
*/
|
|
@@ -31526,7 +32433,7 @@ interface operations {
|
|
|
31526
32433
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
31527
32434
|
* If not specified, all fields are returned.
|
|
31528
32435
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
|
|
31529
|
-
* Fields used in where and contains filters,
|
|
32436
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
31530
32437
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
31531
32438
|
* The whole string must be query-encoded.
|
|
31532
32439
|
*/
|
|
@@ -31541,6 +32448,16 @@ interface operations {
|
|
|
31541
32448
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
31542
32449
|
*/
|
|
31543
32450
|
include_hidden?: string;
|
|
32451
|
+
/**
|
|
32452
|
+
* @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns.
|
|
32453
|
+
*
|
|
32454
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet.
|
|
32455
|
+
*
|
|
32456
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
32457
|
+
*
|
|
32458
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
32459
|
+
*/
|
|
32460
|
+
view?: string;
|
|
31544
32461
|
/** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
31545
32462
|
limit?: number;
|
|
31546
32463
|
/**
|
|
@@ -31756,7 +32673,7 @@ interface operations {
|
|
|
31756
32673
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
31757
32674
|
* If not specified, all fields are returned.
|
|
31758
32675
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter.
|
|
31759
|
-
* Fields used in where and contains filters,
|
|
32676
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
31760
32677
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
31761
32678
|
* The whole string must be query-encoded.
|
|
31762
32679
|
*/
|
|
@@ -32244,7 +33161,7 @@ interface operations {
|
|
|
32244
33161
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
32245
33162
|
* If not specified, all fields are returned.
|
|
32246
33163
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
|
|
32247
|
-
* Fields used in where and contains filters,
|
|
33164
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
32248
33165
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
32249
33166
|
* The whole string must be query-encoded.
|
|
32250
33167
|
*/
|
|
@@ -32259,6 +33176,16 @@ interface operations {
|
|
|
32259
33176
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
32260
33177
|
*/
|
|
32261
33178
|
include_hidden?: string;
|
|
33179
|
+
/**
|
|
33180
|
+
* @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns.
|
|
33181
|
+
*
|
|
33182
|
+
* The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow.
|
|
33183
|
+
*
|
|
33184
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
33185
|
+
*
|
|
33186
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
33187
|
+
*/
|
|
33188
|
+
view?: string;
|
|
32262
33189
|
/** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
32263
33190
|
limit?: number;
|
|
32264
33191
|
/**
|
|
@@ -32476,7 +33403,7 @@ interface operations {
|
|
|
32476
33403
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
32477
33404
|
* If not specified, all fields are returned.
|
|
32478
33405
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter.
|
|
32479
|
-
* Fields used in where and contains filters,
|
|
33406
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
32480
33407
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
32481
33408
|
* The whole string must be query-encoded.
|
|
32482
33409
|
*/
|
|
@@ -33089,7 +34016,7 @@ interface operations {
|
|
|
33089
34016
|
* An example conjunction is:
|
|
33090
34017
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
33091
34018
|
*
|
|
33092
|
-
* Supported attributes for filtering on Channel: Annotations, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt.
|
|
34019
|
+
* Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID.
|
|
33093
34020
|
*
|
|
33094
34021
|
* The whole string must be query-encoded.
|
|
33095
34022
|
*/
|
|
@@ -33142,7 +34069,7 @@ interface operations {
|
|
|
33142
34069
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
33143
34070
|
* If not specified, all fields are returned.
|
|
33144
34071
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
|
|
33145
|
-
* Fields used in where and contains filters,
|
|
34072
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
33146
34073
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
33147
34074
|
* The whole string must be query-encoded.
|
|
33148
34075
|
*/
|
|
@@ -33157,6 +34084,16 @@ interface operations {
|
|
|
33157
34084
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
33158
34085
|
*/
|
|
33159
34086
|
include_hidden?: string;
|
|
34087
|
+
/**
|
|
34088
|
+
* @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns.
|
|
34089
|
+
*
|
|
34090
|
+
* The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel.
|
|
34091
|
+
*
|
|
34092
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
34093
|
+
*
|
|
34094
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
34095
|
+
*/
|
|
34096
|
+
view?: string;
|
|
33160
34097
|
/** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
33161
34098
|
limit?: number;
|
|
33162
34099
|
/**
|
|
@@ -33164,7 +34101,7 @@ interface operations {
|
|
|
33164
34101
|
*
|
|
33165
34102
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
33166
34103
|
*
|
|
33167
|
-
* Supported attributes for ordering Channel: ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt.
|
|
34104
|
+
* Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID.
|
|
33168
34105
|
*
|
|
33169
34106
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
33170
34107
|
*
|
|
@@ -33261,6 +34198,8 @@ interface operations {
|
|
|
33261
34198
|
CreateChannel: {
|
|
33262
34199
|
parameters: {
|
|
33263
34200
|
query?: {
|
|
34201
|
+
/** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */
|
|
34202
|
+
with_backing_units?: boolean;
|
|
33264
34203
|
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
33265
34204
|
allow_exists?: string;
|
|
33266
34205
|
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
@@ -33372,7 +34311,7 @@ interface operations {
|
|
|
33372
34311
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
33373
34312
|
* If not specified, all fields are returned.
|
|
33374
34313
|
* Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter.
|
|
33375
|
-
* Fields used in where and contains filters,
|
|
34314
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
33376
34315
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
33377
34316
|
* The whole string must be query-encoded.
|
|
33378
34317
|
*/
|
|
@@ -33454,7 +34393,199 @@ interface operations {
|
|
|
33454
34393
|
};
|
|
33455
34394
|
};
|
|
33456
34395
|
};
|
|
33457
|
-
UpdateChannel: {
|
|
34396
|
+
UpdateChannel: {
|
|
34397
|
+
parameters: {
|
|
34398
|
+
query?: {
|
|
34399
|
+
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
34400
|
+
dry_run?: boolean;
|
|
34401
|
+
};
|
|
34402
|
+
header?: never;
|
|
34403
|
+
path: {
|
|
34404
|
+
/** @description Unique identifier for a space_id */
|
|
34405
|
+
space_id: string;
|
|
34406
|
+
/** @description Unique identifier for a channel_id */
|
|
34407
|
+
channel_id: string;
|
|
34408
|
+
};
|
|
34409
|
+
cookie?: never;
|
|
34410
|
+
};
|
|
34411
|
+
requestBody?: {
|
|
34412
|
+
content: {
|
|
34413
|
+
"application/json": components["schemas"]["Channel"];
|
|
34414
|
+
};
|
|
34415
|
+
};
|
|
34416
|
+
responses: {
|
|
34417
|
+
/** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
|
|
34418
|
+
200: {
|
|
34419
|
+
headers: {
|
|
34420
|
+
[name: string]: unknown;
|
|
34421
|
+
};
|
|
34422
|
+
content: {
|
|
34423
|
+
"application/json": components["schemas"]["Channel"];
|
|
34424
|
+
};
|
|
34425
|
+
};
|
|
34426
|
+
/** @description Channel request is invalid (Bad Request). */
|
|
34427
|
+
400: {
|
|
34428
|
+
headers: {
|
|
34429
|
+
[name: string]: unknown;
|
|
34430
|
+
};
|
|
34431
|
+
content: {
|
|
34432
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34433
|
+
};
|
|
34434
|
+
};
|
|
34435
|
+
/** @description Unauthorized access. */
|
|
34436
|
+
401: {
|
|
34437
|
+
headers: {
|
|
34438
|
+
[name: string]: unknown;
|
|
34439
|
+
};
|
|
34440
|
+
content: {
|
|
34441
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34442
|
+
};
|
|
34443
|
+
};
|
|
34444
|
+
/** @description Forbidden access. */
|
|
34445
|
+
403: {
|
|
34446
|
+
headers: {
|
|
34447
|
+
[name: string]: unknown;
|
|
34448
|
+
};
|
|
34449
|
+
content: {
|
|
34450
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34451
|
+
};
|
|
34452
|
+
};
|
|
34453
|
+
/** @description Channel not found. */
|
|
34454
|
+
404: {
|
|
34455
|
+
headers: {
|
|
34456
|
+
[name: string]: unknown;
|
|
34457
|
+
};
|
|
34458
|
+
content: {
|
|
34459
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34460
|
+
};
|
|
34461
|
+
};
|
|
34462
|
+
/** @description Channel data conflict. Data has changed since last read. */
|
|
34463
|
+
409: {
|
|
34464
|
+
headers: {
|
|
34465
|
+
[name: string]: unknown;
|
|
34466
|
+
};
|
|
34467
|
+
content: {
|
|
34468
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34469
|
+
};
|
|
34470
|
+
};
|
|
34471
|
+
/** @description Something went wrong while processing Channel. */
|
|
34472
|
+
500: {
|
|
34473
|
+
headers: {
|
|
34474
|
+
[name: string]: unknown;
|
|
34475
|
+
};
|
|
34476
|
+
content: {
|
|
34477
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34478
|
+
};
|
|
34479
|
+
};
|
|
34480
|
+
/** @description Unexpected error. */
|
|
34481
|
+
default: {
|
|
34482
|
+
headers: {
|
|
34483
|
+
[name: string]: unknown;
|
|
34484
|
+
};
|
|
34485
|
+
content: {
|
|
34486
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34487
|
+
};
|
|
34488
|
+
};
|
|
34489
|
+
};
|
|
34490
|
+
};
|
|
34491
|
+
DeleteChannel: {
|
|
34492
|
+
parameters: {
|
|
34493
|
+
query?: never;
|
|
34494
|
+
header?: never;
|
|
34495
|
+
path: {
|
|
34496
|
+
/** @description Unique identifier for a space_id */
|
|
34497
|
+
space_id: string;
|
|
34498
|
+
/** @description Unique identifier for a channel_id */
|
|
34499
|
+
channel_id: string;
|
|
34500
|
+
};
|
|
34501
|
+
cookie?: never;
|
|
34502
|
+
};
|
|
34503
|
+
requestBody?: never;
|
|
34504
|
+
responses: {
|
|
34505
|
+
/** @description Response for successful delete operation */
|
|
34506
|
+
200: {
|
|
34507
|
+
headers: {
|
|
34508
|
+
[name: string]: unknown;
|
|
34509
|
+
};
|
|
34510
|
+
content: {
|
|
34511
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
34512
|
+
};
|
|
34513
|
+
};
|
|
34514
|
+
/** @description Channel request is invalid (Bad Request). */
|
|
34515
|
+
400: {
|
|
34516
|
+
headers: {
|
|
34517
|
+
[name: string]: unknown;
|
|
34518
|
+
};
|
|
34519
|
+
content: {
|
|
34520
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34521
|
+
};
|
|
34522
|
+
};
|
|
34523
|
+
/** @description Unauthorized access. */
|
|
34524
|
+
401: {
|
|
34525
|
+
headers: {
|
|
34526
|
+
[name: string]: unknown;
|
|
34527
|
+
};
|
|
34528
|
+
content: {
|
|
34529
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34530
|
+
};
|
|
34531
|
+
};
|
|
34532
|
+
/** @description Forbidden access. */
|
|
34533
|
+
403: {
|
|
34534
|
+
headers: {
|
|
34535
|
+
[name: string]: unknown;
|
|
34536
|
+
};
|
|
34537
|
+
content: {
|
|
34538
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34539
|
+
};
|
|
34540
|
+
};
|
|
34541
|
+
/** @description Channel not found. */
|
|
34542
|
+
404: {
|
|
34543
|
+
headers: {
|
|
34544
|
+
[name: string]: unknown;
|
|
34545
|
+
};
|
|
34546
|
+
content: {
|
|
34547
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34548
|
+
};
|
|
34549
|
+
};
|
|
34550
|
+
/** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
34551
|
+
409: {
|
|
34552
|
+
headers: {
|
|
34553
|
+
[name: string]: unknown;
|
|
34554
|
+
};
|
|
34555
|
+
content: {
|
|
34556
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34557
|
+
};
|
|
34558
|
+
};
|
|
34559
|
+
/** @description Channel could not be deleted. */
|
|
34560
|
+
422: {
|
|
34561
|
+
headers: {
|
|
34562
|
+
[name: string]: unknown;
|
|
34563
|
+
};
|
|
34564
|
+
content: {
|
|
34565
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34566
|
+
};
|
|
34567
|
+
};
|
|
34568
|
+
/** @description Something went wrong while processing Channel. */
|
|
34569
|
+
500: {
|
|
34570
|
+
headers: {
|
|
34571
|
+
[name: string]: unknown;
|
|
34572
|
+
};
|
|
34573
|
+
content: {
|
|
34574
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34575
|
+
};
|
|
34576
|
+
};
|
|
34577
|
+
/** @description Unexpected error. */
|
|
34578
|
+
default: {
|
|
34579
|
+
headers: {
|
|
34580
|
+
[name: string]: unknown;
|
|
34581
|
+
};
|
|
34582
|
+
content: {
|
|
34583
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34584
|
+
};
|
|
34585
|
+
};
|
|
34586
|
+
};
|
|
34587
|
+
};
|
|
34588
|
+
PatchChannel: {
|
|
33458
34589
|
parameters: {
|
|
33459
34590
|
query?: {
|
|
33460
34591
|
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
@@ -33471,7 +34602,36 @@ interface operations {
|
|
|
33471
34602
|
};
|
|
33472
34603
|
requestBody?: {
|
|
33473
34604
|
content: {
|
|
33474
|
-
"application/json":
|
|
34605
|
+
"application/merge-patch+json": {
|
|
34606
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
34607
|
+
Annotations?: {
|
|
34608
|
+
[key: string]: string | null;
|
|
34609
|
+
} | null;
|
|
34610
|
+
Commands?: {
|
|
34611
|
+
[key: string]: Record<string, never> | null;
|
|
34612
|
+
} | null;
|
|
34613
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
34614
|
+
DeleteGates?: {
|
|
34615
|
+
[key: string]: boolean | null;
|
|
34616
|
+
} | null;
|
|
34617
|
+
/** @description Friendly name for the entity. */
|
|
34618
|
+
DisplayName?: string | null;
|
|
34619
|
+
EventPosition?: number | null;
|
|
34620
|
+
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
34621
|
+
HiddenReason?: string | null;
|
|
34622
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
34623
|
+
Labels?: {
|
|
34624
|
+
[key: string]: string | null;
|
|
34625
|
+
} | null;
|
|
34626
|
+
Permissions?: {
|
|
34627
|
+
[key: string]: Record<string, never> | null;
|
|
34628
|
+
} | null;
|
|
34629
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
34630
|
+
Slug?: string | null;
|
|
34631
|
+
Subscriptions?: (Record<string, never> | null)[] | null;
|
|
34632
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
34633
|
+
Version?: number | null;
|
|
34634
|
+
};
|
|
33475
34635
|
};
|
|
33476
34636
|
};
|
|
33477
34637
|
responses: {
|
|
@@ -33549,7 +34709,7 @@ interface operations {
|
|
|
33549
34709
|
};
|
|
33550
34710
|
};
|
|
33551
34711
|
};
|
|
33552
|
-
|
|
34712
|
+
ReportCommandRunResult: {
|
|
33553
34713
|
parameters: {
|
|
33554
34714
|
query?: never;
|
|
33555
34715
|
header?: never;
|
|
@@ -33558,21 +34718,27 @@ interface operations {
|
|
|
33558
34718
|
space_id: string;
|
|
33559
34719
|
/** @description Unique identifier for a channel_id */
|
|
33560
34720
|
channel_id: string;
|
|
34721
|
+
/** @description Unique identifier for a command_run_id */
|
|
34722
|
+
command_run_id: string;
|
|
33561
34723
|
};
|
|
33562
34724
|
cookie?: never;
|
|
33563
34725
|
};
|
|
33564
|
-
requestBody?:
|
|
34726
|
+
requestBody?: {
|
|
34727
|
+
content: {
|
|
34728
|
+
"application/json": components["schemas"]["CommandRunResult"];
|
|
34729
|
+
};
|
|
34730
|
+
};
|
|
33565
34731
|
responses: {
|
|
33566
|
-
/** @description
|
|
34732
|
+
/** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */
|
|
33567
34733
|
200: {
|
|
33568
34734
|
headers: {
|
|
33569
34735
|
[name: string]: unknown;
|
|
33570
34736
|
};
|
|
33571
34737
|
content: {
|
|
33572
|
-
"application/json": components["schemas"]["
|
|
34738
|
+
"application/json": components["schemas"]["CommandRun"];
|
|
33573
34739
|
};
|
|
33574
34740
|
};
|
|
33575
|
-
/** @description
|
|
34741
|
+
/** @description CommandRun request is invalid (Bad Request). */
|
|
33576
34742
|
400: {
|
|
33577
34743
|
headers: {
|
|
33578
34744
|
[name: string]: unknown;
|
|
@@ -33599,7 +34765,7 @@ interface operations {
|
|
|
33599
34765
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33600
34766
|
};
|
|
33601
34767
|
};
|
|
33602
|
-
/** @description
|
|
34768
|
+
/** @description CommandRun not found. */
|
|
33603
34769
|
404: {
|
|
33604
34770
|
headers: {
|
|
33605
34771
|
[name: string]: unknown;
|
|
@@ -33608,7 +34774,7 @@ interface operations {
|
|
|
33608
34774
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33609
34775
|
};
|
|
33610
34776
|
};
|
|
33611
|
-
/** @description
|
|
34777
|
+
/** @description CommandRun data conflict. Data has changed since last read. */
|
|
33612
34778
|
409: {
|
|
33613
34779
|
headers: {
|
|
33614
34780
|
[name: string]: unknown;
|
|
@@ -33617,16 +34783,7 @@ interface operations {
|
|
|
33617
34783
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33618
34784
|
};
|
|
33619
34785
|
};
|
|
33620
|
-
/** @description
|
|
33621
|
-
422: {
|
|
33622
|
-
headers: {
|
|
33623
|
-
[name: string]: unknown;
|
|
33624
|
-
};
|
|
33625
|
-
content: {
|
|
33626
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33627
|
-
};
|
|
33628
|
-
};
|
|
33629
|
-
/** @description Something went wrong while processing Channel. */
|
|
34786
|
+
/** @description Something went wrong while processing CommandRun. */
|
|
33630
34787
|
500: {
|
|
33631
34788
|
headers: {
|
|
33632
34789
|
[name: string]: unknown;
|
|
@@ -33646,12 +34803,9 @@ interface operations {
|
|
|
33646
34803
|
};
|
|
33647
34804
|
};
|
|
33648
34805
|
};
|
|
33649
|
-
|
|
34806
|
+
GetChannelDocument: {
|
|
33650
34807
|
parameters: {
|
|
33651
|
-
query?:
|
|
33652
|
-
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
33653
|
-
dry_run?: boolean;
|
|
33654
|
-
};
|
|
34808
|
+
query?: never;
|
|
33655
34809
|
header?: never;
|
|
33656
34810
|
path: {
|
|
33657
34811
|
/** @description Unique identifier for a space_id */
|
|
@@ -33661,48 +34815,15 @@ interface operations {
|
|
|
33661
34815
|
};
|
|
33662
34816
|
cookie?: never;
|
|
33663
34817
|
};
|
|
33664
|
-
requestBody?:
|
|
33665
|
-
content: {
|
|
33666
|
-
"application/merge-patch+json": {
|
|
33667
|
-
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
33668
|
-
Annotations?: {
|
|
33669
|
-
[key: string]: string | null;
|
|
33670
|
-
} | null;
|
|
33671
|
-
Commands?: {
|
|
33672
|
-
[key: string]: Record<string, never> | null;
|
|
33673
|
-
} | null;
|
|
33674
|
-
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
33675
|
-
DeleteGates?: {
|
|
33676
|
-
[key: string]: boolean | null;
|
|
33677
|
-
} | null;
|
|
33678
|
-
/** @description Friendly name for the entity. */
|
|
33679
|
-
DisplayName?: string | null;
|
|
33680
|
-
EventPosition?: number | null;
|
|
33681
|
-
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
33682
|
-
HiddenReason?: string | null;
|
|
33683
|
-
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
33684
|
-
Labels?: {
|
|
33685
|
-
[key: string]: string | null;
|
|
33686
|
-
} | null;
|
|
33687
|
-
Permissions?: {
|
|
33688
|
-
[key: string]: Record<string, never> | null;
|
|
33689
|
-
} | null;
|
|
33690
|
-
/** @description Unique URL-safe identifier for the entity. */
|
|
33691
|
-
Slug?: string | null;
|
|
33692
|
-
Subscriptions?: (Record<string, never> | null)[] | null;
|
|
33693
|
-
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
33694
|
-
Version?: number | null;
|
|
33695
|
-
};
|
|
33696
|
-
};
|
|
33697
|
-
};
|
|
34818
|
+
requestBody?: never;
|
|
33698
34819
|
responses: {
|
|
33699
|
-
/** @description
|
|
34820
|
+
/** @description OK */
|
|
33700
34821
|
200: {
|
|
33701
34822
|
headers: {
|
|
33702
34823
|
[name: string]: unknown;
|
|
33703
34824
|
};
|
|
33704
34825
|
content: {
|
|
33705
|
-
"application/json": components["schemas"]["
|
|
34826
|
+
"application/json": components["schemas"]["EntityDocument"];
|
|
33706
34827
|
};
|
|
33707
34828
|
};
|
|
33708
34829
|
/** @description Channel request is invalid (Bad Request). */
|
|
@@ -33741,15 +34862,6 @@ interface operations {
|
|
|
33741
34862
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33742
34863
|
};
|
|
33743
34864
|
};
|
|
33744
|
-
/** @description Channel data conflict. Data has changed since last read. */
|
|
33745
|
-
409: {
|
|
33746
|
-
headers: {
|
|
33747
|
-
[name: string]: unknown;
|
|
33748
|
-
};
|
|
33749
|
-
content: {
|
|
33750
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33751
|
-
};
|
|
33752
|
-
};
|
|
33753
34865
|
/** @description Something went wrong while processing Channel. */
|
|
33754
34866
|
500: {
|
|
33755
34867
|
headers: {
|
|
@@ -33770,36 +34882,37 @@ interface operations {
|
|
|
33770
34882
|
};
|
|
33771
34883
|
};
|
|
33772
34884
|
};
|
|
33773
|
-
|
|
34885
|
+
UpdateChannelDocument: {
|
|
33774
34886
|
parameters: {
|
|
33775
|
-
query?:
|
|
34887
|
+
query?: {
|
|
34888
|
+
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
34889
|
+
dry_run?: boolean;
|
|
34890
|
+
};
|
|
33776
34891
|
header?: never;
|
|
33777
34892
|
path: {
|
|
33778
34893
|
/** @description Unique identifier for a space_id */
|
|
33779
34894
|
space_id: string;
|
|
33780
34895
|
/** @description Unique identifier for a channel_id */
|
|
33781
34896
|
channel_id: string;
|
|
33782
|
-
/** @description Unique identifier for a command_run_id */
|
|
33783
|
-
command_run_id: string;
|
|
33784
34897
|
};
|
|
33785
34898
|
cookie?: never;
|
|
33786
34899
|
};
|
|
33787
34900
|
requestBody?: {
|
|
33788
34901
|
content: {
|
|
33789
|
-
"application/json": components["schemas"]["
|
|
34902
|
+
"application/json": components["schemas"]["EntityDocumentEdit"];
|
|
33790
34903
|
};
|
|
33791
34904
|
};
|
|
33792
34905
|
responses: {
|
|
33793
|
-
/** @description
|
|
34906
|
+
/** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */
|
|
33794
34907
|
200: {
|
|
33795
34908
|
headers: {
|
|
33796
34909
|
[name: string]: unknown;
|
|
33797
34910
|
};
|
|
33798
34911
|
content: {
|
|
33799
|
-
"application/json": components["schemas"]["
|
|
34912
|
+
"application/json": components["schemas"]["Channel"];
|
|
33800
34913
|
};
|
|
33801
34914
|
};
|
|
33802
|
-
/** @description
|
|
34915
|
+
/** @description Channel request is invalid (Bad Request). */
|
|
33803
34916
|
400: {
|
|
33804
34917
|
headers: {
|
|
33805
34918
|
[name: string]: unknown;
|
|
@@ -33826,7 +34939,7 @@ interface operations {
|
|
|
33826
34939
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33827
34940
|
};
|
|
33828
34941
|
};
|
|
33829
|
-
/** @description
|
|
34942
|
+
/** @description Channel not found. */
|
|
33830
34943
|
404: {
|
|
33831
34944
|
headers: {
|
|
33832
34945
|
[name: string]: unknown;
|
|
@@ -33835,7 +34948,7 @@ interface operations {
|
|
|
33835
34948
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33836
34949
|
};
|
|
33837
34950
|
};
|
|
33838
|
-
/** @description
|
|
34951
|
+
/** @description The Channel changed since the document was read. */
|
|
33839
34952
|
409: {
|
|
33840
34953
|
headers: {
|
|
33841
34954
|
[name: string]: unknown;
|
|
@@ -33844,7 +34957,7 @@ interface operations {
|
|
|
33844
34957
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
33845
34958
|
};
|
|
33846
34959
|
};
|
|
33847
|
-
/** @description Something went wrong while processing
|
|
34960
|
+
/** @description Something went wrong while processing Channel. */
|
|
33848
34961
|
500: {
|
|
33849
34962
|
headers: {
|
|
33850
34963
|
[name: string]: unknown;
|
|
@@ -34315,7 +35428,7 @@ interface operations {
|
|
|
34315
35428
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
34316
35429
|
* If not specified, all fields are returned.
|
|
34317
35430
|
* Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
|
|
34318
|
-
* Fields used in where and contains filters,
|
|
35431
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
34319
35432
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
34320
35433
|
* The whole string must be query-encoded.
|
|
34321
35434
|
*/
|
|
@@ -34327,7 +35440,7 @@ interface operations {
|
|
|
34327
35440
|
*
|
|
34328
35441
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
34329
35442
|
*
|
|
34330
|
-
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID,
|
|
35443
|
+
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status, TargetID, TimeoutAt, UnitID.
|
|
34331
35444
|
*
|
|
34332
35445
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
34333
35446
|
*
|
|
@@ -34525,7 +35638,7 @@ interface operations {
|
|
|
34525
35638
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
34526
35639
|
* If not specified, all fields are returned.
|
|
34527
35640
|
* Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter.
|
|
34528
|
-
* Fields used in where and contains filters,
|
|
35641
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
34529
35642
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
34530
35643
|
* The whole string must be query-encoded.
|
|
34531
35644
|
*/
|
|
@@ -34956,7 +36069,7 @@ interface operations {
|
|
|
34956
36069
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
34957
36070
|
* If not specified, all fields are returned.
|
|
34958
36071
|
* Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
|
|
34959
|
-
* Fields used in where and contains filters,
|
|
36072
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
34960
36073
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
34961
36074
|
* The whole string must be query-encoded.
|
|
34962
36075
|
*/
|
|
@@ -34971,6 +36084,16 @@ interface operations {
|
|
|
34971
36084
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
34972
36085
|
*/
|
|
34973
36086
|
include_hidden?: string;
|
|
36087
|
+
/**
|
|
36088
|
+
* @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns.
|
|
36089
|
+
*
|
|
36090
|
+
* The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter.
|
|
36091
|
+
*
|
|
36092
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
36093
|
+
*
|
|
36094
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
36095
|
+
*/
|
|
36096
|
+
view?: string;
|
|
34974
36097
|
/** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
34975
36098
|
limit?: number;
|
|
34976
36099
|
/**
|
|
@@ -35192,7 +36315,7 @@ interface operations {
|
|
|
35192
36315
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
35193
36316
|
* If not specified, all fields are returned.
|
|
35194
36317
|
* Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter.
|
|
35195
|
-
* Fields used in where and contains filters,
|
|
36318
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
35196
36319
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
35197
36320
|
* The whole string must be query-encoded.
|
|
35198
36321
|
*/
|
|
@@ -35999,7 +37122,7 @@ interface operations {
|
|
|
35999
37122
|
trigger_filter?: string;
|
|
36000
37123
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
36001
37124
|
triggers_passed?: boolean;
|
|
36002
|
-
/** @description
|
|
37125
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
36003
37126
|
view?: string;
|
|
36004
37127
|
};
|
|
36005
37128
|
header?: never;
|
|
@@ -36227,7 +37350,7 @@ interface operations {
|
|
|
36227
37350
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
36228
37351
|
* If not specified, all fields are returned.
|
|
36229
37352
|
* Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
|
|
36230
|
-
* Fields used in where and contains filters,
|
|
37353
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
36231
37354
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
36232
37355
|
* The whole string must be query-encoded.
|
|
36233
37356
|
*/
|
|
@@ -36242,6 +37365,16 @@ interface operations {
|
|
|
36242
37365
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
36243
37366
|
*/
|
|
36244
37367
|
include_hidden?: string;
|
|
37368
|
+
/**
|
|
37369
|
+
* @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns.
|
|
37370
|
+
*
|
|
37371
|
+
* The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation.
|
|
37372
|
+
*
|
|
37373
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
37374
|
+
*
|
|
37375
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
37376
|
+
*/
|
|
37377
|
+
view?: string;
|
|
36245
37378
|
/** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
36246
37379
|
limit?: number;
|
|
36247
37380
|
/**
|
|
@@ -36459,7 +37592,7 @@ interface operations {
|
|
|
36459
37592
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
36460
37593
|
* If not specified, all fields are returned.
|
|
36461
37594
|
* Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter.
|
|
36462
|
-
* Fields used in where and contains filters,
|
|
37595
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
36463
37596
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
36464
37597
|
* The whole string must be query-encoded.
|
|
36465
37598
|
*/
|
|
@@ -37122,7 +38255,7 @@ interface operations {
|
|
|
37122
38255
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
37123
38256
|
* If not specified, all fields are returned.
|
|
37124
38257
|
* Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
|
|
37125
|
-
* Fields used in where and contains filters,
|
|
38258
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
37126
38259
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
37127
38260
|
* The whole string must be query-encoded.
|
|
37128
38261
|
*/
|
|
@@ -37137,6 +38270,16 @@ interface operations {
|
|
|
37137
38270
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
37138
38271
|
*/
|
|
37139
38272
|
include_hidden?: string;
|
|
38273
|
+
/**
|
|
38274
|
+
* @description UUID of a View whose columns to compute for each Link, returned as ViewColumns.
|
|
38275
|
+
*
|
|
38276
|
+
* The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link.
|
|
38277
|
+
*
|
|
38278
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
38279
|
+
*
|
|
38280
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
38281
|
+
*/
|
|
38282
|
+
view?: string;
|
|
37140
38283
|
/** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
37141
38284
|
limit?: number;
|
|
37142
38285
|
/**
|
|
@@ -37359,7 +38502,7 @@ interface operations {
|
|
|
37359
38502
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
37360
38503
|
* If not specified, all fields are returned.
|
|
37361
38504
|
* Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter.
|
|
37362
|
-
* Fields used in where and contains filters,
|
|
38505
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
37363
38506
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
37364
38507
|
* The whole string must be query-encoded.
|
|
37365
38508
|
*/
|
|
@@ -38061,7 +39204,7 @@ interface operations {
|
|
|
38061
39204
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
38062
39205
|
* If not specified, all fields are returned.
|
|
38063
39206
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
|
|
38064
|
-
* Fields used in where and contains filters,
|
|
39207
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
38065
39208
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
38066
39209
|
* The whole string must be query-encoded.
|
|
38067
39210
|
*/
|
|
@@ -38076,6 +39219,16 @@ interface operations {
|
|
|
38076
39219
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
38077
39220
|
*/
|
|
38078
39221
|
include_hidden?: string;
|
|
39222
|
+
/**
|
|
39223
|
+
* @description UUID of a View whose columns to compute for each Release, returned as ViewColumns.
|
|
39224
|
+
*
|
|
39225
|
+
* The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release.
|
|
39226
|
+
*
|
|
39227
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
39228
|
+
*
|
|
39229
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
39230
|
+
*/
|
|
39231
|
+
view?: string;
|
|
38079
39232
|
/** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
38080
39233
|
limit?: number;
|
|
38081
39234
|
/**
|
|
@@ -38295,7 +39448,7 @@ interface operations {
|
|
|
38295
39448
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
38296
39449
|
* If not specified, all fields are returned.
|
|
38297
39450
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter.
|
|
38298
|
-
* Fields used in where and contains filters,
|
|
39451
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
38299
39452
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
38300
39453
|
* The whole string must be query-encoded.
|
|
38301
39454
|
*/
|
|
@@ -38955,7 +40108,7 @@ interface operations {
|
|
|
38955
40108
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
38956
40109
|
* If not specified, all fields are returned.
|
|
38957
40110
|
* Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
|
|
38958
|
-
* Fields used in where and contains filters,
|
|
40111
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
38959
40112
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
38960
40113
|
* The whole string must be query-encoded.
|
|
38961
40114
|
*/
|
|
@@ -38970,6 +40123,16 @@ interface operations {
|
|
|
38970
40123
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
38971
40124
|
*/
|
|
38972
40125
|
include_hidden?: string;
|
|
40126
|
+
/**
|
|
40127
|
+
* @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns.
|
|
40128
|
+
*
|
|
40129
|
+
* The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag.
|
|
40130
|
+
*
|
|
40131
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
40132
|
+
*
|
|
40133
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
40134
|
+
*/
|
|
40135
|
+
view?: string;
|
|
38973
40136
|
/** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
38974
40137
|
limit?: number;
|
|
38975
40138
|
/**
|
|
@@ -39185,7 +40348,7 @@ interface operations {
|
|
|
39185
40348
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
39186
40349
|
* If not specified, all fields are returned.
|
|
39187
40350
|
* Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
|
|
39188
|
-
* Fields used in where and contains filters,
|
|
40351
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
39189
40352
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
39190
40353
|
* The whole string must be query-encoded.
|
|
39191
40354
|
*/
|
|
@@ -39672,7 +40835,7 @@ interface operations {
|
|
|
39672
40835
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
39673
40836
|
* If not specified, all fields are returned.
|
|
39674
40837
|
* Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
|
|
39675
|
-
* Fields used in where and contains filters,
|
|
40838
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
39676
40839
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
39677
40840
|
* The whole string must be query-encoded.
|
|
39678
40841
|
*/
|
|
@@ -39687,6 +40850,16 @@ interface operations {
|
|
|
39687
40850
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
39688
40851
|
*/
|
|
39689
40852
|
include_hidden?: string;
|
|
40853
|
+
/**
|
|
40854
|
+
* @description UUID of a View whose columns to compute for each Target, returned as ViewColumns.
|
|
40855
|
+
*
|
|
40856
|
+
* The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target.
|
|
40857
|
+
*
|
|
40858
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
40859
|
+
*
|
|
40860
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
40861
|
+
*/
|
|
40862
|
+
view?: string;
|
|
39690
40863
|
/** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
39691
40864
|
limit?: number;
|
|
39692
40865
|
/**
|
|
@@ -39904,7 +41077,7 @@ interface operations {
|
|
|
39904
41077
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
39905
41078
|
* If not specified, all fields are returned.
|
|
39906
41079
|
* Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
|
|
39907
|
-
* Fields used in where and contains filters,
|
|
41080
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
39908
41081
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
39909
41082
|
* The whole string must be query-encoded.
|
|
39910
41083
|
*/
|
|
@@ -40577,7 +41750,7 @@ interface operations {
|
|
|
40577
41750
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
40578
41751
|
* If not specified, all fields are returned.
|
|
40579
41752
|
* Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
|
|
40580
|
-
* Fields used in where and contains filters,
|
|
41753
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
40581
41754
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
40582
41755
|
* The whole string must be query-encoded.
|
|
40583
41756
|
*/
|
|
@@ -40592,6 +41765,16 @@ interface operations {
|
|
|
40592
41765
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
40593
41766
|
*/
|
|
40594
41767
|
include_hidden?: string;
|
|
41768
|
+
/**
|
|
41769
|
+
* @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns.
|
|
41770
|
+
*
|
|
41771
|
+
* The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger.
|
|
41772
|
+
*
|
|
41773
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
41774
|
+
*
|
|
41775
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
41776
|
+
*/
|
|
41777
|
+
view?: string;
|
|
40595
41778
|
/** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
40596
41779
|
limit?: number;
|
|
40597
41780
|
/**
|
|
@@ -40819,7 +42002,7 @@ interface operations {
|
|
|
40819
42002
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
40820
42003
|
* If not specified, all fields are returned.
|
|
40821
42004
|
* Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
|
|
40822
|
-
* Fields used in where and contains filters,
|
|
42005
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
40823
42006
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
40824
42007
|
* The whole string must be query-encoded.
|
|
40825
42008
|
*/
|
|
@@ -41535,7 +42718,7 @@ interface operations {
|
|
|
41535
42718
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
41536
42719
|
* If not specified, all fields are returned.
|
|
41537
42720
|
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
41538
|
-
* Fields used in where and contains filters,
|
|
42721
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
41539
42722
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
41540
42723
|
* The whole string must be query-encoded.
|
|
41541
42724
|
*/
|
|
@@ -41550,6 +42733,16 @@ interface operations {
|
|
|
41550
42733
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
41551
42734
|
*/
|
|
41552
42735
|
include_hidden?: string;
|
|
42736
|
+
/**
|
|
42737
|
+
* @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns.
|
|
42738
|
+
*
|
|
42739
|
+
* The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit.
|
|
42740
|
+
*
|
|
42741
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
42742
|
+
*
|
|
42743
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
42744
|
+
*/
|
|
42745
|
+
view?: string;
|
|
41553
42746
|
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
41554
42747
|
limit?: number;
|
|
41555
42748
|
/**
|
|
@@ -41586,8 +42779,6 @@ interface operations {
|
|
|
41586
42779
|
trigger_filter?: string;
|
|
41587
42780
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
41588
42781
|
triggers_passed?: boolean;
|
|
41589
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
41590
|
-
view?: string;
|
|
41591
42782
|
};
|
|
41592
42783
|
header?: never;
|
|
41593
42784
|
path: {
|
|
@@ -41804,7 +42995,7 @@ interface operations {
|
|
|
41804
42995
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
41805
42996
|
* If not specified, all fields are returned.
|
|
41806
42997
|
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
41807
|
-
* Fields used in where and contains filters,
|
|
42998
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
41808
42999
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
41809
43000
|
* The whole string must be query-encoded.
|
|
41810
43001
|
*/
|
|
@@ -43014,7 +44205,7 @@ interface operations {
|
|
|
43014
44205
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
43015
44206
|
* If not specified, all fields are returned.
|
|
43016
44207
|
* Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter.
|
|
43017
|
-
* Fields used in where and contains filters,
|
|
44208
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
43018
44209
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43019
44210
|
* The whole string must be query-encoded.
|
|
43020
44211
|
*/
|
|
@@ -43029,6 +44220,16 @@ interface operations {
|
|
|
43029
44220
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
43030
44221
|
*/
|
|
43031
44222
|
include_hidden?: string;
|
|
44223
|
+
/**
|
|
44224
|
+
* @description UUID of a View whose columns to compute for each Mutation, returned as ViewColumns.
|
|
44225
|
+
*
|
|
44226
|
+
* The View must be in the same Organization as the user credentials, and be a View of Mutation: its Of, or the From of its Filter, must be Mutation.
|
|
44227
|
+
*
|
|
44228
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
44229
|
+
*
|
|
44230
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
44231
|
+
*/
|
|
44232
|
+
view?: string;
|
|
43032
44233
|
/** @description Maximum number of Mutation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
43033
44234
|
limit?: number;
|
|
43034
44235
|
/**
|
|
@@ -43151,7 +44352,7 @@ interface operations {
|
|
|
43151
44352
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
43152
44353
|
* If not specified, all fields are returned.
|
|
43153
44354
|
* Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter.
|
|
43154
|
-
* Fields used in where and contains filters,
|
|
44355
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
43155
44356
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43156
44357
|
* The whole string must be query-encoded.
|
|
43157
44358
|
*/
|
|
@@ -43499,7 +44700,7 @@ interface operations {
|
|
|
43499
44700
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
43500
44701
|
* If not specified, all fields are returned.
|
|
43501
44702
|
* Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
|
|
43502
|
-
* Fields used in where and contains filters,
|
|
44703
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
43503
44704
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43504
44705
|
* The whole string must be query-encoded.
|
|
43505
44706
|
*/
|
|
@@ -43514,6 +44715,16 @@ interface operations {
|
|
|
43514
44715
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
43515
44716
|
*/
|
|
43516
44717
|
include_hidden?: string;
|
|
44718
|
+
/**
|
|
44719
|
+
* @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns.
|
|
44720
|
+
*
|
|
44721
|
+
* The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource.
|
|
44722
|
+
*
|
|
44723
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
44724
|
+
*
|
|
44725
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
44726
|
+
*/
|
|
44727
|
+
view?: string;
|
|
43517
44728
|
/** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
43518
44729
|
limit?: number;
|
|
43519
44730
|
/**
|
|
@@ -43543,8 +44754,6 @@ interface operations {
|
|
|
43543
44754
|
* @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue.
|
|
43544
44755
|
*/
|
|
43545
44756
|
offset?: number;
|
|
43546
|
-
/** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
|
|
43547
|
-
view?: string;
|
|
43548
44757
|
/** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
|
|
43549
44758
|
raw_data?: boolean;
|
|
43550
44759
|
};
|
|
@@ -43645,13 +44854,11 @@ interface operations {
|
|
|
43645
44854
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
43646
44855
|
* If not specified, all fields are returned.
|
|
43647
44856
|
* Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter.
|
|
43648
|
-
* Fields used in where and contains filters,
|
|
44857
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
43649
44858
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43650
44859
|
* The whole string must be query-encoded.
|
|
43651
44860
|
*/
|
|
43652
44861
|
select?: string;
|
|
43653
|
-
/** @description UUID of a View whose columns to extract for each resource, returned as ViewColumns. DataPath columns are read from the stored JSON rather than by invoking a function. */
|
|
43654
|
-
view?: string;
|
|
43655
44862
|
/** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */
|
|
43656
44863
|
raw_data?: boolean;
|
|
43657
44864
|
};
|
|
@@ -43824,7 +45031,7 @@ interface operations {
|
|
|
43824
45031
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
43825
45032
|
* If not specified, all fields are returned.
|
|
43826
45033
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
|
|
43827
|
-
* Fields used in where and contains filters,
|
|
45034
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
43828
45035
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43829
45036
|
* The whole string must be query-encoded.
|
|
43830
45037
|
*/
|
|
@@ -43839,6 +45046,16 @@ interface operations {
|
|
|
43839
45046
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
43840
45047
|
*/
|
|
43841
45048
|
include_hidden?: string;
|
|
45049
|
+
/**
|
|
45050
|
+
* @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns.
|
|
45051
|
+
*
|
|
45052
|
+
* The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment.
|
|
45053
|
+
*
|
|
45054
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
45055
|
+
*
|
|
45056
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
45057
|
+
*/
|
|
45058
|
+
view?: string;
|
|
43842
45059
|
/** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
43843
45060
|
limit?: number;
|
|
43844
45061
|
/**
|
|
@@ -44056,7 +45273,7 @@ interface operations {
|
|
|
44056
45273
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
44057
45274
|
* If not specified, all fields are returned.
|
|
44058
45275
|
* Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter.
|
|
44059
|
-
* Fields used in where and contains filters,
|
|
45276
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
44060
45277
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
44061
45278
|
* The whole string must be query-encoded.
|
|
44062
45279
|
*/
|
|
@@ -44541,7 +45758,7 @@ interface operations {
|
|
|
44541
45758
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
44542
45759
|
* If not specified, all fields are returned.
|
|
44543
45760
|
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
44544
|
-
* Fields used in where and contains filters,
|
|
45761
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
44545
45762
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
44546
45763
|
* The whole string must be query-encoded.
|
|
44547
45764
|
*/
|
|
@@ -44556,6 +45773,16 @@ interface operations {
|
|
|
44556
45773
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
44557
45774
|
*/
|
|
44558
45775
|
include_hidden?: string;
|
|
45776
|
+
/**
|
|
45777
|
+
* @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns.
|
|
45778
|
+
*
|
|
45779
|
+
* The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision.
|
|
45780
|
+
*
|
|
45781
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
45782
|
+
*
|
|
45783
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
45784
|
+
*/
|
|
45785
|
+
view?: string;
|
|
44559
45786
|
/** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
44560
45787
|
limit?: number;
|
|
44561
45788
|
/**
|
|
@@ -44683,7 +45910,7 @@ interface operations {
|
|
|
44683
45910
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
44684
45911
|
* If not specified, all fields are returned.
|
|
44685
45912
|
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
44686
|
-
* Fields used in where and contains filters,
|
|
45913
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
44687
45914
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
44688
45915
|
* The whole string must be query-encoded.
|
|
44689
45916
|
*/
|
|
@@ -45561,7 +46788,7 @@ interface operations {
|
|
|
45561
46788
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
45562
46789
|
* If not specified, all fields are returned.
|
|
45563
46790
|
* Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
|
|
45564
|
-
* Fields used in where and contains filters,
|
|
46791
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
45565
46792
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
45566
46793
|
* The whole string must be query-encoded.
|
|
45567
46794
|
*/
|
|
@@ -45576,6 +46803,16 @@ interface operations {
|
|
|
45576
46803
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
45577
46804
|
*/
|
|
45578
46805
|
include_hidden?: string;
|
|
46806
|
+
/**
|
|
46807
|
+
* @description UUID of a View whose columns to compute for each View, returned as ViewColumns.
|
|
46808
|
+
*
|
|
46809
|
+
* The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View.
|
|
46810
|
+
*
|
|
46811
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
46812
|
+
*
|
|
46813
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
46814
|
+
*/
|
|
46815
|
+
view?: string;
|
|
45579
46816
|
/** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
45580
46817
|
limit?: number;
|
|
45581
46818
|
/**
|
|
@@ -45793,7 +47030,7 @@ interface operations {
|
|
|
45793
47030
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
45794
47031
|
* If not specified, all fields are returned.
|
|
45795
47032
|
* Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
|
|
45796
|
-
* Fields used in where and contains filters,
|
|
47033
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
45797
47034
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
45798
47035
|
* The whole string must be query-encoded.
|
|
45799
47036
|
*/
|
|
@@ -46458,7 +47695,7 @@ interface operations {
|
|
|
46458
47695
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
46459
47696
|
* If not specified, all fields are returned.
|
|
46460
47697
|
* Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter.
|
|
46461
|
-
* Fields used in where and contains filters,
|
|
47698
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
46462
47699
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
46463
47700
|
* The whole string must be query-encoded.
|
|
46464
47701
|
*/
|
|
@@ -46473,6 +47710,16 @@ interface operations {
|
|
|
46473
47710
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
46474
47711
|
*/
|
|
46475
47712
|
include_hidden?: string;
|
|
47713
|
+
/**
|
|
47714
|
+
* @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns.
|
|
47715
|
+
*
|
|
47716
|
+
* The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag.
|
|
47717
|
+
*
|
|
47718
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
47719
|
+
*
|
|
47720
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
47721
|
+
*/
|
|
47722
|
+
view?: string;
|
|
46476
47723
|
/** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
46477
47724
|
limit?: number;
|
|
46478
47725
|
/**
|
|
@@ -47561,7 +48808,7 @@ interface operations {
|
|
|
47561
48808
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
47562
48809
|
* If not specified, all fields are returned.
|
|
47563
48810
|
* Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter.
|
|
47564
|
-
* Fields used in where and contains filters,
|
|
48811
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
47565
48812
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
47566
48813
|
* The whole string must be query-encoded.
|
|
47567
48814
|
*/
|
|
@@ -47576,6 +48823,16 @@ interface operations {
|
|
|
47576
48823
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
47577
48824
|
*/
|
|
47578
48825
|
include_hidden?: string;
|
|
48826
|
+
/**
|
|
48827
|
+
* @description UUID of a View whose columns to compute for each Target, returned as ViewColumns.
|
|
48828
|
+
*
|
|
48829
|
+
* The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target.
|
|
48830
|
+
*
|
|
48831
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
48832
|
+
*
|
|
48833
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
48834
|
+
*/
|
|
48835
|
+
view?: string;
|
|
47579
48836
|
/** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
47580
48837
|
limit?: number;
|
|
47581
48838
|
/**
|
|
@@ -48754,7 +50011,7 @@ interface operations {
|
|
|
48754
50011
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
48755
50012
|
* If not specified, all fields are returned.
|
|
48756
50013
|
* Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter.
|
|
48757
|
-
* Fields used in where and contains filters,
|
|
50014
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
48758
50015
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
48759
50016
|
* The whole string must be query-encoded.
|
|
48760
50017
|
*/
|
|
@@ -48769,6 +50026,16 @@ interface operations {
|
|
|
48769
50026
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
48770
50027
|
*/
|
|
48771
50028
|
include_hidden?: string;
|
|
50029
|
+
/**
|
|
50030
|
+
* @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns.
|
|
50031
|
+
*
|
|
50032
|
+
* The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger.
|
|
50033
|
+
*
|
|
50034
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
50035
|
+
*
|
|
50036
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
50037
|
+
*/
|
|
50038
|
+
view?: string;
|
|
48772
50039
|
/** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
48773
50040
|
limit?: number;
|
|
48774
50041
|
/**
|
|
@@ -49989,7 +51256,7 @@ interface operations {
|
|
|
49989
51256
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
49990
51257
|
* If not specified, all fields are returned.
|
|
49991
51258
|
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
49992
|
-
* Fields used in where and contains filters,
|
|
51259
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
49993
51260
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
49994
51261
|
* The whole string must be query-encoded.
|
|
49995
51262
|
*/
|
|
@@ -50004,6 +51271,16 @@ interface operations {
|
|
|
50004
51271
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
50005
51272
|
*/
|
|
50006
51273
|
include_hidden?: string;
|
|
51274
|
+
/**
|
|
51275
|
+
* @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns.
|
|
51276
|
+
*
|
|
51277
|
+
* The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit.
|
|
51278
|
+
*
|
|
51279
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
51280
|
+
*
|
|
51281
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
51282
|
+
*/
|
|
51283
|
+
view?: string;
|
|
50007
51284
|
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
50008
51285
|
limit?: number;
|
|
50009
51286
|
/**
|
|
@@ -50040,8 +51317,6 @@ interface operations {
|
|
|
50040
51317
|
trigger_filter?: string;
|
|
50041
51318
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
50042
51319
|
triggers_passed?: boolean;
|
|
50043
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
50044
|
-
view?: string;
|
|
50045
51320
|
};
|
|
50046
51321
|
header?: never;
|
|
50047
51322
|
path?: never;
|
|
@@ -51894,7 +53169,7 @@ interface operations {
|
|
|
51894
53169
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51895
53170
|
* If not specified, all fields are returned.
|
|
51896
53171
|
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
51897
|
-
* Fields used in where and contains filters,
|
|
53172
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
51898
53173
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
51899
53174
|
* The whole string must be query-encoded.
|
|
51900
53175
|
*/
|
|
@@ -51909,6 +53184,8 @@ interface operations {
|
|
|
51909
53184
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
51910
53185
|
*/
|
|
51911
53186
|
include_hidden?: string;
|
|
53187
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
53188
|
+
view?: string;
|
|
51912
53189
|
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
51913
53190
|
limit?: number;
|
|
51914
53191
|
/**
|
|
@@ -51945,8 +53222,6 @@ interface operations {
|
|
|
51945
53222
|
trigger_filter?: string;
|
|
51946
53223
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
51947
53224
|
triggers_passed?: boolean;
|
|
51948
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
51949
|
-
view?: string;
|
|
51950
53225
|
};
|
|
51951
53226
|
header?: never;
|
|
51952
53227
|
path?: never;
|
|
@@ -52108,6 +53383,8 @@ interface operations {
|
|
|
52108
53383
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
52109
53384
|
*/
|
|
52110
53385
|
include_hidden?: string;
|
|
53386
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
53387
|
+
view?: string;
|
|
52111
53388
|
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
52112
53389
|
limit?: number;
|
|
52113
53390
|
/**
|
|
@@ -52144,8 +53421,6 @@ interface operations {
|
|
|
52144
53421
|
trigger_filter?: string;
|
|
52145
53422
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52146
53423
|
triggers_passed?: boolean;
|
|
52147
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
52148
|
-
view?: string;
|
|
52149
53424
|
/** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:<id>, ChangeSet:<id>, or ChangeOrder:<id>, any of them optionally prefixed with Before:. */
|
|
52150
53425
|
from?: string;
|
|
52151
53426
|
/** @description The Revision on the To side, in the same syntax as from. */
|
|
@@ -52523,7 +53798,7 @@ interface operations {
|
|
|
52523
53798
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
52524
53799
|
* If not specified, all fields are returned.
|
|
52525
53800
|
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
52526
|
-
* Fields used in where and contains filters,
|
|
53801
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
52527
53802
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
52528
53803
|
* The whole string must be query-encoded.
|
|
52529
53804
|
*/
|
|
@@ -52538,6 +53813,8 @@ interface operations {
|
|
|
52538
53813
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
52539
53814
|
*/
|
|
52540
53815
|
include_hidden?: string;
|
|
53816
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
53817
|
+
view?: string;
|
|
52541
53818
|
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
52542
53819
|
limit?: number;
|
|
52543
53820
|
/**
|
|
@@ -52574,8 +53851,6 @@ interface operations {
|
|
|
52574
53851
|
trigger_filter?: string;
|
|
52575
53852
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52576
53853
|
triggers_passed?: boolean;
|
|
52577
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
52578
|
-
view?: string;
|
|
52579
53854
|
};
|
|
52580
53855
|
header?: never;
|
|
52581
53856
|
path?: never;
|
|
@@ -52857,7 +54132,7 @@ interface operations {
|
|
|
52857
54132
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
52858
54133
|
* If not specified, all fields are returned.
|
|
52859
54134
|
* Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
|
|
52860
|
-
* Fields used in where and contains filters,
|
|
54135
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
52861
54136
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
52862
54137
|
* The whole string must be query-encoded.
|
|
52863
54138
|
*/
|
|
@@ -52872,6 +54147,16 @@ interface operations {
|
|
|
52872
54147
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
52873
54148
|
*/
|
|
52874
54149
|
include_hidden?: string;
|
|
54150
|
+
/**
|
|
54151
|
+
* @description UUID of a View whose columns to compute for each User, returned as ViewColumns.
|
|
54152
|
+
*
|
|
54153
|
+
* The View must be in the same Organization as the user credentials, and be a View of User: its Of, or the From of its Filter, must be User.
|
|
54154
|
+
*
|
|
54155
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
54156
|
+
*
|
|
54157
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
54158
|
+
*/
|
|
54159
|
+
view?: string;
|
|
52875
54160
|
/** @description Maximum number of User entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
52876
54161
|
limit?: number;
|
|
52877
54162
|
/**
|
|
@@ -52979,7 +54264,7 @@ interface operations {
|
|
|
52979
54264
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
52980
54265
|
* If not specified, all fields are returned.
|
|
52981
54266
|
* Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
|
|
52982
|
-
* Fields used in where and contains filters,
|
|
54267
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
52983
54268
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
52984
54269
|
* The whole string must be query-encoded.
|
|
52985
54270
|
*/
|
|
@@ -53417,7 +54702,7 @@ interface operations {
|
|
|
53417
54702
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
53418
54703
|
* If not specified, all fields are returned.
|
|
53419
54704
|
* Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter.
|
|
53420
|
-
* Fields used in where and contains filters,
|
|
54705
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
53421
54706
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
53422
54707
|
* The whole string must be query-encoded.
|
|
53423
54708
|
*/
|
|
@@ -53432,6 +54717,16 @@ interface operations {
|
|
|
53432
54717
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
53433
54718
|
*/
|
|
53434
54719
|
include_hidden?: string;
|
|
54720
|
+
/**
|
|
54721
|
+
* @description UUID of a View whose columns to compute for each View, returned as ViewColumns.
|
|
54722
|
+
*
|
|
54723
|
+
* The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View.
|
|
54724
|
+
*
|
|
54725
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
54726
|
+
*
|
|
54727
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
54728
|
+
*/
|
|
54729
|
+
view?: string;
|
|
53435
54730
|
/** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
53436
54731
|
limit?: number;
|
|
53437
54732
|
/**
|