@confighub/api 0.5.3 → 0.5.4
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 +1444 -479
- package/dist/index.d.ts +1444 -479
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -59,6 +59,46 @@ interface paths {
|
|
|
59
59
|
patch: operations["BulkPatchSpaces"];
|
|
60
60
|
trace?: never;
|
|
61
61
|
};
|
|
62
|
+
"/attest": {
|
|
63
|
+
parameters: {
|
|
64
|
+
query?: never;
|
|
65
|
+
header?: never;
|
|
66
|
+
path?: never;
|
|
67
|
+
cookie?: never;
|
|
68
|
+
};
|
|
69
|
+
get?: never;
|
|
70
|
+
put?: never;
|
|
71
|
+
/**
|
|
72
|
+
* Record Attestations across Spaces
|
|
73
|
+
* @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision. It defaults to the Revision the ChangeOrder's end Tag marks when ChangeOrderID is given, and to the head Revision otherwise. Each Space is recorded on its own and reported on its own.
|
|
74
|
+
*/
|
|
75
|
+
post: operations["Attest"];
|
|
76
|
+
delete?: never;
|
|
77
|
+
options?: never;
|
|
78
|
+
head?: never;
|
|
79
|
+
patch?: never;
|
|
80
|
+
trace?: never;
|
|
81
|
+
};
|
|
82
|
+
"/attestation": {
|
|
83
|
+
parameters: {
|
|
84
|
+
query?: never;
|
|
85
|
+
header?: never;
|
|
86
|
+
path?: never;
|
|
87
|
+
cookie?: never;
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* List of Attestations across spaces
|
|
91
|
+
* @description Retrieves a list of Attestations across spaces in the Organization
|
|
92
|
+
*/
|
|
93
|
+
get: operations["ListAllAttestations"];
|
|
94
|
+
put?: never;
|
|
95
|
+
post?: never;
|
|
96
|
+
delete?: never;
|
|
97
|
+
options?: never;
|
|
98
|
+
head?: never;
|
|
99
|
+
patch?: never;
|
|
100
|
+
trace?: never;
|
|
101
|
+
};
|
|
62
102
|
"/attribute": {
|
|
63
103
|
parameters: {
|
|
64
104
|
query?: never;
|
|
@@ -951,6 +991,50 @@ interface paths {
|
|
|
951
991
|
patch: operations["PatchSpace"];
|
|
952
992
|
trace?: never;
|
|
953
993
|
};
|
|
994
|
+
"/space/{space_id}/attestation": {
|
|
995
|
+
parameters: {
|
|
996
|
+
query?: never;
|
|
997
|
+
header?: never;
|
|
998
|
+
path?: never;
|
|
999
|
+
cookie?: never;
|
|
1000
|
+
};
|
|
1001
|
+
/**
|
|
1002
|
+
* List ExtendedAttestations
|
|
1003
|
+
* @description List ExtendedAttestations
|
|
1004
|
+
*/
|
|
1005
|
+
get: operations["ListExtendedAttestations"];
|
|
1006
|
+
put?: never;
|
|
1007
|
+
/**
|
|
1008
|
+
* Record an Attestation
|
|
1009
|
+
* @description Record an Attestation in the Space, covering one Revision of each Unit WhereUnit selects, named by Revision. Units with no such Revision are reported as skipped. When nothing is covered, nothing is recorded. With RevokedAttestationID, withdraw an earlier Attestation instead; a revocation covers no Revisions of its own. Requires Approve permission on the Space.
|
|
1010
|
+
*/
|
|
1011
|
+
post: operations["CreateAttestation"];
|
|
1012
|
+
delete?: never;
|
|
1013
|
+
options?: never;
|
|
1014
|
+
head?: never;
|
|
1015
|
+
patch?: never;
|
|
1016
|
+
trace?: never;
|
|
1017
|
+
};
|
|
1018
|
+
"/space/{space_id}/attestation/{attestation_id}": {
|
|
1019
|
+
parameters: {
|
|
1020
|
+
query?: never;
|
|
1021
|
+
header?: never;
|
|
1022
|
+
path?: never;
|
|
1023
|
+
cookie?: never;
|
|
1024
|
+
};
|
|
1025
|
+
/**
|
|
1026
|
+
* Get ExtendedAttestation
|
|
1027
|
+
* @description Get ExtendedAttestation
|
|
1028
|
+
*/
|
|
1029
|
+
get: operations["GetExtendedAttestation"];
|
|
1030
|
+
put?: never;
|
|
1031
|
+
post?: never;
|
|
1032
|
+
delete?: never;
|
|
1033
|
+
options?: never;
|
|
1034
|
+
head?: never;
|
|
1035
|
+
patch?: never;
|
|
1036
|
+
trace?: never;
|
|
1037
|
+
};
|
|
954
1038
|
"/space/{space_id}/attribute": {
|
|
955
1039
|
parameters: {
|
|
956
1040
|
query?: never;
|
|
@@ -2809,6 +2893,206 @@ interface components {
|
|
|
2809
2893
|
ArrayOrderMap: {
|
|
2810
2894
|
[key: string]: string[];
|
|
2811
2895
|
};
|
|
2896
|
+
AttestRequest: {
|
|
2897
|
+
/**
|
|
2898
|
+
* Format: uuid
|
|
2899
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2900
|
+
*/
|
|
2901
|
+
ChangeOrderID?: string;
|
|
2902
|
+
Claims?: {
|
|
2903
|
+
[key: string]: string;
|
|
2904
|
+
};
|
|
2905
|
+
EvidenceAttestationIDs?: components["schemas"]["UUID"][];
|
|
2906
|
+
/**
|
|
2907
|
+
* Format: date-time
|
|
2908
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
2909
|
+
*/
|
|
2910
|
+
ExpiresAt?: string;
|
|
2911
|
+
Note?: string;
|
|
2912
|
+
/**
|
|
2913
|
+
* Format: uuid
|
|
2914
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2915
|
+
*/
|
|
2916
|
+
ReleaseID?: string;
|
|
2917
|
+
Result?: string;
|
|
2918
|
+
Revision?: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* Format: uuid
|
|
2921
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2922
|
+
*/
|
|
2923
|
+
RevokedAttestationID?: string;
|
|
2924
|
+
/**
|
|
2925
|
+
* Format: uuid
|
|
2926
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2927
|
+
*/
|
|
2928
|
+
SpaceFilterID?: string;
|
|
2929
|
+
TargetStage?: string;
|
|
2930
|
+
Type?: string;
|
|
2931
|
+
WhereSpace?: string;
|
|
2932
|
+
WhereUnit?: string;
|
|
2933
|
+
};
|
|
2934
|
+
AttestResult: {
|
|
2935
|
+
Spaces?: components["schemas"]["AttestSpaceResult"][];
|
|
2936
|
+
};
|
|
2937
|
+
AttestSpaceResult: {
|
|
2938
|
+
Attestation?: components["schemas"]["Attestation"];
|
|
2939
|
+
Error?: components["schemas"]["ResponseError"];
|
|
2940
|
+
SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][];
|
|
2941
|
+
/**
|
|
2942
|
+
* Format: uuid
|
|
2943
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2944
|
+
*/
|
|
2945
|
+
SpaceID?: string;
|
|
2946
|
+
SpaceSlug?: string;
|
|
2947
|
+
Subjects?: components["schemas"]["AttestationSubject"][];
|
|
2948
|
+
};
|
|
2949
|
+
/** @description An Attestation records that a principal made a claim about specific Revisions, all in its Space: that they approve them, that a review or check passed or failed, or anything else its Type names. It is never updated; withdrawing one is a new Attestation naming it in RevokedAttestationID. */
|
|
2950
|
+
Attestation: {
|
|
2951
|
+
/**
|
|
2952
|
+
* Format: uuid
|
|
2953
|
+
* @description Uniquely identifies the Attestation.
|
|
2954
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2955
|
+
*/
|
|
2956
|
+
AttestationID?: string;
|
|
2957
|
+
/**
|
|
2958
|
+
* Format: uuid
|
|
2959
|
+
* @description The ChangeOrder the Attestation was made in the context of. Context only: it does not change which Revisions are covered.
|
|
2960
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2961
|
+
*/
|
|
2962
|
+
ChangeOrderID?: string;
|
|
2963
|
+
/** @description Anything else the attester records, as string key/value pairs with the limits of Annotations. */
|
|
2964
|
+
Claims?: {
|
|
2965
|
+
[key: string]: string;
|
|
2966
|
+
};
|
|
2967
|
+
/**
|
|
2968
|
+
* Format: date-time
|
|
2969
|
+
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
2970
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
2971
|
+
*/
|
|
2972
|
+
readonly CreatedAt?: string;
|
|
2973
|
+
/** @description The type of entity. */
|
|
2974
|
+
readonly EntityType?: string;
|
|
2975
|
+
/** @description Other Attestations this one relied on. They may be in other Spaces. */
|
|
2976
|
+
EvidenceAttestationIDs?: components["schemas"]["UUID"][];
|
|
2977
|
+
/**
|
|
2978
|
+
* Format: date-time
|
|
2979
|
+
* @description When the Attestation stops satisfying requirements. Optional.
|
|
2980
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
2981
|
+
*/
|
|
2982
|
+
ExpiresAt?: string;
|
|
2983
|
+
/** @description The attester's reason, in their own words. */
|
|
2984
|
+
Note?: string;
|
|
2985
|
+
/**
|
|
2986
|
+
* Format: uuid
|
|
2987
|
+
* @description The Organization the Attestation belongs to.
|
|
2988
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2989
|
+
*/
|
|
2990
|
+
OrganizationID?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* Format: uuid
|
|
2993
|
+
* @description A published Release the claim is about.
|
|
2994
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2995
|
+
*/
|
|
2996
|
+
ReleaseID?: string;
|
|
2997
|
+
/**
|
|
2998
|
+
* @description The outcome: Pass or Fail. For an Approval, approve or reject. Defaults to Pass.
|
|
2999
|
+
* @enum {string}
|
|
3000
|
+
*/
|
|
3001
|
+
Result?: AttestationResult;
|
|
3002
|
+
/**
|
|
3003
|
+
* Format: uuid
|
|
3004
|
+
* @description An earlier Attestation in the same Space that this one withdraws. A revocation covers no Revisions of its own.
|
|
3005
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3006
|
+
*/
|
|
3007
|
+
RevokedAttestationID?: string;
|
|
3008
|
+
/**
|
|
3009
|
+
* Format: uuid
|
|
3010
|
+
* @description The Space the Attestation belongs to. Every Revision it covers is in this Space.
|
|
3011
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3012
|
+
*/
|
|
3013
|
+
SpaceID?: string;
|
|
3014
|
+
/** @description Slug of the Space the Attestation belongs to. */
|
|
3015
|
+
readonly SpaceSlug?: string;
|
|
3016
|
+
/** @description What is being claimed, such as Approval. Requirements select Attestations by it. Defaults to Approval. */
|
|
3017
|
+
Type?: string;
|
|
3018
|
+
/**
|
|
3019
|
+
* Format: date-time
|
|
3020
|
+
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
3021
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
3022
|
+
*/
|
|
3023
|
+
readonly UpdatedAt?: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* Format: uuid
|
|
3026
|
+
* @description The authenticated User that created the Attestation.
|
|
3027
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3028
|
+
*/
|
|
3029
|
+
readonly UserID?: string;
|
|
3030
|
+
/**
|
|
3031
|
+
* Format: int64
|
|
3032
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
3033
|
+
*/
|
|
3034
|
+
Version?: number;
|
|
3035
|
+
};
|
|
3036
|
+
AttestationCreateRequest: {
|
|
3037
|
+
/**
|
|
3038
|
+
* Format: uuid
|
|
3039
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3040
|
+
*/
|
|
3041
|
+
ChangeOrderID?: string;
|
|
3042
|
+
Claims?: {
|
|
3043
|
+
[key: string]: string;
|
|
3044
|
+
};
|
|
3045
|
+
EvidenceAttestationIDs?: components["schemas"]["UUID"][];
|
|
3046
|
+
/**
|
|
3047
|
+
* Format: date-time
|
|
3048
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
3049
|
+
*/
|
|
3050
|
+
ExpiresAt?: string;
|
|
3051
|
+
Note?: string;
|
|
3052
|
+
/**
|
|
3053
|
+
* Format: uuid
|
|
3054
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3055
|
+
*/
|
|
3056
|
+
ReleaseID?: string;
|
|
3057
|
+
Result?: string;
|
|
3058
|
+
Revision?: string;
|
|
3059
|
+
/**
|
|
3060
|
+
* Format: uuid
|
|
3061
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3062
|
+
*/
|
|
3063
|
+
RevokedAttestationID?: string;
|
|
3064
|
+
Type?: string;
|
|
3065
|
+
WhereUnit?: string;
|
|
3066
|
+
};
|
|
3067
|
+
AttestationCreateResponse: {
|
|
3068
|
+
Attestation?: components["schemas"]["Attestation"];
|
|
3069
|
+
SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][];
|
|
3070
|
+
Subjects?: components["schemas"]["AttestationSubject"][];
|
|
3071
|
+
};
|
|
3072
|
+
AttestationSkippedUnit: {
|
|
3073
|
+
Reason?: string;
|
|
3074
|
+
/**
|
|
3075
|
+
* Format: uuid
|
|
3076
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3077
|
+
*/
|
|
3078
|
+
UnitID?: string;
|
|
3079
|
+
UnitSlug?: string;
|
|
3080
|
+
};
|
|
3081
|
+
AttestationSubject: {
|
|
3082
|
+
/**
|
|
3083
|
+
* Format: uuid
|
|
3084
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3085
|
+
*/
|
|
3086
|
+
RevisionID?: string;
|
|
3087
|
+
/** Format: int64 */
|
|
3088
|
+
RevisionNum?: number;
|
|
3089
|
+
/**
|
|
3090
|
+
* Format: uuid
|
|
3091
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3092
|
+
*/
|
|
3093
|
+
UnitID?: string;
|
|
3094
|
+
UnitSlug?: string;
|
|
3095
|
+
};
|
|
2812
3096
|
/**
|
|
2813
3097
|
* @description Defines a dynamic configuration attribute that registers getter and setter functions
|
|
2814
3098
|
* and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space
|
|
@@ -3445,6 +3729,8 @@ interface components {
|
|
|
3445
3729
|
Annotations?: {
|
|
3446
3730
|
[key: string]: string;
|
|
3447
3731
|
};
|
|
3732
|
+
/** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */
|
|
3733
|
+
AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][];
|
|
3448
3734
|
/**
|
|
3449
3735
|
* Format: uuid
|
|
3450
3736
|
* @description ChangeWorkflowID uniquely identifies a change workflow within the system.
|
|
@@ -3502,6 +3788,28 @@ interface components {
|
|
|
3502
3788
|
*/
|
|
3503
3789
|
Version?: number;
|
|
3504
3790
|
};
|
|
3791
|
+
ChangeWorkflowAttestationPrerequisite: {
|
|
3792
|
+
/** @description Count an attester who wrote a Revision of the change. By default one does not count. */
|
|
3793
|
+
AllowAuthors?: boolean;
|
|
3794
|
+
/** @description How many distinct attesters must record a Pass on each Revision. 1 when zero. */
|
|
3795
|
+
Count?: number;
|
|
3796
|
+
/** @description What the requirement is for, in the author's words. */
|
|
3797
|
+
Description?: string;
|
|
3798
|
+
/** @description Reserved: each counted attester must be from a different group of FromGroupIDs. Refused until Groups are recorded on Attestations. */
|
|
3799
|
+
DistinctGroups?: boolean;
|
|
3800
|
+
/** @description Reserved: Groups whose members' Attestations count. Refused until Groups are recorded on Attestations. */
|
|
3801
|
+
FromGroupIDs?: components["schemas"]["UUID"][];
|
|
3802
|
+
/** @description The Users whose Attestations count. Empty is anyone who may record an Attestation in the Space. */
|
|
3803
|
+
FromUserIDs?: components["schemas"]["UUID"][];
|
|
3804
|
+
/** @description Count only passes. By default an unrevoked Fail from an eligible attester fails the requirement, however many passes there are. */
|
|
3805
|
+
IgnoreFail?: boolean;
|
|
3806
|
+
/** @description How old an Attestation may be and still count, as a duration such as 72h. No limit when empty. */
|
|
3807
|
+
MaxAge?: string;
|
|
3808
|
+
/** @description What a stage, its ReleasePrerequisites, or Final gates on. Unique among the workflow's prerequisites, and refused if it shadows a built-in name. */
|
|
3809
|
+
Name: string;
|
|
3810
|
+
/** @description The Attestation Type that counts. Approval when empty. */
|
|
3811
|
+
Type?: string;
|
|
3812
|
+
};
|
|
3505
3813
|
ChangeWorkflowCreateOrUpdateResponse: {
|
|
3506
3814
|
ChangeWorkflow?: components["schemas"]["ChangeWorkflow"];
|
|
3507
3815
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -3519,6 +3827,8 @@ interface components {
|
|
|
3519
3827
|
Name: string;
|
|
3520
3828
|
};
|
|
3521
3829
|
ChangeWorkflowSpec: {
|
|
3830
|
+
/** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */
|
|
3831
|
+
AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][];
|
|
3522
3832
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
3523
3833
|
CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][];
|
|
3524
3834
|
Final?: components["schemas"]["ChangeWorkflowFinalStage"];
|
|
@@ -3530,6 +3840,8 @@ interface components {
|
|
|
3530
3840
|
Name: string;
|
|
3531
3841
|
/** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage ahead of this one, so the first stage's are never evaluated. */
|
|
3532
3842
|
Prerequisites?: string[];
|
|
3843
|
+
/** @description Gates on publishing a Release for a change order in one of the stage's Spaces, each naming one declared in AttestationPrerequisites. Evaluated over the Revisions the Release bundles. */
|
|
3844
|
+
ReleasePrerequisites?: string[];
|
|
3533
3845
|
/** @description Selects the stage's Spaces: a where expression over Spaces. Intersected with the change order's component and its in-scope Space list. It must not name Labels.Component. Empty selects every Space of the change order's component. */
|
|
3534
3846
|
WhereSpace?: string;
|
|
3535
3847
|
};
|
|
@@ -3641,6 +3953,12 @@ interface components {
|
|
|
3641
3953
|
/** @description Collection of error details */
|
|
3642
3954
|
Items?: components["schemas"]["ErrorItem"][];
|
|
3643
3955
|
};
|
|
3956
|
+
/** @description Attestation with additional related entities expanded based on the request's include parameter. */
|
|
3957
|
+
ExtendedAttestation: {
|
|
3958
|
+
Attestation?: components["schemas"]["Attestation"];
|
|
3959
|
+
Organization?: components["schemas"]["Organization"];
|
|
3960
|
+
Space?: components["schemas"]["Space"];
|
|
3961
|
+
};
|
|
3644
3962
|
ExtendedAttribute: {
|
|
3645
3963
|
Attribute?: components["schemas"]["Attribute"];
|
|
3646
3964
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -3745,6 +4063,7 @@ interface components {
|
|
|
3745
4063
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
3746
4064
|
};
|
|
3747
4065
|
ExtendedRevision: {
|
|
4066
|
+
Attestations?: components["schemas"]["Attestation"][];
|
|
3748
4067
|
ChangeOrders?: components["schemas"]["ChangeOrder"][];
|
|
3749
4068
|
ChangeSet?: components["schemas"]["ChangeSet"];
|
|
3750
4069
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5277,6 +5596,10 @@ interface components {
|
|
|
5277
5596
|
};
|
|
5278
5597
|
/** @description the users that have approved the latest version of the config data for the Unit. */
|
|
5279
5598
|
ApprovedBy?: components["schemas"]["UUID"][];
|
|
5599
|
+
/** @description A set (map) of AttestationIDs of the Attestations covering this Revision: approvals, reviews, and other claims made about it. The string values have no particular meaning. */
|
|
5600
|
+
readonly Attestations?: {
|
|
5601
|
+
[key: string]: string;
|
|
5602
|
+
};
|
|
5280
5603
|
readonly ChangeOrders?: {
|
|
5281
5604
|
[key: string]: string;
|
|
5282
5605
|
};
|
|
@@ -7950,12 +8273,111 @@ interface operations {
|
|
|
7950
8273
|
};
|
|
7951
8274
|
};
|
|
7952
8275
|
};
|
|
7953
|
-
|
|
8276
|
+
Attest: {
|
|
8277
|
+
parameters: {
|
|
8278
|
+
query?: {
|
|
8279
|
+
/** @description Resolve the Revisions that would be covered and return the same response without writing anything. */
|
|
8280
|
+
dry_run?: boolean;
|
|
8281
|
+
};
|
|
8282
|
+
header?: never;
|
|
8283
|
+
path?: never;
|
|
8284
|
+
cookie?: never;
|
|
8285
|
+
};
|
|
8286
|
+
requestBody?: {
|
|
8287
|
+
content: {
|
|
8288
|
+
"application/json": components["schemas"]["AttestRequest"];
|
|
8289
|
+
};
|
|
8290
|
+
};
|
|
8291
|
+
responses: {
|
|
8292
|
+
/** @description OK */
|
|
8293
|
+
200: {
|
|
8294
|
+
headers: {
|
|
8295
|
+
[name: string]: unknown;
|
|
8296
|
+
};
|
|
8297
|
+
content: {
|
|
8298
|
+
"application/json": components["schemas"]["AttestResult"];
|
|
8299
|
+
};
|
|
8300
|
+
};
|
|
8301
|
+
/** @description Recording failed in some Spaces; each Space's result carries its own error */
|
|
8302
|
+
207: {
|
|
8303
|
+
headers: {
|
|
8304
|
+
[name: string]: unknown;
|
|
8305
|
+
};
|
|
8306
|
+
content: {
|
|
8307
|
+
"application/json": components["schemas"]["AttestResult"];
|
|
8308
|
+
};
|
|
8309
|
+
};
|
|
8310
|
+
/** @description Attest request is invalid (Bad Request). */
|
|
8311
|
+
400: {
|
|
8312
|
+
headers: {
|
|
8313
|
+
[name: string]: unknown;
|
|
8314
|
+
};
|
|
8315
|
+
content: {
|
|
8316
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8317
|
+
};
|
|
8318
|
+
};
|
|
8319
|
+
/** @description Unauthorized access. */
|
|
8320
|
+
401: {
|
|
8321
|
+
headers: {
|
|
8322
|
+
[name: string]: unknown;
|
|
8323
|
+
};
|
|
8324
|
+
content: {
|
|
8325
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8326
|
+
};
|
|
8327
|
+
};
|
|
8328
|
+
/** @description Forbidden access. */
|
|
8329
|
+
403: {
|
|
8330
|
+
headers: {
|
|
8331
|
+
[name: string]: unknown;
|
|
8332
|
+
};
|
|
8333
|
+
content: {
|
|
8334
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8335
|
+
};
|
|
8336
|
+
};
|
|
8337
|
+
/** @description Attest not found. */
|
|
8338
|
+
404: {
|
|
8339
|
+
headers: {
|
|
8340
|
+
[name: string]: unknown;
|
|
8341
|
+
};
|
|
8342
|
+
content: {
|
|
8343
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8344
|
+
};
|
|
8345
|
+
};
|
|
8346
|
+
/** @description Attest data conflict. Data has changed since last read. */
|
|
8347
|
+
409: {
|
|
8348
|
+
headers: {
|
|
8349
|
+
[name: string]: unknown;
|
|
8350
|
+
};
|
|
8351
|
+
content: {
|
|
8352
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8353
|
+
};
|
|
8354
|
+
};
|
|
8355
|
+
/** @description Something went wrong while processing Attest. */
|
|
8356
|
+
500: {
|
|
8357
|
+
headers: {
|
|
8358
|
+
[name: string]: unknown;
|
|
8359
|
+
};
|
|
8360
|
+
content: {
|
|
8361
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8362
|
+
};
|
|
8363
|
+
};
|
|
8364
|
+
/** @description Unexpected error. */
|
|
8365
|
+
default: {
|
|
8366
|
+
headers: {
|
|
8367
|
+
[name: string]: unknown;
|
|
8368
|
+
};
|
|
8369
|
+
content: {
|
|
8370
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8371
|
+
};
|
|
8372
|
+
};
|
|
8373
|
+
};
|
|
8374
|
+
};
|
|
8375
|
+
ListAllAttestations: {
|
|
7954
8376
|
parameters: {
|
|
7955
8377
|
query?: {
|
|
7956
8378
|
/**
|
|
7957
8379
|
* @description The specified string is an expression for the purpose of filtering
|
|
7958
|
-
* the list of
|
|
8380
|
+
* the list of Attestations returned. The expression syntax was inspired by SQL.
|
|
7959
8381
|
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
7960
8382
|
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
7961
8383
|
* as in the JSON encoding.
|
|
@@ -7988,17 +8410,17 @@ interface operations {
|
|
|
7988
8410
|
* An example conjunction is:
|
|
7989
8411
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
7990
8412
|
*
|
|
7991
|
-
* Supported attributes for filtering on
|
|
8413
|
+
* Supported attributes for filtering on Attestation: AttestationID, ChangeOrderID, Claims, CreatedAt, EvidenceAttestationIDs, ExpiresAt, Note, OrganizationID, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID.
|
|
7992
8414
|
*
|
|
7993
8415
|
* The whole string must be query-encoded.
|
|
7994
8416
|
*/
|
|
7995
8417
|
where?: string;
|
|
7996
8418
|
/**
|
|
7997
|
-
* @description UUID of a Filter entity to apply to the
|
|
8419
|
+
* @description UUID of a Filter entity to apply to the Attestation list.
|
|
7998
8420
|
*
|
|
7999
8421
|
* The Filter must be in the same Organization as the user credentials.
|
|
8000
8422
|
*
|
|
8001
|
-
* The Filter's From field must match the entity type being filtered (
|
|
8423
|
+
* The Filter's From field must match the entity type being filtered (Attestation).
|
|
8002
8424
|
*
|
|
8003
8425
|
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
8004
8426
|
*
|
|
@@ -8020,27 +8442,27 @@ interface operations {
|
|
|
8020
8442
|
*
|
|
8021
8443
|
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
8022
8444
|
*
|
|
8023
|
-
* Searchable fields for
|
|
8445
|
+
* Searchable fields for Attestation include string and map-type attributes from the queryable attributes list.
|
|
8024
8446
|
*
|
|
8025
8447
|
* The whole string must be query-encoded.
|
|
8026
8448
|
*/
|
|
8027
8449
|
contains?: string;
|
|
8028
8450
|
/**
|
|
8029
|
-
* @description Include clause for expanding related entities in the response for
|
|
8451
|
+
* @description Include clause for expanding related entities in the response for Attestation.
|
|
8030
8452
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8031
8453
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8032
8454
|
*
|
|
8033
|
-
* Supported attributes for
|
|
8455
|
+
* Supported attributes for Attestation are OrganizationID, SpaceID.
|
|
8034
8456
|
*
|
|
8035
8457
|
* The whole string must be query-encoded.
|
|
8036
8458
|
*/
|
|
8037
8459
|
include?: string;
|
|
8038
8460
|
/**
|
|
8039
|
-
* @description Select clause for specifying which fields to include in the response for
|
|
8461
|
+
* @description Select clause for specifying which fields to include in the response for Attestation.
|
|
8040
8462
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8041
8463
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8042
8464
|
* If not specified, all fields are returned.
|
|
8043
|
-
* Entity and parent IDs (like OrganizationID, SpaceID,
|
|
8465
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
8044
8466
|
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
8045
8467
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
8046
8468
|
* The whole string must be query-encoded.
|
|
@@ -8059,10 +8481,10 @@ interface operations {
|
|
|
8059
8481
|
[name: string]: unknown;
|
|
8060
8482
|
};
|
|
8061
8483
|
content: {
|
|
8062
|
-
"application/json": components["schemas"]["
|
|
8484
|
+
"application/json": components["schemas"]["ExtendedAttestation"][];
|
|
8063
8485
|
};
|
|
8064
8486
|
};
|
|
8065
|
-
/** @description
|
|
8487
|
+
/** @description Attestation request is invalid (Bad Request). */
|
|
8066
8488
|
400: {
|
|
8067
8489
|
headers: {
|
|
8068
8490
|
[name: string]: unknown;
|
|
@@ -8089,7 +8511,7 @@ interface operations {
|
|
|
8089
8511
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8090
8512
|
};
|
|
8091
8513
|
};
|
|
8092
|
-
/** @description
|
|
8514
|
+
/** @description Attestation not found. */
|
|
8093
8515
|
404: {
|
|
8094
8516
|
headers: {
|
|
8095
8517
|
[name: string]: unknown;
|
|
@@ -8098,7 +8520,7 @@ interface operations {
|
|
|
8098
8520
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8099
8521
|
};
|
|
8100
8522
|
};
|
|
8101
|
-
/** @description Something went wrong while processing
|
|
8523
|
+
/** @description Something went wrong while processing Attestation. */
|
|
8102
8524
|
500: {
|
|
8103
8525
|
headers: {
|
|
8104
8526
|
[name: string]: unknown;
|
|
@@ -8118,7 +8540,7 @@ interface operations {
|
|
|
8118
8540
|
};
|
|
8119
8541
|
};
|
|
8120
8542
|
};
|
|
8121
|
-
|
|
8543
|
+
ListAllAttributes: {
|
|
8122
8544
|
parameters: {
|
|
8123
8545
|
query?: {
|
|
8124
8546
|
/**
|
|
@@ -8203,100 +8625,23 @@ interface operations {
|
|
|
8203
8625
|
* The whole string must be query-encoded.
|
|
8204
8626
|
*/
|
|
8205
8627
|
include?: string;
|
|
8206
|
-
/** @description Comma-separated list of prefixes to apply to cloned Attribute names */
|
|
8207
|
-
name_prefixes?: string;
|
|
8208
8628
|
/**
|
|
8209
|
-
* @description
|
|
8210
|
-
*
|
|
8211
|
-
*
|
|
8212
|
-
*
|
|
8213
|
-
*
|
|
8214
|
-
*
|
|
8215
|
-
*
|
|
8216
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
8217
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
8218
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
8219
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
8220
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
8221
|
-
* UUID and time literals must be quoted as string literals.
|
|
8222
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
8223
|
-
* Time literals use the same form as when serialized as JSON,
|
|
8224
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
8225
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
8226
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
8227
|
-
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
8228
|
-
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
8229
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
8230
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
8231
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
8232
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
8233
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
8234
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
8235
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
8236
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
8237
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
8238
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
8239
|
-
* Conjunctions are supported using the `AND` operator.
|
|
8240
|
-
* An example conjunction is:
|
|
8241
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8242
|
-
*
|
|
8243
|
-
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt.
|
|
8244
|
-
*
|
|
8245
|
-
* Where expression to select destination spaces for cloning attributes
|
|
8246
|
-
*
|
|
8629
|
+
* @description Select clause for specifying which fields to include in the response for Attribute.
|
|
8630
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
8631
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
8632
|
+
* If not specified, all fields are returned.
|
|
8633
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter.
|
|
8634
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
8635
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
8247
8636
|
* The whole string must be query-encoded.
|
|
8248
8637
|
*/
|
|
8249
|
-
|
|
8250
|
-
/**
|
|
8251
|
-
* @description UUID of a Filter entity to apply to the Space list.
|
|
8252
|
-
*
|
|
8253
|
-
* The Filter must be in the same Organization as the user credentials.
|
|
8254
|
-
*
|
|
8255
|
-
* The Filter's From field must match the entity type being filtered (Space).
|
|
8256
|
-
*
|
|
8257
|
-
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
8258
|
-
*
|
|
8259
|
-
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
8260
|
-
*
|
|
8261
|
-
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
8262
|
-
*/
|
|
8263
|
-
filter_space?: string;
|
|
8264
|
-
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
8265
|
-
allow_exists?: string;
|
|
8638
|
+
select?: string;
|
|
8266
8639
|
};
|
|
8267
8640
|
header?: never;
|
|
8268
8641
|
path?: never;
|
|
8269
8642
|
cookie?: never;
|
|
8270
8643
|
};
|
|
8271
|
-
requestBody?:
|
|
8272
|
-
content: {
|
|
8273
|
-
"application/merge-patch+json": {
|
|
8274
|
-
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
8275
|
-
Annotations?: {
|
|
8276
|
-
[key: string]: string | null;
|
|
8277
|
-
} | null;
|
|
8278
|
-
DataType?: string | null;
|
|
8279
|
-
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
8280
|
-
DeleteGates?: {
|
|
8281
|
-
[key: string]: boolean | null;
|
|
8282
|
-
} | null;
|
|
8283
|
-
Description?: string | null;
|
|
8284
|
-
/** @description Friendly name for the entity. */
|
|
8285
|
-
DisplayName?: string | null;
|
|
8286
|
-
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
8287
|
-
Labels?: {
|
|
8288
|
-
[key: string]: string | null;
|
|
8289
|
-
} | null;
|
|
8290
|
-
Parameters?: (Record<string, never> | null)[] | null;
|
|
8291
|
-
ResourceTypePaths?: (Record<string, never> | null)[] | null;
|
|
8292
|
-
/** @description Unique URL-safe identifier for the entity. */
|
|
8293
|
-
Slug?: string | null;
|
|
8294
|
-
ToolchainType?: string | null;
|
|
8295
|
-
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
8296
|
-
Version?: number | null;
|
|
8297
|
-
};
|
|
8298
|
-
};
|
|
8299
|
-
};
|
|
8644
|
+
requestBody?: never;
|
|
8300
8645
|
responses: {
|
|
8301
8646
|
/** @description OK */
|
|
8302
8647
|
200: {
|
|
@@ -8304,16 +8649,7 @@ interface operations {
|
|
|
8304
8649
|
[name: string]: unknown;
|
|
8305
8650
|
};
|
|
8306
8651
|
content: {
|
|
8307
|
-
"application/json": components["schemas"]["
|
|
8308
|
-
};
|
|
8309
|
-
};
|
|
8310
|
-
/** @description Multi-Status (partial success) */
|
|
8311
|
-
207: {
|
|
8312
|
-
headers: {
|
|
8313
|
-
[name: string]: unknown;
|
|
8314
|
-
};
|
|
8315
|
-
content: {
|
|
8316
|
-
"application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][];
|
|
8652
|
+
"application/json": components["schemas"]["ExtendedAttribute"][];
|
|
8317
8653
|
};
|
|
8318
8654
|
};
|
|
8319
8655
|
/** @description Attribute request is invalid (Bad Request). */
|
|
@@ -8352,15 +8688,6 @@ interface operations {
|
|
|
8352
8688
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8353
8689
|
};
|
|
8354
8690
|
};
|
|
8355
|
-
/** @description Attribute data conflict. Data has changed since last read. */
|
|
8356
|
-
409: {
|
|
8357
|
-
headers: {
|
|
8358
|
-
[name: string]: unknown;
|
|
8359
|
-
};
|
|
8360
|
-
content: {
|
|
8361
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8362
|
-
};
|
|
8363
|
-
};
|
|
8364
8691
|
/** @description Something went wrong while processing Attribute. */
|
|
8365
8692
|
500: {
|
|
8366
8693
|
headers: {
|
|
@@ -8381,7 +8708,7 @@ interface operations {
|
|
|
8381
8708
|
};
|
|
8382
8709
|
};
|
|
8383
8710
|
};
|
|
8384
|
-
|
|
8711
|
+
BulkCreateAttributes: {
|
|
8385
8712
|
parameters: {
|
|
8386
8713
|
query?: {
|
|
8387
8714
|
/**
|
|
@@ -8466,12 +8793,100 @@ interface operations {
|
|
|
8466
8793
|
* The whole string must be query-encoded.
|
|
8467
8794
|
*/
|
|
8468
8795
|
include?: string;
|
|
8796
|
+
/** @description Comma-separated list of prefixes to apply to cloned Attribute names */
|
|
8797
|
+
name_prefixes?: string;
|
|
8798
|
+
/**
|
|
8799
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
8800
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
8801
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
8802
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
8803
|
+
* as in the JSON encoding.
|
|
8804
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
8805
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
8806
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
8807
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
8808
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
8809
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
8810
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
8811
|
+
* UUID and time literals must be quoted as string literals.
|
|
8812
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
8813
|
+
* Time literals use the same form as when serialized as JSON,
|
|
8814
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
8815
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
8816
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
8817
|
+
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
8818
|
+
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
8819
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
8820
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
8821
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
8822
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
8823
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
8824
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
8825
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
8826
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
8827
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
8828
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
8829
|
+
* Conjunctions are supported using the `AND` operator.
|
|
8830
|
+
* An example conjunction is:
|
|
8831
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8832
|
+
*
|
|
8833
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt.
|
|
8834
|
+
*
|
|
8835
|
+
* Where expression to select destination spaces for cloning attributes
|
|
8836
|
+
*
|
|
8837
|
+
* The whole string must be query-encoded.
|
|
8838
|
+
*/
|
|
8839
|
+
where_space?: string;
|
|
8840
|
+
/**
|
|
8841
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
8842
|
+
*
|
|
8843
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
8844
|
+
*
|
|
8845
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
8846
|
+
*
|
|
8847
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
8848
|
+
*
|
|
8849
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
8850
|
+
*
|
|
8851
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
8852
|
+
*/
|
|
8853
|
+
filter_space?: string;
|
|
8854
|
+
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
8855
|
+
allow_exists?: string;
|
|
8469
8856
|
};
|
|
8470
8857
|
header?: never;
|
|
8471
8858
|
path?: never;
|
|
8472
8859
|
cookie?: never;
|
|
8473
8860
|
};
|
|
8474
|
-
requestBody?:
|
|
8861
|
+
requestBody?: {
|
|
8862
|
+
content: {
|
|
8863
|
+
"application/merge-patch+json": {
|
|
8864
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
8865
|
+
Annotations?: {
|
|
8866
|
+
[key: string]: string | null;
|
|
8867
|
+
} | null;
|
|
8868
|
+
DataType?: string | null;
|
|
8869
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
8870
|
+
DeleteGates?: {
|
|
8871
|
+
[key: string]: boolean | null;
|
|
8872
|
+
} | null;
|
|
8873
|
+
Description?: string | null;
|
|
8874
|
+
/** @description Friendly name for the entity. */
|
|
8875
|
+
DisplayName?: string | null;
|
|
8876
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
8877
|
+
Labels?: {
|
|
8878
|
+
[key: string]: string | null;
|
|
8879
|
+
} | null;
|
|
8880
|
+
Parameters?: (Record<string, never> | null)[] | null;
|
|
8881
|
+
ResourceTypePaths?: (Record<string, never> | null)[] | null;
|
|
8882
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
8883
|
+
Slug?: string | null;
|
|
8884
|
+
ToolchainType?: string | null;
|
|
8885
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
8886
|
+
Version?: number | null;
|
|
8887
|
+
};
|
|
8888
|
+
};
|
|
8889
|
+
};
|
|
8475
8890
|
responses: {
|
|
8476
8891
|
/** @description OK */
|
|
8477
8892
|
200: {
|
|
@@ -8479,16 +8894,16 @@ interface operations {
|
|
|
8479
8894
|
[name: string]: unknown;
|
|
8480
8895
|
};
|
|
8481
8896
|
content: {
|
|
8482
|
-
"application/json": components["schemas"]["
|
|
8897
|
+
"application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][];
|
|
8483
8898
|
};
|
|
8484
8899
|
};
|
|
8485
|
-
/** @description Multi-Status
|
|
8900
|
+
/** @description Multi-Status (partial success) */
|
|
8486
8901
|
207: {
|
|
8487
8902
|
headers: {
|
|
8488
8903
|
[name: string]: unknown;
|
|
8489
8904
|
};
|
|
8490
8905
|
content: {
|
|
8491
|
-
"application/json": components["schemas"]["
|
|
8906
|
+
"application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][];
|
|
8492
8907
|
};
|
|
8493
8908
|
};
|
|
8494
8909
|
/** @description Attribute request is invalid (Bad Request). */
|
|
@@ -8527,7 +8942,7 @@ interface operations {
|
|
|
8527
8942
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8528
8943
|
};
|
|
8529
8944
|
};
|
|
8530
|
-
/** @description Attribute
|
|
8945
|
+
/** @description Attribute data conflict. Data has changed since last read. */
|
|
8531
8946
|
409: {
|
|
8532
8947
|
headers: {
|
|
8533
8948
|
[name: string]: unknown;
|
|
@@ -8536,15 +8951,6 @@ interface operations {
|
|
|
8536
8951
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8537
8952
|
};
|
|
8538
8953
|
};
|
|
8539
|
-
/** @description Unable to delete entity */
|
|
8540
|
-
422: {
|
|
8541
|
-
headers: {
|
|
8542
|
-
[name: string]: unknown;
|
|
8543
|
-
};
|
|
8544
|
-
content: {
|
|
8545
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8546
|
-
};
|
|
8547
|
-
};
|
|
8548
8954
|
/** @description Something went wrong while processing Attribute. */
|
|
8549
8955
|
500: {
|
|
8550
8956
|
headers: {
|
|
@@ -8565,7 +8971,7 @@ interface operations {
|
|
|
8565
8971
|
};
|
|
8566
8972
|
};
|
|
8567
8973
|
};
|
|
8568
|
-
|
|
8974
|
+
BulkDeleteAttributes: {
|
|
8569
8975
|
parameters: {
|
|
8570
8976
|
query?: {
|
|
8571
8977
|
/**
|
|
@@ -8655,35 +9061,7 @@ interface operations {
|
|
|
8655
9061
|
path?: never;
|
|
8656
9062
|
cookie?: never;
|
|
8657
9063
|
};
|
|
8658
|
-
requestBody?:
|
|
8659
|
-
content: {
|
|
8660
|
-
"application/merge-patch+json": {
|
|
8661
|
-
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
8662
|
-
Annotations?: {
|
|
8663
|
-
[key: string]: string | null;
|
|
8664
|
-
} | null;
|
|
8665
|
-
DataType?: string | null;
|
|
8666
|
-
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
8667
|
-
DeleteGates?: {
|
|
8668
|
-
[key: string]: boolean | null;
|
|
8669
|
-
} | null;
|
|
8670
|
-
Description?: string | null;
|
|
8671
|
-
/** @description Friendly name for the entity. */
|
|
8672
|
-
DisplayName?: string | null;
|
|
8673
|
-
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
8674
|
-
Labels?: {
|
|
8675
|
-
[key: string]: string | null;
|
|
8676
|
-
} | null;
|
|
8677
|
-
Parameters?: (Record<string, never> | null)[] | null;
|
|
8678
|
-
ResourceTypePaths?: (Record<string, never> | null)[] | null;
|
|
8679
|
-
/** @description Unique URL-safe identifier for the entity. */
|
|
8680
|
-
Slug?: string | null;
|
|
8681
|
-
ToolchainType?: string | null;
|
|
8682
|
-
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
8683
|
-
Version?: number | null;
|
|
8684
|
-
};
|
|
8685
|
-
};
|
|
8686
|
-
};
|
|
9064
|
+
requestBody?: never;
|
|
8687
9065
|
responses: {
|
|
8688
9066
|
/** @description OK */
|
|
8689
9067
|
200: {
|
|
@@ -8691,7 +9069,7 @@ interface operations {
|
|
|
8691
9069
|
[name: string]: unknown;
|
|
8692
9070
|
};
|
|
8693
9071
|
content: {
|
|
8694
|
-
"application/json": components["schemas"]["
|
|
9072
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
8695
9073
|
};
|
|
8696
9074
|
};
|
|
8697
9075
|
/** @description Multi-Status: Mixed success and failure results */
|
|
@@ -8700,7 +9078,7 @@ interface operations {
|
|
|
8700
9078
|
[name: string]: unknown;
|
|
8701
9079
|
};
|
|
8702
9080
|
content: {
|
|
8703
|
-
"application/json": components["schemas"]["
|
|
9081
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
8704
9082
|
};
|
|
8705
9083
|
};
|
|
8706
9084
|
/** @description Attribute request is invalid (Bad Request). */
|
|
@@ -8739,7 +9117,7 @@ interface operations {
|
|
|
8739
9117
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8740
9118
|
};
|
|
8741
9119
|
};
|
|
8742
|
-
/** @description Attribute
|
|
9120
|
+
/** @description Attribute is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
8743
9121
|
409: {
|
|
8744
9122
|
headers: {
|
|
8745
9123
|
[name: string]: unknown;
|
|
@@ -8748,6 +9126,15 @@ interface operations {
|
|
|
8748
9126
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
8749
9127
|
};
|
|
8750
9128
|
};
|
|
9129
|
+
/** @description Unable to delete entity */
|
|
9130
|
+
422: {
|
|
9131
|
+
headers: {
|
|
9132
|
+
[name: string]: unknown;
|
|
9133
|
+
};
|
|
9134
|
+
content: {
|
|
9135
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9136
|
+
};
|
|
9137
|
+
};
|
|
8751
9138
|
/** @description Something went wrong while processing Attribute. */
|
|
8752
9139
|
500: {
|
|
8753
9140
|
headers: {
|
|
@@ -8768,7 +9155,7 @@ interface operations {
|
|
|
8768
9155
|
};
|
|
8769
9156
|
};
|
|
8770
9157
|
};
|
|
8771
|
-
|
|
9158
|
+
BulkPatchAttributes: {
|
|
8772
9159
|
parameters: {
|
|
8773
9160
|
query?: {
|
|
8774
9161
|
/**
|
|
@@ -8853,8 +9240,6 @@ interface operations {
|
|
|
8853
9240
|
* The whole string must be query-encoded.
|
|
8854
9241
|
*/
|
|
8855
9242
|
include?: string;
|
|
8856
|
-
/** @description Report what the move would do, and what would stop it, without moving anything */
|
|
8857
|
-
dry_run?: boolean;
|
|
8858
9243
|
};
|
|
8859
9244
|
header?: never;
|
|
8860
9245
|
path?: never;
|
|
@@ -8862,7 +9247,31 @@ interface operations {
|
|
|
8862
9247
|
};
|
|
8863
9248
|
requestBody?: {
|
|
8864
9249
|
content: {
|
|
8865
|
-
"application/json":
|
|
9250
|
+
"application/merge-patch+json": {
|
|
9251
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
9252
|
+
Annotations?: {
|
|
9253
|
+
[key: string]: string | null;
|
|
9254
|
+
} | null;
|
|
9255
|
+
DataType?: string | null;
|
|
9256
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
9257
|
+
DeleteGates?: {
|
|
9258
|
+
[key: string]: boolean | null;
|
|
9259
|
+
} | null;
|
|
9260
|
+
Description?: string | null;
|
|
9261
|
+
/** @description Friendly name for the entity. */
|
|
9262
|
+
DisplayName?: string | null;
|
|
9263
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
9264
|
+
Labels?: {
|
|
9265
|
+
[key: string]: string | null;
|
|
9266
|
+
} | null;
|
|
9267
|
+
Parameters?: (Record<string, never> | null)[] | null;
|
|
9268
|
+
ResourceTypePaths?: (Record<string, never> | null)[] | null;
|
|
9269
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
9270
|
+
Slug?: string | null;
|
|
9271
|
+
ToolchainType?: string | null;
|
|
9272
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
9273
|
+
Version?: number | null;
|
|
9274
|
+
};
|
|
8866
9275
|
};
|
|
8867
9276
|
};
|
|
8868
9277
|
responses: {
|
|
@@ -8872,16 +9281,16 @@ interface operations {
|
|
|
8872
9281
|
[name: string]: unknown;
|
|
8873
9282
|
};
|
|
8874
9283
|
content: {
|
|
8875
|
-
"application/json": components["schemas"]["
|
|
9284
|
+
"application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][];
|
|
8876
9285
|
};
|
|
8877
9286
|
};
|
|
8878
|
-
/** @description Multi-Status:
|
|
9287
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
8879
9288
|
207: {
|
|
8880
9289
|
headers: {
|
|
8881
9290
|
[name: string]: unknown;
|
|
8882
9291
|
};
|
|
8883
9292
|
content: {
|
|
8884
|
-
"application/json": components["schemas"]["
|
|
9293
|
+
"application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][];
|
|
8885
9294
|
};
|
|
8886
9295
|
};
|
|
8887
9296
|
/** @description Attribute request is invalid (Bad Request). */
|
|
@@ -8949,12 +9358,12 @@ interface operations {
|
|
|
8949
9358
|
};
|
|
8950
9359
|
};
|
|
8951
9360
|
};
|
|
8952
|
-
|
|
9361
|
+
BulkMoveAttributes: {
|
|
8953
9362
|
parameters: {
|
|
8954
9363
|
query?: {
|
|
8955
9364
|
/**
|
|
8956
9365
|
* @description The specified string is an expression for the purpose of filtering
|
|
8957
|
-
* the list of
|
|
9366
|
+
* the list of Attributes returned. The expression syntax was inspired by SQL.
|
|
8958
9367
|
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
8959
9368
|
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
8960
9369
|
* as in the JSON encoding.
|
|
@@ -8987,17 +9396,17 @@ interface operations {
|
|
|
8987
9396
|
* An example conjunction is:
|
|
8988
9397
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8989
9398
|
*
|
|
8990
|
-
* Supported attributes for filtering on
|
|
9399
|
+
* Supported attributes for filtering on Attribute: Annotations, AttributeID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, Labels, OrganizationID, Parameters, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt.
|
|
8991
9400
|
*
|
|
8992
9401
|
* The whole string must be query-encoded.
|
|
8993
9402
|
*/
|
|
8994
9403
|
where?: string;
|
|
8995
9404
|
/**
|
|
8996
|
-
* @description UUID of a Filter entity to apply to the
|
|
9405
|
+
* @description UUID of a Filter entity to apply to the Attribute list.
|
|
8997
9406
|
*
|
|
8998
9407
|
* The Filter must be in the same Organization as the user credentials.
|
|
8999
9408
|
*
|
|
9000
|
-
* The Filter's From field must match the entity type being filtered (
|
|
9409
|
+
* The Filter's From field must match the entity type being filtered (Attribute).
|
|
9001
9410
|
*
|
|
9002
9411
|
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
9003
9412
|
*
|
|
@@ -9019,40 +9428,33 @@ interface operations {
|
|
|
9019
9428
|
*
|
|
9020
9429
|
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
9021
9430
|
*
|
|
9022
|
-
* Searchable fields for
|
|
9431
|
+
* Searchable fields for Attribute include string and map-type attributes from the queryable attributes list.
|
|
9023
9432
|
*
|
|
9024
9433
|
* The whole string must be query-encoded.
|
|
9025
9434
|
*/
|
|
9026
9435
|
contains?: string;
|
|
9027
9436
|
/**
|
|
9028
|
-
* @description Include clause for expanding related entities in the response for
|
|
9437
|
+
* @description Include clause for expanding related entities in the response for Attribute.
|
|
9029
9438
|
* The attribute names are case-sensitive, PascalCase, and
|
|
9030
9439
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
9031
9440
|
*
|
|
9032
|
-
* Supported attributes for
|
|
9441
|
+
* Supported attributes for Attribute are OrganizationID, SpaceID.
|
|
9033
9442
|
*
|
|
9034
9443
|
* The whole string must be query-encoded.
|
|
9035
9444
|
*/
|
|
9036
9445
|
include?: string;
|
|
9037
|
-
/**
|
|
9038
|
-
|
|
9039
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
9040
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
9041
|
-
* If not specified, all fields are returned.
|
|
9042
|
-
* Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
|
|
9043
|
-
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
9044
|
-
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
9045
|
-
* The whole string must be query-encoded.
|
|
9046
|
-
*/
|
|
9047
|
-
select?: string;
|
|
9048
|
-
/** @description Include summary information in the response */
|
|
9049
|
-
summary?: boolean;
|
|
9446
|
+
/** @description Report what the move would do, and what would stop it, without moving anything */
|
|
9447
|
+
dry_run?: boolean;
|
|
9050
9448
|
};
|
|
9051
9449
|
header?: never;
|
|
9052
9450
|
path?: never;
|
|
9053
9451
|
cookie?: never;
|
|
9054
9452
|
};
|
|
9055
|
-
requestBody?:
|
|
9453
|
+
requestBody?: {
|
|
9454
|
+
content: {
|
|
9455
|
+
"application/json": components["schemas"]["MoveRequest"];
|
|
9456
|
+
};
|
|
9457
|
+
};
|
|
9056
9458
|
responses: {
|
|
9057
9459
|
/** @description OK */
|
|
9058
9460
|
200: {
|
|
@@ -9060,12 +9462,84 @@ interface operations {
|
|
|
9060
9462
|
[name: string]: unknown;
|
|
9061
9463
|
};
|
|
9062
9464
|
content: {
|
|
9063
|
-
"application/json": components["schemas"]["
|
|
9465
|
+
"application/json": components["schemas"]["MoveResponse"][];
|
|
9466
|
+
};
|
|
9467
|
+
};
|
|
9468
|
+
/** @description Multi-Status: nothing was moved, or some moved and others did not */
|
|
9469
|
+
207: {
|
|
9470
|
+
headers: {
|
|
9471
|
+
[name: string]: unknown;
|
|
9472
|
+
};
|
|
9473
|
+
content: {
|
|
9474
|
+
"application/json": components["schemas"]["MoveResponse"][];
|
|
9475
|
+
};
|
|
9476
|
+
};
|
|
9477
|
+
/** @description Attribute request is invalid (Bad Request). */
|
|
9478
|
+
400: {
|
|
9479
|
+
headers: {
|
|
9480
|
+
[name: string]: unknown;
|
|
9481
|
+
};
|
|
9482
|
+
content: {
|
|
9483
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9484
|
+
};
|
|
9485
|
+
};
|
|
9486
|
+
/** @description Unauthorized access. */
|
|
9487
|
+
401: {
|
|
9488
|
+
headers: {
|
|
9489
|
+
[name: string]: unknown;
|
|
9490
|
+
};
|
|
9491
|
+
content: {
|
|
9492
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9493
|
+
};
|
|
9494
|
+
};
|
|
9495
|
+
/** @description Forbidden access. */
|
|
9496
|
+
403: {
|
|
9497
|
+
headers: {
|
|
9498
|
+
[name: string]: unknown;
|
|
9499
|
+
};
|
|
9500
|
+
content: {
|
|
9501
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9502
|
+
};
|
|
9503
|
+
};
|
|
9504
|
+
/** @description Attribute not found. */
|
|
9505
|
+
404: {
|
|
9506
|
+
headers: {
|
|
9507
|
+
[name: string]: unknown;
|
|
9508
|
+
};
|
|
9509
|
+
content: {
|
|
9510
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9511
|
+
};
|
|
9512
|
+
};
|
|
9513
|
+
/** @description Attribute data conflict. Data has changed since last read. */
|
|
9514
|
+
409: {
|
|
9515
|
+
headers: {
|
|
9516
|
+
[name: string]: unknown;
|
|
9517
|
+
};
|
|
9518
|
+
content: {
|
|
9519
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9520
|
+
};
|
|
9521
|
+
};
|
|
9522
|
+
/** @description Something went wrong while processing Attribute. */
|
|
9523
|
+
500: {
|
|
9524
|
+
headers: {
|
|
9525
|
+
[name: string]: unknown;
|
|
9526
|
+
};
|
|
9527
|
+
content: {
|
|
9528
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9529
|
+
};
|
|
9530
|
+
};
|
|
9531
|
+
/** @description Unexpected error. */
|
|
9532
|
+
default: {
|
|
9533
|
+
headers: {
|
|
9534
|
+
[name: string]: unknown;
|
|
9535
|
+
};
|
|
9536
|
+
content: {
|
|
9537
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9064
9538
|
};
|
|
9065
9539
|
};
|
|
9066
9540
|
};
|
|
9067
9541
|
};
|
|
9068
|
-
|
|
9542
|
+
ListAllBridgeWorkers: {
|
|
9069
9543
|
parameters: {
|
|
9070
9544
|
query?: {
|
|
9071
9545
|
/**
|
|
@@ -9150,8 +9624,19 @@ interface operations {
|
|
|
9150
9624
|
* The whole string must be query-encoded.
|
|
9151
9625
|
*/
|
|
9152
9626
|
include?: string;
|
|
9153
|
-
/**
|
|
9154
|
-
|
|
9627
|
+
/**
|
|
9628
|
+
* @description Select clause for specifying which fields to include in the response for BridgeWorker.
|
|
9629
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
9630
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
9631
|
+
* If not specified, all fields are returned.
|
|
9632
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, BridgeWorkerID) and Slug are always returned regardless of the select parameter.
|
|
9633
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
9634
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
9635
|
+
* The whole string must be query-encoded.
|
|
9636
|
+
*/
|
|
9637
|
+
select?: string;
|
|
9638
|
+
/** @description Include summary information in the response */
|
|
9639
|
+
summary?: boolean;
|
|
9155
9640
|
};
|
|
9156
9641
|
header?: never;
|
|
9157
9642
|
path?: never;
|
|
@@ -9165,93 +9650,198 @@ interface operations {
|
|
|
9165
9650
|
[name: string]: unknown;
|
|
9166
9651
|
};
|
|
9167
9652
|
content: {
|
|
9168
|
-
"application/json": components["schemas"]["
|
|
9169
|
-
};
|
|
9170
|
-
};
|
|
9171
|
-
/** @description Multi-Status: Mixed success and failure results */
|
|
9172
|
-
207: {
|
|
9173
|
-
headers: {
|
|
9174
|
-
[name: string]: unknown;
|
|
9175
|
-
};
|
|
9176
|
-
content: {
|
|
9177
|
-
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9178
|
-
};
|
|
9179
|
-
};
|
|
9180
|
-
/** @description BridgeWorker request is invalid (Bad Request). */
|
|
9181
|
-
400: {
|
|
9182
|
-
headers: {
|
|
9183
|
-
[name: string]: unknown;
|
|
9184
|
-
};
|
|
9185
|
-
content: {
|
|
9186
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9187
|
-
};
|
|
9188
|
-
};
|
|
9189
|
-
/** @description Unauthorized access. */
|
|
9190
|
-
401: {
|
|
9191
|
-
headers: {
|
|
9192
|
-
[name: string]: unknown;
|
|
9193
|
-
};
|
|
9194
|
-
content: {
|
|
9195
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9196
|
-
};
|
|
9197
|
-
};
|
|
9198
|
-
/** @description Forbidden access. */
|
|
9199
|
-
403: {
|
|
9200
|
-
headers: {
|
|
9201
|
-
[name: string]: unknown;
|
|
9202
|
-
};
|
|
9203
|
-
content: {
|
|
9204
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9205
|
-
};
|
|
9206
|
-
};
|
|
9207
|
-
/** @description BridgeWorker not found. */
|
|
9208
|
-
404: {
|
|
9209
|
-
headers: {
|
|
9210
|
-
[name: string]: unknown;
|
|
9211
|
-
};
|
|
9212
|
-
content: {
|
|
9213
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9214
|
-
};
|
|
9215
|
-
};
|
|
9216
|
-
/** @description BridgeWorker is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
9217
|
-
409: {
|
|
9218
|
-
headers: {
|
|
9219
|
-
[name: string]: unknown;
|
|
9220
|
-
};
|
|
9221
|
-
content: {
|
|
9222
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9223
|
-
};
|
|
9224
|
-
};
|
|
9225
|
-
/** @description BridgeWorker could not be deleted. */
|
|
9226
|
-
422: {
|
|
9227
|
-
headers: {
|
|
9228
|
-
[name: string]: unknown;
|
|
9229
|
-
};
|
|
9230
|
-
content: {
|
|
9231
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9232
|
-
};
|
|
9233
|
-
};
|
|
9234
|
-
/** @description Something went wrong while processing BridgeWorker. */
|
|
9235
|
-
500: {
|
|
9236
|
-
headers: {
|
|
9237
|
-
[name: string]: unknown;
|
|
9238
|
-
};
|
|
9239
|
-
content: {
|
|
9240
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9241
|
-
};
|
|
9242
|
-
};
|
|
9243
|
-
/** @description Unexpected error. */
|
|
9244
|
-
default: {
|
|
9245
|
-
headers: {
|
|
9246
|
-
[name: string]: unknown;
|
|
9247
|
-
};
|
|
9248
|
-
content: {
|
|
9249
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9653
|
+
"application/json": components["schemas"]["ExtendedBridgeWorker"][];
|
|
9250
9654
|
};
|
|
9251
9655
|
};
|
|
9252
9656
|
};
|
|
9253
9657
|
};
|
|
9254
|
-
|
|
9658
|
+
BulkDeleteBridgeWorkers: {
|
|
9659
|
+
parameters: {
|
|
9660
|
+
query?: {
|
|
9661
|
+
/**
|
|
9662
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
9663
|
+
* the list of BridgeWorkers returned. The expression syntax was inspired by SQL.
|
|
9664
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
9665
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
9666
|
+
* as in the JSON encoding.
|
|
9667
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
9668
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
9669
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
9670
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
9671
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
9672
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
9673
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
9674
|
+
* UUID and time literals must be quoted as string literals.
|
|
9675
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
9676
|
+
* Time literals use the same form as when serialized as JSON,
|
|
9677
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
9678
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
9679
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
9680
|
+
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
9681
|
+
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
9682
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
9683
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
9684
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
9685
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
9686
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
9687
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
9688
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
9689
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
9690
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
9691
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
9692
|
+
* Conjunctions are supported using the `AND` operator.
|
|
9693
|
+
* An example conjunction is:
|
|
9694
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9695
|
+
*
|
|
9696
|
+
* Supported attributes for filtering on BridgeWorker: Annotations, BridgeWorkerID, Condition, CreatedAt, DisplayName, IPAddress, Labels, LastMessage, LastSeenAt, OrgRole, OrganizationID, Permissions, ProvidedInfo, Slug, SpaceID, UpdatedAt, UserID.
|
|
9697
|
+
*
|
|
9698
|
+
* The whole string must be query-encoded.
|
|
9699
|
+
*/
|
|
9700
|
+
where?: string;
|
|
9701
|
+
/**
|
|
9702
|
+
* @description UUID of a Filter entity to apply to the BridgeWorker list.
|
|
9703
|
+
*
|
|
9704
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
9705
|
+
*
|
|
9706
|
+
* The Filter's From field must match the entity type being filtered (BridgeWorker).
|
|
9707
|
+
*
|
|
9708
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
9709
|
+
*
|
|
9710
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
9711
|
+
*
|
|
9712
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
9713
|
+
*/
|
|
9714
|
+
filter?: string;
|
|
9715
|
+
/**
|
|
9716
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
9717
|
+
*
|
|
9718
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
9719
|
+
*
|
|
9720
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
9721
|
+
*
|
|
9722
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
9723
|
+
*
|
|
9724
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
9725
|
+
*
|
|
9726
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
9727
|
+
*
|
|
9728
|
+
* Searchable fields for BridgeWorker include string and map-type attributes from the queryable attributes list.
|
|
9729
|
+
*
|
|
9730
|
+
* The whole string must be query-encoded.
|
|
9731
|
+
*/
|
|
9732
|
+
contains?: string;
|
|
9733
|
+
/**
|
|
9734
|
+
* @description Include clause for expanding related entities in the response for BridgeWorker.
|
|
9735
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
9736
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
9737
|
+
*
|
|
9738
|
+
* Supported attributes for BridgeWorker are OrganizationID, SpaceID.
|
|
9739
|
+
*
|
|
9740
|
+
* The whole string must be query-encoded.
|
|
9741
|
+
*/
|
|
9742
|
+
include?: string;
|
|
9743
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
9744
|
+
detach?: boolean;
|
|
9745
|
+
};
|
|
9746
|
+
header?: never;
|
|
9747
|
+
path?: never;
|
|
9748
|
+
cookie?: never;
|
|
9749
|
+
};
|
|
9750
|
+
requestBody?: never;
|
|
9751
|
+
responses: {
|
|
9752
|
+
/** @description OK */
|
|
9753
|
+
200: {
|
|
9754
|
+
headers: {
|
|
9755
|
+
[name: string]: unknown;
|
|
9756
|
+
};
|
|
9757
|
+
content: {
|
|
9758
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9759
|
+
};
|
|
9760
|
+
};
|
|
9761
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
9762
|
+
207: {
|
|
9763
|
+
headers: {
|
|
9764
|
+
[name: string]: unknown;
|
|
9765
|
+
};
|
|
9766
|
+
content: {
|
|
9767
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9768
|
+
};
|
|
9769
|
+
};
|
|
9770
|
+
/** @description BridgeWorker request is invalid (Bad Request). */
|
|
9771
|
+
400: {
|
|
9772
|
+
headers: {
|
|
9773
|
+
[name: string]: unknown;
|
|
9774
|
+
};
|
|
9775
|
+
content: {
|
|
9776
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9777
|
+
};
|
|
9778
|
+
};
|
|
9779
|
+
/** @description Unauthorized access. */
|
|
9780
|
+
401: {
|
|
9781
|
+
headers: {
|
|
9782
|
+
[name: string]: unknown;
|
|
9783
|
+
};
|
|
9784
|
+
content: {
|
|
9785
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9786
|
+
};
|
|
9787
|
+
};
|
|
9788
|
+
/** @description Forbidden access. */
|
|
9789
|
+
403: {
|
|
9790
|
+
headers: {
|
|
9791
|
+
[name: string]: unknown;
|
|
9792
|
+
};
|
|
9793
|
+
content: {
|
|
9794
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9795
|
+
};
|
|
9796
|
+
};
|
|
9797
|
+
/** @description BridgeWorker not found. */
|
|
9798
|
+
404: {
|
|
9799
|
+
headers: {
|
|
9800
|
+
[name: string]: unknown;
|
|
9801
|
+
};
|
|
9802
|
+
content: {
|
|
9803
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9804
|
+
};
|
|
9805
|
+
};
|
|
9806
|
+
/** @description BridgeWorker is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
9807
|
+
409: {
|
|
9808
|
+
headers: {
|
|
9809
|
+
[name: string]: unknown;
|
|
9810
|
+
};
|
|
9811
|
+
content: {
|
|
9812
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9813
|
+
};
|
|
9814
|
+
};
|
|
9815
|
+
/** @description BridgeWorker could not be deleted. */
|
|
9816
|
+
422: {
|
|
9817
|
+
headers: {
|
|
9818
|
+
[name: string]: unknown;
|
|
9819
|
+
};
|
|
9820
|
+
content: {
|
|
9821
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9822
|
+
};
|
|
9823
|
+
};
|
|
9824
|
+
/** @description Something went wrong while processing BridgeWorker. */
|
|
9825
|
+
500: {
|
|
9826
|
+
headers: {
|
|
9827
|
+
[name: string]: unknown;
|
|
9828
|
+
};
|
|
9829
|
+
content: {
|
|
9830
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9831
|
+
};
|
|
9832
|
+
};
|
|
9833
|
+
/** @description Unexpected error. */
|
|
9834
|
+
default: {
|
|
9835
|
+
headers: {
|
|
9836
|
+
[name: string]: unknown;
|
|
9837
|
+
};
|
|
9838
|
+
content: {
|
|
9839
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9840
|
+
};
|
|
9841
|
+
};
|
|
9842
|
+
};
|
|
9843
|
+
};
|
|
9844
|
+
BulkPatchBridgeWorkers: {
|
|
9255
9845
|
parameters: {
|
|
9256
9846
|
query?: {
|
|
9257
9847
|
/**
|
|
@@ -11659,7 +12249,7 @@ interface operations {
|
|
|
11659
12249
|
* An example conjunction is:
|
|
11660
12250
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11661
12251
|
*
|
|
11662
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12252
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
11663
12253
|
*
|
|
11664
12254
|
* The whole string must be query-encoded.
|
|
11665
12255
|
*/
|
|
@@ -11827,7 +12417,7 @@ interface operations {
|
|
|
11827
12417
|
* An example conjunction is:
|
|
11828
12418
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11829
12419
|
*
|
|
11830
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12420
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
11831
12421
|
*
|
|
11832
12422
|
* The whole string must be query-encoded.
|
|
11833
12423
|
*/
|
|
@@ -11950,6 +12540,8 @@ interface operations {
|
|
|
11950
12540
|
Annotations?: {
|
|
11951
12541
|
[key: string]: string | null;
|
|
11952
12542
|
} | null;
|
|
12543
|
+
/** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */
|
|
12544
|
+
AttestationPrerequisites?: (Record<string, never> | null)[] | null;
|
|
11953
12545
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
11954
12546
|
CustomPrerequisites?: (Record<string, never> | null)[] | null;
|
|
11955
12547
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
@@ -12095,7 +12687,7 @@ interface operations {
|
|
|
12095
12687
|
* An example conjunction is:
|
|
12096
12688
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12097
12689
|
*
|
|
12098
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12690
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12099
12691
|
*
|
|
12100
12692
|
* The whole string must be query-encoded.
|
|
12101
12693
|
*/
|
|
@@ -12279,7 +12871,7 @@ interface operations {
|
|
|
12279
12871
|
* An example conjunction is:
|
|
12280
12872
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12281
12873
|
*
|
|
12282
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12874
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12283
12875
|
*
|
|
12284
12876
|
* The whole string must be query-encoded.
|
|
12285
12877
|
*/
|
|
@@ -12338,6 +12930,8 @@ interface operations {
|
|
|
12338
12930
|
Annotations?: {
|
|
12339
12931
|
[key: string]: string | null;
|
|
12340
12932
|
} | null;
|
|
12933
|
+
/** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */
|
|
12934
|
+
AttestationPrerequisites?: (Record<string, never> | null)[] | null;
|
|
12341
12935
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
12342
12936
|
CustomPrerequisites?: (Record<string, never> | null)[] | null;
|
|
12343
12937
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
@@ -12483,7 +13077,7 @@ interface operations {
|
|
|
12483
13077
|
* An example conjunction is:
|
|
12484
13078
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12485
13079
|
*
|
|
12486
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
13080
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
12487
13081
|
*
|
|
12488
13082
|
* The whole string must be query-encoded.
|
|
12489
13083
|
*/
|
|
@@ -18492,7 +19086,7 @@ interface operations {
|
|
|
18492
19086
|
* An example conjunction is:
|
|
18493
19087
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18494
19088
|
*
|
|
18495
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19089
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18496
19090
|
*
|
|
18497
19091
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
18498
19092
|
*
|
|
@@ -18536,7 +19130,7 @@ interface operations {
|
|
|
18536
19130
|
* The attribute names are case-sensitive, PascalCase, and
|
|
18537
19131
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
18538
19132
|
*
|
|
18539
|
-
* Supported attributes for Revision are ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
19133
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
18540
19134
|
*
|
|
18541
19135
|
* The whole string must be query-encoded.
|
|
18542
19136
|
*/
|
|
@@ -18561,7 +19155,7 @@ interface operations {
|
|
|
18561
19155
|
*
|
|
18562
19156
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
18563
19157
|
*
|
|
18564
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19158
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18565
19159
|
*
|
|
18566
19160
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
18567
19161
|
*
|
|
@@ -18690,7 +19284,7 @@ interface operations {
|
|
|
18690
19284
|
* An example conjunction is:
|
|
18691
19285
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18692
19286
|
*
|
|
18693
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19287
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18694
19288
|
*
|
|
18695
19289
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
18696
19290
|
*
|
|
@@ -18734,7 +19328,7 @@ interface operations {
|
|
|
18734
19328
|
* The attribute names are case-sensitive, PascalCase, and
|
|
18735
19329
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
18736
19330
|
*
|
|
18737
|
-
* Supported attributes for Revision are ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
19331
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
18738
19332
|
*
|
|
18739
19333
|
* The whole string must be query-encoded.
|
|
18740
19334
|
*/
|
|
@@ -18759,7 +19353,7 @@ interface operations {
|
|
|
18759
19353
|
*
|
|
18760
19354
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
18761
19355
|
*
|
|
18762
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19356
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18763
19357
|
*
|
|
18764
19358
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
18765
19359
|
*
|
|
@@ -18888,7 +19482,7 @@ interface operations {
|
|
|
18888
19482
|
* An example conjunction is:
|
|
18889
19483
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18890
19484
|
*
|
|
18891
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19485
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18892
19486
|
*
|
|
18893
19487
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
18894
19488
|
*
|
|
@@ -18932,7 +19526,7 @@ interface operations {
|
|
|
18932
19526
|
* The attribute names are case-sensitive, PascalCase, and
|
|
18933
19527
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
18934
19528
|
*
|
|
18935
|
-
* Supported attributes for Revision are ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
19529
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
18936
19530
|
*
|
|
18937
19531
|
* The whole string must be query-encoded.
|
|
18938
19532
|
*/
|
|
@@ -18957,7 +19551,7 @@ interface operations {
|
|
|
18957
19551
|
*
|
|
18958
19552
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
18959
19553
|
*
|
|
18960
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19554
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
18961
19555
|
*
|
|
18962
19556
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
18963
19557
|
*
|
|
@@ -19308,32 +19902,521 @@ interface operations {
|
|
|
19308
19902
|
};
|
|
19309
19903
|
};
|
|
19310
19904
|
};
|
|
19311
|
-
GetSpace: {
|
|
19905
|
+
GetSpace: {
|
|
19906
|
+
parameters: {
|
|
19907
|
+
query?: {
|
|
19908
|
+
/**
|
|
19909
|
+
* @description Include clause for expanding related entities in the response for Space.
|
|
19910
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
19911
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
19912
|
+
*
|
|
19913
|
+
* Supported attributes for Space are AttributeFilterID, AttributeIDs, OrganizationID, ReleaseTargetID, TriggerFilterID, TriggerIDs.
|
|
19914
|
+
*
|
|
19915
|
+
* The whole string must be query-encoded.
|
|
19916
|
+
*/
|
|
19917
|
+
include?: string;
|
|
19918
|
+
/**
|
|
19919
|
+
* @description Select clause for specifying which fields to include in the response for Space.
|
|
19920
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
19921
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
19922
|
+
* If not specified, all fields are returned.
|
|
19923
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter.
|
|
19924
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
19925
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
19926
|
+
* The whole string must be query-encoded.
|
|
19927
|
+
*/
|
|
19928
|
+
select?: string;
|
|
19929
|
+
/** @description Return summarized entity data */
|
|
19930
|
+
summary?: boolean;
|
|
19931
|
+
};
|
|
19932
|
+
header?: never;
|
|
19933
|
+
path: {
|
|
19934
|
+
/** @description Unique identifier for a space_id */
|
|
19935
|
+
space_id: string;
|
|
19936
|
+
};
|
|
19937
|
+
cookie?: never;
|
|
19938
|
+
};
|
|
19939
|
+
requestBody?: never;
|
|
19940
|
+
responses: {
|
|
19941
|
+
/** @description OK */
|
|
19942
|
+
200: {
|
|
19943
|
+
headers: {
|
|
19944
|
+
[name: string]: unknown;
|
|
19945
|
+
};
|
|
19946
|
+
content: {
|
|
19947
|
+
"application/json": components["schemas"]["ExtendedSpace"];
|
|
19948
|
+
};
|
|
19949
|
+
};
|
|
19950
|
+
/** @description Space request is invalid (Bad Request). */
|
|
19951
|
+
400: {
|
|
19952
|
+
headers: {
|
|
19953
|
+
[name: string]: unknown;
|
|
19954
|
+
};
|
|
19955
|
+
content: {
|
|
19956
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19957
|
+
};
|
|
19958
|
+
};
|
|
19959
|
+
/** @description Unauthorized access. */
|
|
19960
|
+
401: {
|
|
19961
|
+
headers: {
|
|
19962
|
+
[name: string]: unknown;
|
|
19963
|
+
};
|
|
19964
|
+
content: {
|
|
19965
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19966
|
+
};
|
|
19967
|
+
};
|
|
19968
|
+
/** @description Forbidden access. */
|
|
19969
|
+
403: {
|
|
19970
|
+
headers: {
|
|
19971
|
+
[name: string]: unknown;
|
|
19972
|
+
};
|
|
19973
|
+
content: {
|
|
19974
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19975
|
+
};
|
|
19976
|
+
};
|
|
19977
|
+
/** @description Space not found. */
|
|
19978
|
+
404: {
|
|
19979
|
+
headers: {
|
|
19980
|
+
[name: string]: unknown;
|
|
19981
|
+
};
|
|
19982
|
+
content: {
|
|
19983
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19984
|
+
};
|
|
19985
|
+
};
|
|
19986
|
+
/** @description Something went wrong while processing Space. */
|
|
19987
|
+
500: {
|
|
19988
|
+
headers: {
|
|
19989
|
+
[name: string]: unknown;
|
|
19990
|
+
};
|
|
19991
|
+
content: {
|
|
19992
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19993
|
+
};
|
|
19994
|
+
};
|
|
19995
|
+
/** @description Unexpected error. */
|
|
19996
|
+
default: {
|
|
19997
|
+
headers: {
|
|
19998
|
+
[name: string]: unknown;
|
|
19999
|
+
};
|
|
20000
|
+
content: {
|
|
20001
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20002
|
+
};
|
|
20003
|
+
};
|
|
20004
|
+
};
|
|
20005
|
+
};
|
|
20006
|
+
UpdateSpace: {
|
|
20007
|
+
parameters: {
|
|
20008
|
+
query?: {
|
|
20009
|
+
/** @description If true, re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */
|
|
20010
|
+
refresh_triggers?: boolean;
|
|
20011
|
+
};
|
|
20012
|
+
header?: never;
|
|
20013
|
+
path: {
|
|
20014
|
+
/** @description Unique identifier for a space_id */
|
|
20015
|
+
space_id: string;
|
|
20016
|
+
};
|
|
20017
|
+
cookie?: never;
|
|
20018
|
+
};
|
|
20019
|
+
requestBody?: {
|
|
20020
|
+
content: {
|
|
20021
|
+
"application/json": components["schemas"]["Space"];
|
|
20022
|
+
};
|
|
20023
|
+
};
|
|
20024
|
+
responses: {
|
|
20025
|
+
/** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, workers, and other entities. */
|
|
20026
|
+
200: {
|
|
20027
|
+
headers: {
|
|
20028
|
+
[name: string]: unknown;
|
|
20029
|
+
};
|
|
20030
|
+
content: {
|
|
20031
|
+
"application/json": components["schemas"]["Space"];
|
|
20032
|
+
};
|
|
20033
|
+
};
|
|
20034
|
+
/** @description Space request is invalid (Bad Request). */
|
|
20035
|
+
400: {
|
|
20036
|
+
headers: {
|
|
20037
|
+
[name: string]: unknown;
|
|
20038
|
+
};
|
|
20039
|
+
content: {
|
|
20040
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20041
|
+
};
|
|
20042
|
+
};
|
|
20043
|
+
/** @description Unauthorized access. */
|
|
20044
|
+
401: {
|
|
20045
|
+
headers: {
|
|
20046
|
+
[name: string]: unknown;
|
|
20047
|
+
};
|
|
20048
|
+
content: {
|
|
20049
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20050
|
+
};
|
|
20051
|
+
};
|
|
20052
|
+
/** @description Forbidden access. */
|
|
20053
|
+
403: {
|
|
20054
|
+
headers: {
|
|
20055
|
+
[name: string]: unknown;
|
|
20056
|
+
};
|
|
20057
|
+
content: {
|
|
20058
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20059
|
+
};
|
|
20060
|
+
};
|
|
20061
|
+
/** @description Space not found. */
|
|
20062
|
+
404: {
|
|
20063
|
+
headers: {
|
|
20064
|
+
[name: string]: unknown;
|
|
20065
|
+
};
|
|
20066
|
+
content: {
|
|
20067
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20068
|
+
};
|
|
20069
|
+
};
|
|
20070
|
+
/** @description Space data conflict. Data has changed since last read. */
|
|
20071
|
+
409: {
|
|
20072
|
+
headers: {
|
|
20073
|
+
[name: string]: unknown;
|
|
20074
|
+
};
|
|
20075
|
+
content: {
|
|
20076
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20077
|
+
};
|
|
20078
|
+
};
|
|
20079
|
+
/** @description Something went wrong while processing Space. */
|
|
20080
|
+
500: {
|
|
20081
|
+
headers: {
|
|
20082
|
+
[name: string]: unknown;
|
|
20083
|
+
};
|
|
20084
|
+
content: {
|
|
20085
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20086
|
+
};
|
|
20087
|
+
};
|
|
20088
|
+
/** @description Unexpected error. */
|
|
20089
|
+
default: {
|
|
20090
|
+
headers: {
|
|
20091
|
+
[name: string]: unknown;
|
|
20092
|
+
};
|
|
20093
|
+
content: {
|
|
20094
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20095
|
+
};
|
|
20096
|
+
};
|
|
20097
|
+
};
|
|
20098
|
+
};
|
|
20099
|
+
DeleteSpace: {
|
|
20100
|
+
parameters: {
|
|
20101
|
+
query?: {
|
|
20102
|
+
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) so long as none have delete gates. */
|
|
20103
|
+
recursive?: string;
|
|
20104
|
+
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
20105
|
+
recursive_force?: string;
|
|
20106
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
20107
|
+
detach?: boolean;
|
|
20108
|
+
};
|
|
20109
|
+
header?: never;
|
|
20110
|
+
path: {
|
|
20111
|
+
/** @description Unique identifier for a space_id */
|
|
20112
|
+
space_id: string;
|
|
20113
|
+
};
|
|
20114
|
+
cookie?: never;
|
|
20115
|
+
};
|
|
20116
|
+
requestBody?: never;
|
|
20117
|
+
responses: {
|
|
20118
|
+
/** @description Response for successful delete operation */
|
|
20119
|
+
200: {
|
|
20120
|
+
headers: {
|
|
20121
|
+
[name: string]: unknown;
|
|
20122
|
+
};
|
|
20123
|
+
content: {
|
|
20124
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
20125
|
+
};
|
|
20126
|
+
};
|
|
20127
|
+
/** @description Space request is invalid (Bad Request). */
|
|
20128
|
+
400: {
|
|
20129
|
+
headers: {
|
|
20130
|
+
[name: string]: unknown;
|
|
20131
|
+
};
|
|
20132
|
+
content: {
|
|
20133
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20134
|
+
};
|
|
20135
|
+
};
|
|
20136
|
+
/** @description Unauthorized access. */
|
|
20137
|
+
401: {
|
|
20138
|
+
headers: {
|
|
20139
|
+
[name: string]: unknown;
|
|
20140
|
+
};
|
|
20141
|
+
content: {
|
|
20142
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20143
|
+
};
|
|
20144
|
+
};
|
|
20145
|
+
/** @description Forbidden access. */
|
|
20146
|
+
403: {
|
|
20147
|
+
headers: {
|
|
20148
|
+
[name: string]: unknown;
|
|
20149
|
+
};
|
|
20150
|
+
content: {
|
|
20151
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20152
|
+
};
|
|
20153
|
+
};
|
|
20154
|
+
/** @description Space not found. */
|
|
20155
|
+
404: {
|
|
20156
|
+
headers: {
|
|
20157
|
+
[name: string]: unknown;
|
|
20158
|
+
};
|
|
20159
|
+
content: {
|
|
20160
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20161
|
+
};
|
|
20162
|
+
};
|
|
20163
|
+
/** @description Space is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
20164
|
+
409: {
|
|
20165
|
+
headers: {
|
|
20166
|
+
[name: string]: unknown;
|
|
20167
|
+
};
|
|
20168
|
+
content: {
|
|
20169
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20170
|
+
};
|
|
20171
|
+
};
|
|
20172
|
+
/** @description Space could not be deleted. */
|
|
20173
|
+
422: {
|
|
20174
|
+
headers: {
|
|
20175
|
+
[name: string]: unknown;
|
|
20176
|
+
};
|
|
20177
|
+
content: {
|
|
20178
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20179
|
+
};
|
|
20180
|
+
};
|
|
20181
|
+
/** @description Something went wrong while processing Space. */
|
|
20182
|
+
500: {
|
|
20183
|
+
headers: {
|
|
20184
|
+
[name: string]: unknown;
|
|
20185
|
+
};
|
|
20186
|
+
content: {
|
|
20187
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20188
|
+
};
|
|
20189
|
+
};
|
|
20190
|
+
/** @description Unexpected error. */
|
|
20191
|
+
default: {
|
|
20192
|
+
headers: {
|
|
20193
|
+
[name: string]: unknown;
|
|
20194
|
+
};
|
|
20195
|
+
content: {
|
|
20196
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20197
|
+
};
|
|
20198
|
+
};
|
|
20199
|
+
};
|
|
20200
|
+
};
|
|
20201
|
+
PatchSpace: {
|
|
20202
|
+
parameters: {
|
|
20203
|
+
query?: {
|
|
20204
|
+
/** @description If true, re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */
|
|
20205
|
+
refresh_triggers?: boolean;
|
|
20206
|
+
};
|
|
20207
|
+
header?: never;
|
|
20208
|
+
path: {
|
|
20209
|
+
/** @description Unique identifier for a space_id */
|
|
20210
|
+
space_id: string;
|
|
20211
|
+
};
|
|
20212
|
+
cookie?: never;
|
|
20213
|
+
};
|
|
20214
|
+
requestBody?: {
|
|
20215
|
+
content: {
|
|
20216
|
+
"application/merge-patch+json": {
|
|
20217
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
20218
|
+
Annotations?: {
|
|
20219
|
+
[key: string]: string | null;
|
|
20220
|
+
} | null;
|
|
20221
|
+
/** Format: uuid */
|
|
20222
|
+
AttributeFilterID?: string | null;
|
|
20223
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
20224
|
+
DeleteGates?: {
|
|
20225
|
+
[key: string]: boolean | null;
|
|
20226
|
+
} | null;
|
|
20227
|
+
/** @description Friendly name for the entity. */
|
|
20228
|
+
DisplayName?: string | null;
|
|
20229
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
20230
|
+
Labels?: {
|
|
20231
|
+
[key: string]: string | null;
|
|
20232
|
+
} | null;
|
|
20233
|
+
Permissions?: {
|
|
20234
|
+
[key: string]: Record<string, never> | null;
|
|
20235
|
+
} | null;
|
|
20236
|
+
/** Format: uuid */
|
|
20237
|
+
ReleaseTargetID?: string | null;
|
|
20238
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
20239
|
+
Slug?: string | null;
|
|
20240
|
+
/** Format: uuid */
|
|
20241
|
+
TriggerFilterID?: string | null;
|
|
20242
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
20243
|
+
Version?: number | null;
|
|
20244
|
+
WhereAttribute?: string | null;
|
|
20245
|
+
WhereTrigger?: string | null;
|
|
20246
|
+
};
|
|
20247
|
+
};
|
|
20248
|
+
};
|
|
20249
|
+
responses: {
|
|
20250
|
+
/** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, workers, and other entities. */
|
|
20251
|
+
200: {
|
|
20252
|
+
headers: {
|
|
20253
|
+
[name: string]: unknown;
|
|
20254
|
+
};
|
|
20255
|
+
content: {
|
|
20256
|
+
"application/json": components["schemas"]["Space"];
|
|
20257
|
+
};
|
|
20258
|
+
};
|
|
20259
|
+
/** @description Space request is invalid (Bad Request). */
|
|
20260
|
+
400: {
|
|
20261
|
+
headers: {
|
|
20262
|
+
[name: string]: unknown;
|
|
20263
|
+
};
|
|
20264
|
+
content: {
|
|
20265
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20266
|
+
};
|
|
20267
|
+
};
|
|
20268
|
+
/** @description Unauthorized access. */
|
|
20269
|
+
401: {
|
|
20270
|
+
headers: {
|
|
20271
|
+
[name: string]: unknown;
|
|
20272
|
+
};
|
|
20273
|
+
content: {
|
|
20274
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20275
|
+
};
|
|
20276
|
+
};
|
|
20277
|
+
/** @description Forbidden access. */
|
|
20278
|
+
403: {
|
|
20279
|
+
headers: {
|
|
20280
|
+
[name: string]: unknown;
|
|
20281
|
+
};
|
|
20282
|
+
content: {
|
|
20283
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20284
|
+
};
|
|
20285
|
+
};
|
|
20286
|
+
/** @description Space not found. */
|
|
20287
|
+
404: {
|
|
20288
|
+
headers: {
|
|
20289
|
+
[name: string]: unknown;
|
|
20290
|
+
};
|
|
20291
|
+
content: {
|
|
20292
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20293
|
+
};
|
|
20294
|
+
};
|
|
20295
|
+
/** @description Space data conflict. Data has changed since last read. */
|
|
20296
|
+
409: {
|
|
20297
|
+
headers: {
|
|
20298
|
+
[name: string]: unknown;
|
|
20299
|
+
};
|
|
20300
|
+
content: {
|
|
20301
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20302
|
+
};
|
|
20303
|
+
};
|
|
20304
|
+
/** @description Something went wrong while processing Space. */
|
|
20305
|
+
500: {
|
|
20306
|
+
headers: {
|
|
20307
|
+
[name: string]: unknown;
|
|
20308
|
+
};
|
|
20309
|
+
content: {
|
|
20310
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20311
|
+
};
|
|
20312
|
+
};
|
|
20313
|
+
/** @description Unexpected error. */
|
|
20314
|
+
default: {
|
|
20315
|
+
headers: {
|
|
20316
|
+
[name: string]: unknown;
|
|
20317
|
+
};
|
|
20318
|
+
content: {
|
|
20319
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
20320
|
+
};
|
|
20321
|
+
};
|
|
20322
|
+
};
|
|
20323
|
+
};
|
|
20324
|
+
ListExtendedAttestations: {
|
|
19312
20325
|
parameters: {
|
|
19313
20326
|
query?: {
|
|
19314
20327
|
/**
|
|
19315
|
-
* @description
|
|
20328
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
20329
|
+
* the list of Attestations returned. The expression syntax was inspired by SQL.
|
|
20330
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
20331
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
20332
|
+
* as in the JSON encoding.
|
|
20333
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
20334
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
20335
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
20336
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
20337
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
20338
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
20339
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
20340
|
+
* UUID and time literals must be quoted as string literals.
|
|
20341
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
20342
|
+
* Time literals use the same form as when serialized as JSON,
|
|
20343
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
20344
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
20345
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
20346
|
+
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
20347
|
+
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
20348
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
20349
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
20350
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
20351
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
20352
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
20353
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
20354
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
20355
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
20356
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
20357
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
20358
|
+
* Conjunctions are supported using the `AND` operator.
|
|
20359
|
+
* An example conjunction is:
|
|
20360
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
20361
|
+
*
|
|
20362
|
+
* Supported attributes for filtering on Attestation: AttestationID, ChangeOrderID, Claims, CreatedAt, EvidenceAttestationIDs, ExpiresAt, Note, OrganizationID, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID.
|
|
20363
|
+
*
|
|
20364
|
+
* The whole string must be query-encoded.
|
|
20365
|
+
*/
|
|
20366
|
+
where?: string;
|
|
20367
|
+
/**
|
|
20368
|
+
* @description UUID of a Filter entity to apply to the Attestation list.
|
|
20369
|
+
*
|
|
20370
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
20371
|
+
*
|
|
20372
|
+
* The Filter's From field must match the entity type being filtered (Attestation).
|
|
20373
|
+
*
|
|
20374
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
20375
|
+
*
|
|
20376
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
20377
|
+
*
|
|
20378
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
20379
|
+
*/
|
|
20380
|
+
filter?: string;
|
|
20381
|
+
/**
|
|
20382
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
20383
|
+
*
|
|
20384
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
20385
|
+
*
|
|
20386
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
20387
|
+
*
|
|
20388
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
20389
|
+
*
|
|
20390
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
20391
|
+
*
|
|
20392
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
20393
|
+
*
|
|
20394
|
+
* Searchable fields for Attestation include string and map-type attributes from the queryable attributes list.
|
|
20395
|
+
*
|
|
20396
|
+
* The whole string must be query-encoded.
|
|
20397
|
+
*/
|
|
20398
|
+
contains?: string;
|
|
20399
|
+
/**
|
|
20400
|
+
* @description Include clause for expanding related entities in the response for Attestation.
|
|
19316
20401
|
* The attribute names are case-sensitive, PascalCase, and
|
|
19317
20402
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
19318
20403
|
*
|
|
19319
|
-
* Supported attributes for
|
|
20404
|
+
* Supported attributes for Attestation are OrganizationID, SpaceID.
|
|
19320
20405
|
*
|
|
19321
20406
|
* The whole string must be query-encoded.
|
|
19322
20407
|
*/
|
|
19323
20408
|
include?: string;
|
|
19324
20409
|
/**
|
|
19325
|
-
* @description Select clause for specifying which fields to include in the response for
|
|
20410
|
+
* @description Select clause for specifying which fields to include in the response for Attestation.
|
|
19326
20411
|
* The attribute names are case-sensitive, PascalCase, and
|
|
19327
20412
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
19328
20413
|
* If not specified, all fields are returned.
|
|
19329
|
-
* Entity and parent IDs (like OrganizationID, SpaceID,
|
|
20414
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
19330
20415
|
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
19331
20416
|
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
19332
20417
|
* The whole string must be query-encoded.
|
|
19333
20418
|
*/
|
|
19334
20419
|
select?: string;
|
|
19335
|
-
/** @description Return summarized entity data */
|
|
19336
|
-
summary?: boolean;
|
|
19337
20420
|
};
|
|
19338
20421
|
header?: never;
|
|
19339
20422
|
path: {
|
|
@@ -19350,10 +20433,10 @@ interface operations {
|
|
|
19350
20433
|
[name: string]: unknown;
|
|
19351
20434
|
};
|
|
19352
20435
|
content: {
|
|
19353
|
-
"application/json": components["schemas"]["
|
|
20436
|
+
"application/json": components["schemas"]["ExtendedAttestation"][];
|
|
19354
20437
|
};
|
|
19355
20438
|
};
|
|
19356
|
-
/** @description
|
|
20439
|
+
/** @description ExtendedAttestation request is invalid (Bad Request). */
|
|
19357
20440
|
400: {
|
|
19358
20441
|
headers: {
|
|
19359
20442
|
[name: string]: unknown;
|
|
@@ -19380,7 +20463,7 @@ interface operations {
|
|
|
19380
20463
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19381
20464
|
};
|
|
19382
20465
|
};
|
|
19383
|
-
/** @description
|
|
20466
|
+
/** @description ExtendedAttestation not found. */
|
|
19384
20467
|
404: {
|
|
19385
20468
|
headers: {
|
|
19386
20469
|
[name: string]: unknown;
|
|
@@ -19389,7 +20472,7 @@ interface operations {
|
|
|
19389
20472
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19390
20473
|
};
|
|
19391
20474
|
};
|
|
19392
|
-
/** @description Something went wrong while processing
|
|
20475
|
+
/** @description Something went wrong while processing ExtendedAttestation. */
|
|
19393
20476
|
500: {
|
|
19394
20477
|
headers: {
|
|
19395
20478
|
[name: string]: unknown;
|
|
@@ -19409,11 +20492,11 @@ interface operations {
|
|
|
19409
20492
|
};
|
|
19410
20493
|
};
|
|
19411
20494
|
};
|
|
19412
|
-
|
|
20495
|
+
CreateAttestation: {
|
|
19413
20496
|
parameters: {
|
|
19414
20497
|
query?: {
|
|
19415
|
-
/** @description
|
|
19416
|
-
|
|
20498
|
+
/** @description Resolve the Revisions that would be covered and return the same response without writing anything. */
|
|
20499
|
+
dry_run?: boolean;
|
|
19417
20500
|
};
|
|
19418
20501
|
header?: never;
|
|
19419
20502
|
path: {
|
|
@@ -19424,20 +20507,20 @@ interface operations {
|
|
|
19424
20507
|
};
|
|
19425
20508
|
requestBody?: {
|
|
19426
20509
|
content: {
|
|
19427
|
-
"application/json": components["schemas"]["
|
|
20510
|
+
"application/json": components["schemas"]["AttestationCreateRequest"];
|
|
19428
20511
|
};
|
|
19429
20512
|
};
|
|
19430
20513
|
responses: {
|
|
19431
|
-
/** @description
|
|
20514
|
+
/** @description OK */
|
|
19432
20515
|
200: {
|
|
19433
20516
|
headers: {
|
|
19434
20517
|
[name: string]: unknown;
|
|
19435
20518
|
};
|
|
19436
20519
|
content: {
|
|
19437
|
-
"application/json": components["schemas"]["
|
|
20520
|
+
"application/json": components["schemas"]["AttestationCreateResponse"];
|
|
19438
20521
|
};
|
|
19439
20522
|
};
|
|
19440
|
-
/** @description
|
|
20523
|
+
/** @description Attestation request is invalid (Bad Request). */
|
|
19441
20524
|
400: {
|
|
19442
20525
|
headers: {
|
|
19443
20526
|
[name: string]: unknown;
|
|
@@ -19464,7 +20547,7 @@ interface operations {
|
|
|
19464
20547
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19465
20548
|
};
|
|
19466
20549
|
};
|
|
19467
|
-
/** @description
|
|
20550
|
+
/** @description Attestation not found. */
|
|
19468
20551
|
404: {
|
|
19469
20552
|
headers: {
|
|
19470
20553
|
[name: string]: unknown;
|
|
@@ -19473,7 +20556,7 @@ interface operations {
|
|
|
19473
20556
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19474
20557
|
};
|
|
19475
20558
|
};
|
|
19476
|
-
/** @description
|
|
20559
|
+
/** @description Attestation data conflict. Data has changed since last read. */
|
|
19477
20560
|
409: {
|
|
19478
20561
|
headers: {
|
|
19479
20562
|
[name: string]: unknown;
|
|
@@ -19482,7 +20565,7 @@ interface operations {
|
|
|
19482
20565
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19483
20566
|
};
|
|
19484
20567
|
};
|
|
19485
|
-
/** @description Something went wrong while processing
|
|
20568
|
+
/** @description Something went wrong while processing Attestation. */
|
|
19486
20569
|
500: {
|
|
19487
20570
|
headers: {
|
|
19488
20571
|
[name: string]: unknown;
|
|
@@ -19502,35 +20585,52 @@ interface operations {
|
|
|
19502
20585
|
};
|
|
19503
20586
|
};
|
|
19504
20587
|
};
|
|
19505
|
-
|
|
20588
|
+
GetExtendedAttestation: {
|
|
19506
20589
|
parameters: {
|
|
19507
20590
|
query?: {
|
|
19508
|
-
/**
|
|
19509
|
-
|
|
19510
|
-
|
|
19511
|
-
|
|
19512
|
-
|
|
19513
|
-
|
|
20591
|
+
/**
|
|
20592
|
+
* @description Include clause for expanding related entities in the response for Attestation.
|
|
20593
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
20594
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
20595
|
+
*
|
|
20596
|
+
* Supported attributes for Attestation are OrganizationID, SpaceID.
|
|
20597
|
+
*
|
|
20598
|
+
* The whole string must be query-encoded.
|
|
20599
|
+
*/
|
|
20600
|
+
include?: string;
|
|
20601
|
+
/**
|
|
20602
|
+
* @description Select clause for specifying which fields to include in the response for Attestation.
|
|
20603
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
20604
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
20605
|
+
* If not specified, all fields are returned.
|
|
20606
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter.
|
|
20607
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
20608
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
20609
|
+
* The whole string must be query-encoded.
|
|
20610
|
+
*/
|
|
20611
|
+
select?: string;
|
|
19514
20612
|
};
|
|
19515
20613
|
header?: never;
|
|
19516
20614
|
path: {
|
|
19517
20615
|
/** @description Unique identifier for a space_id */
|
|
19518
20616
|
space_id: string;
|
|
20617
|
+
/** @description Unique identifier for a attestation_id */
|
|
20618
|
+
attestation_id: string;
|
|
19519
20619
|
};
|
|
19520
20620
|
cookie?: never;
|
|
19521
20621
|
};
|
|
19522
20622
|
requestBody?: never;
|
|
19523
20623
|
responses: {
|
|
19524
|
-
/** @description
|
|
20624
|
+
/** @description Attestation with additional related entities expanded based on the request's include parameter. */
|
|
19525
20625
|
200: {
|
|
19526
20626
|
headers: {
|
|
19527
20627
|
[name: string]: unknown;
|
|
19528
20628
|
};
|
|
19529
20629
|
content: {
|
|
19530
|
-
"application/json": components["schemas"]["
|
|
20630
|
+
"application/json": components["schemas"]["ExtendedAttestation"];
|
|
19531
20631
|
};
|
|
19532
20632
|
};
|
|
19533
|
-
/** @description
|
|
20633
|
+
/** @description ExtendedAttestation request is invalid (Bad Request). */
|
|
19534
20634
|
400: {
|
|
19535
20635
|
headers: {
|
|
19536
20636
|
[name: string]: unknown;
|
|
@@ -19557,7 +20657,7 @@ interface operations {
|
|
|
19557
20657
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19558
20658
|
};
|
|
19559
20659
|
};
|
|
19560
|
-
/** @description
|
|
20660
|
+
/** @description ExtendedAttestation not found. */
|
|
19561
20661
|
404: {
|
|
19562
20662
|
headers: {
|
|
19563
20663
|
[name: string]: unknown;
|
|
@@ -19566,148 +20666,7 @@ interface operations {
|
|
|
19566
20666
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19567
20667
|
};
|
|
19568
20668
|
};
|
|
19569
|
-
/** @description
|
|
19570
|
-
409: {
|
|
19571
|
-
headers: {
|
|
19572
|
-
[name: string]: unknown;
|
|
19573
|
-
};
|
|
19574
|
-
content: {
|
|
19575
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19576
|
-
};
|
|
19577
|
-
};
|
|
19578
|
-
/** @description Space could not be deleted. */
|
|
19579
|
-
422: {
|
|
19580
|
-
headers: {
|
|
19581
|
-
[name: string]: unknown;
|
|
19582
|
-
};
|
|
19583
|
-
content: {
|
|
19584
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19585
|
-
};
|
|
19586
|
-
};
|
|
19587
|
-
/** @description Something went wrong while processing Space. */
|
|
19588
|
-
500: {
|
|
19589
|
-
headers: {
|
|
19590
|
-
[name: string]: unknown;
|
|
19591
|
-
};
|
|
19592
|
-
content: {
|
|
19593
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19594
|
-
};
|
|
19595
|
-
};
|
|
19596
|
-
/** @description Unexpected error. */
|
|
19597
|
-
default: {
|
|
19598
|
-
headers: {
|
|
19599
|
-
[name: string]: unknown;
|
|
19600
|
-
};
|
|
19601
|
-
content: {
|
|
19602
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19603
|
-
};
|
|
19604
|
-
};
|
|
19605
|
-
};
|
|
19606
|
-
};
|
|
19607
|
-
PatchSpace: {
|
|
19608
|
-
parameters: {
|
|
19609
|
-
query?: {
|
|
19610
|
-
/** @description If true, re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */
|
|
19611
|
-
refresh_triggers?: boolean;
|
|
19612
|
-
};
|
|
19613
|
-
header?: never;
|
|
19614
|
-
path: {
|
|
19615
|
-
/** @description Unique identifier for a space_id */
|
|
19616
|
-
space_id: string;
|
|
19617
|
-
};
|
|
19618
|
-
cookie?: never;
|
|
19619
|
-
};
|
|
19620
|
-
requestBody?: {
|
|
19621
|
-
content: {
|
|
19622
|
-
"application/merge-patch+json": {
|
|
19623
|
-
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
19624
|
-
Annotations?: {
|
|
19625
|
-
[key: string]: string | null;
|
|
19626
|
-
} | null;
|
|
19627
|
-
/** Format: uuid */
|
|
19628
|
-
AttributeFilterID?: string | null;
|
|
19629
|
-
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
19630
|
-
DeleteGates?: {
|
|
19631
|
-
[key: string]: boolean | null;
|
|
19632
|
-
} | null;
|
|
19633
|
-
/** @description Friendly name for the entity. */
|
|
19634
|
-
DisplayName?: string | null;
|
|
19635
|
-
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
19636
|
-
Labels?: {
|
|
19637
|
-
[key: string]: string | null;
|
|
19638
|
-
} | null;
|
|
19639
|
-
Permissions?: {
|
|
19640
|
-
[key: string]: Record<string, never> | null;
|
|
19641
|
-
} | null;
|
|
19642
|
-
/** Format: uuid */
|
|
19643
|
-
ReleaseTargetID?: string | null;
|
|
19644
|
-
/** @description Unique URL-safe identifier for the entity. */
|
|
19645
|
-
Slug?: string | null;
|
|
19646
|
-
/** Format: uuid */
|
|
19647
|
-
TriggerFilterID?: string | null;
|
|
19648
|
-
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
19649
|
-
Version?: number | null;
|
|
19650
|
-
WhereAttribute?: string | null;
|
|
19651
|
-
WhereTrigger?: string | null;
|
|
19652
|
-
};
|
|
19653
|
-
};
|
|
19654
|
-
};
|
|
19655
|
-
responses: {
|
|
19656
|
-
/** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, workers, and other entities. */
|
|
19657
|
-
200: {
|
|
19658
|
-
headers: {
|
|
19659
|
-
[name: string]: unknown;
|
|
19660
|
-
};
|
|
19661
|
-
content: {
|
|
19662
|
-
"application/json": components["schemas"]["Space"];
|
|
19663
|
-
};
|
|
19664
|
-
};
|
|
19665
|
-
/** @description Space request is invalid (Bad Request). */
|
|
19666
|
-
400: {
|
|
19667
|
-
headers: {
|
|
19668
|
-
[name: string]: unknown;
|
|
19669
|
-
};
|
|
19670
|
-
content: {
|
|
19671
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19672
|
-
};
|
|
19673
|
-
};
|
|
19674
|
-
/** @description Unauthorized access. */
|
|
19675
|
-
401: {
|
|
19676
|
-
headers: {
|
|
19677
|
-
[name: string]: unknown;
|
|
19678
|
-
};
|
|
19679
|
-
content: {
|
|
19680
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19681
|
-
};
|
|
19682
|
-
};
|
|
19683
|
-
/** @description Forbidden access. */
|
|
19684
|
-
403: {
|
|
19685
|
-
headers: {
|
|
19686
|
-
[name: string]: unknown;
|
|
19687
|
-
};
|
|
19688
|
-
content: {
|
|
19689
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19690
|
-
};
|
|
19691
|
-
};
|
|
19692
|
-
/** @description Space not found. */
|
|
19693
|
-
404: {
|
|
19694
|
-
headers: {
|
|
19695
|
-
[name: string]: unknown;
|
|
19696
|
-
};
|
|
19697
|
-
content: {
|
|
19698
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19699
|
-
};
|
|
19700
|
-
};
|
|
19701
|
-
/** @description Space data conflict. Data has changed since last read. */
|
|
19702
|
-
409: {
|
|
19703
|
-
headers: {
|
|
19704
|
-
[name: string]: unknown;
|
|
19705
|
-
};
|
|
19706
|
-
content: {
|
|
19707
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
19708
|
-
};
|
|
19709
|
-
};
|
|
19710
|
-
/** @description Something went wrong while processing Space. */
|
|
20669
|
+
/** @description Something went wrong while processing ExtendedAttestation. */
|
|
19711
20670
|
500: {
|
|
19712
20671
|
headers: {
|
|
19713
20672
|
[name: string]: unknown;
|
|
@@ -22700,7 +23659,7 @@ interface operations {
|
|
|
22700
23659
|
* An example conjunction is:
|
|
22701
23660
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22702
23661
|
*
|
|
22703
|
-
* Supported attributes for filtering on ChangeWorkflow: Annotations, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
23662
|
+
* Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Labels, OrganizationID, Slug, SpaceID, Stages, UpdatedAt.
|
|
22704
23663
|
*
|
|
22705
23664
|
* The whole string must be query-encoded.
|
|
22706
23665
|
*/
|
|
@@ -23235,6 +24194,8 @@ interface operations {
|
|
|
23235
24194
|
Annotations?: {
|
|
23236
24195
|
[key: string]: string | null;
|
|
23237
24196
|
} | null;
|
|
24197
|
+
/** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */
|
|
24198
|
+
AttestationPrerequisites?: (Record<string, never> | null)[] | null;
|
|
23238
24199
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
23239
24200
|
CustomPrerequisites?: (Record<string, never> | null)[] | null;
|
|
23240
24201
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
@@ -25985,7 +26946,7 @@ interface operations {
|
|
|
25985
26946
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25986
26947
|
};
|
|
25987
26948
|
};
|
|
25988
|
-
/** @description A Unit to be bundled has outstanding validation errors */
|
|
26949
|
+
/** @description A Unit to be bundled has outstanding validation errors, or, for a change order, the bundled Revisions do not satisfy the ReleasePrerequisites of the stage the Space belongs to */
|
|
25989
26950
|
422: {
|
|
25990
26951
|
headers: {
|
|
25991
26952
|
[name: string]: unknown;
|
|
@@ -30902,7 +31863,7 @@ interface operations {
|
|
|
30902
31863
|
* An example conjunction is:
|
|
30903
31864
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30904
31865
|
*
|
|
30905
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
31866
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
30906
31867
|
*
|
|
30907
31868
|
* To list a tagged Revision use `Tags ? '<tag-id>'`.
|
|
30908
31869
|
*
|
|
@@ -30946,7 +31907,7 @@ interface operations {
|
|
|
30946
31907
|
* The attribute names are case-sensitive, PascalCase, and
|
|
30947
31908
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
30948
31909
|
*
|
|
30949
|
-
* Supported attributes for Revision are ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
31910
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
30950
31911
|
*
|
|
30951
31912
|
* The whole string must be query-encoded.
|
|
30952
31913
|
*/
|
|
@@ -30971,7 +31932,7 @@ interface operations {
|
|
|
30971
31932
|
*
|
|
30972
31933
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
30973
31934
|
*
|
|
30974
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
31935
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
30975
31936
|
*
|
|
30976
31937
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
30977
31938
|
*
|
|
@@ -31065,7 +32026,7 @@ interface operations {
|
|
|
31065
32026
|
* The attribute names are case-sensitive, PascalCase, and
|
|
31066
32027
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
31067
32028
|
*
|
|
31068
|
-
* Supported attributes for Revision are ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
32029
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
31069
32030
|
*
|
|
31070
32031
|
* The whole string must be query-encoded.
|
|
31071
32032
|
*/
|
|
@@ -31090,7 +32051,7 @@ interface operations {
|
|
|
31090
32051
|
*
|
|
31091
32052
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
31092
32053
|
*
|
|
31093
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
32054
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
31094
32055
|
*
|
|
31095
32056
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
31096
32057
|
*
|
|
@@ -39262,6 +40223,10 @@ declare enum ActionType {
|
|
|
39262
40223
|
ListFunctions = "ListFunctions",
|
|
39263
40224
|
Apply = "Apply"
|
|
39264
40225
|
}
|
|
40226
|
+
declare enum AttestationResult {
|
|
40227
|
+
Pass = "Pass",
|
|
40228
|
+
Fail = "Fail"
|
|
40229
|
+
}
|
|
39265
40230
|
declare enum MutationType {
|
|
39266
40231
|
Add = "Add",
|
|
39267
40232
|
Delete = "Delete",
|