@confighub/api 0.8.17 → 0.8.19
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 +144 -22
- package/dist/index.d.ts +144 -22
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -3954,7 +3954,84 @@ interface components {
|
|
|
3954
3954
|
SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][];
|
|
3955
3955
|
Subjects?: components["schemas"]["AttestationSubject"][];
|
|
3956
3956
|
};
|
|
3957
|
+
AttestationGateCaller: {
|
|
3958
|
+
/** @description How many of the Revisions evaluated the caller wrote part of. */
|
|
3959
|
+
AuthoredRevisions?: number;
|
|
3960
|
+
/** @description A Pass the caller records would count on every Revision evaluated. */
|
|
3961
|
+
Counts?: boolean;
|
|
3962
|
+
/** @description Why it would not: NotEligible, when the prerequisite names neither the caller nor a Group of theirs, or Author, when the caller wrote part of the change on some Revision. */
|
|
3963
|
+
Reason?: string;
|
|
3964
|
+
};
|
|
3965
|
+
AttestationGateEntry: {
|
|
3966
|
+
/**
|
|
3967
|
+
* Format: uuid
|
|
3968
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3969
|
+
*/
|
|
3970
|
+
AttestationID?: string;
|
|
3971
|
+
/** @description How many of the Revisions evaluated it counts on. A Fail that counts rejects them. */
|
|
3972
|
+
CountedOn?: number;
|
|
3973
|
+
/**
|
|
3974
|
+
* Format: date-time
|
|
3975
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
3976
|
+
*/
|
|
3977
|
+
CreatedAt?: string;
|
|
3978
|
+
/** @description Why it counts on none of the Revisions it covers: Revoked, Expired, TooOld (older than MaxAge), NotEligible, Author, or FailIgnored (a Fail, under IgnoreFail). */
|
|
3979
|
+
Reason?: string;
|
|
3980
|
+
/** @description Pass or Fail. */
|
|
3981
|
+
Result?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* Format: uuid
|
|
3984
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3985
|
+
*/
|
|
3986
|
+
UserID?: string;
|
|
3987
|
+
/**
|
|
3988
|
+
* Format: date-time
|
|
3989
|
+
* @description When it stops counting: the earlier of its ExpiresAt and its CreatedAt plus the prerequisite's MaxAge. Absent when neither is set.
|
|
3990
|
+
*/
|
|
3991
|
+
ValidUntil?: string | null;
|
|
3992
|
+
};
|
|
3993
|
+
AttestationGateResult: {
|
|
3994
|
+
/** @description Every Attestation of Type covering a Revision evaluated, directly or carried forward from an earlier Revision of the same Unit with the same DataHash, and what became of it. */
|
|
3995
|
+
Attestations?: components["schemas"]["AttestationGateEntry"][];
|
|
3996
|
+
/** @description Users excluded from counting on some Revision because they wrote part of the change there. Empty with AllowAuthors. */
|
|
3997
|
+
AuthorUserIDs?: components["schemas"]["UUID"][];
|
|
3998
|
+
/** @description Whether a Pass recorded by the caller would count here. */
|
|
3999
|
+
Caller?: components["schemas"]["AttestationGateCaller"];
|
|
4000
|
+
/** @description The fewest attesters counted on any Revision evaluated: the gate's progress toward Required. */
|
|
4001
|
+
Counted?: number;
|
|
4002
|
+
/** @description How many distinct attesters each Revision needs: Count, or the number of FromGroupIDs with DistinctGroups. */
|
|
4003
|
+
Required?: number;
|
|
4004
|
+
/** @description How many Revisions were evaluated: one of each Unit the change changed in the Space, or each Revision a Release bundles. */
|
|
4005
|
+
Revisions?: number;
|
|
4006
|
+
/** @description How many of them have what the prerequisite asks for. */
|
|
4007
|
+
SatisfiedRevisions?: number;
|
|
4008
|
+
/** @description More Revisions fall short than Unsatisfied lists. */
|
|
4009
|
+
Truncated?: boolean;
|
|
4010
|
+
/** @description The Attestation Type the prerequisite counts. */
|
|
4011
|
+
Type?: string;
|
|
4012
|
+
/** @description The Revisions that fall short, at most 100. */
|
|
4013
|
+
Unsatisfied?: components["schemas"]["AttestationGateRevision"][];
|
|
4014
|
+
};
|
|
4015
|
+
AttestationGateRevision: {
|
|
4016
|
+
/** @description Users excluded from counting on this Revision because they wrote part of the change on this Unit. Empty with AllowAuthors. */
|
|
4017
|
+
AuthorUserIDs?: components["schemas"]["UUID"][];
|
|
4018
|
+
/** @description Distinct attesters counted on this Revision. */
|
|
4019
|
+
Counted?: number;
|
|
4020
|
+
/** @description AttestationsMissing or AttestationRejected. */
|
|
4021
|
+
Reason?: string;
|
|
4022
|
+
/** Format: int64 */
|
|
4023
|
+
RevisionNum?: number;
|
|
4024
|
+
/**
|
|
4025
|
+
* Format: uuid
|
|
4026
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4027
|
+
*/
|
|
4028
|
+
UnitID?: string;
|
|
4029
|
+
UnitSlug?: string;
|
|
4030
|
+
};
|
|
3957
4031
|
AttestationSkippedUnit: {
|
|
4032
|
+
/** @description Why the Unit is not covered, in words. */
|
|
4033
|
+
Message?: string;
|
|
4034
|
+
/** @description Why the Unit is not covered, as a code: NoTarget or NoRevision. */
|
|
3958
4035
|
Reason?: string;
|
|
3959
4036
|
/**
|
|
3960
4037
|
* Format: uuid
|
|
@@ -3964,6 +4041,8 @@ interface components {
|
|
|
3964
4041
|
UnitSlug?: string;
|
|
3965
4042
|
};
|
|
3966
4043
|
AttestationSubject: {
|
|
4044
|
+
/** @description With a ChangeOrder, the caller wrote one of the Revisions of the change on this Unit in this Space, so the Attestation does not count here for a prerequisite that excludes authors. */
|
|
4045
|
+
Authored?: boolean;
|
|
3967
4046
|
/**
|
|
3968
4047
|
* Format: uuid
|
|
3969
4048
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
@@ -4459,7 +4538,9 @@ interface components {
|
|
|
4459
4538
|
readonly RestoreTagID?: string;
|
|
4460
4539
|
/** @description RestoredSpaceIDs is where the ChangeOrder has been undone: the Spaces whose Units all carry the restore Tag. Derived when the ChangeOrder is read. */
|
|
4461
4540
|
readonly RestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
4462
|
-
/** @description
|
|
4541
|
+
/** @description ReviewRequests records whose review the change is waiting for: for each, the stage whose Spaces are to be reviewed (empty for the change order's own Space), the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */
|
|
4542
|
+
ReviewRequests?: components["schemas"]["ChangeOrderReviewRequest"][];
|
|
4543
|
+
/** @description SkippedUnits names the Units of the ChangeOrder's Space that it carries no Revisions of, mapped to the reason as a code: NotFollowed (nothing follows the Unit by Links of the change order's UpdateType, and it was never cloned), FollowedByOtherLinks (it is followed downstream, but not by Links of that UpdateType), NotMarked (the end Tag marks no Revision of it), NoStartRevision (a Link to it has never merged or resolved, and it predates empty start Revisions), AlreadyTaken (the Spaces in scope have already taken it as far as the end, so it is marked, carrying no Revisions), or TakenPastEnd (the Spaces in scope have taken it past the end, so it is not marked). Written when the scope is derived. */
|
|
4463
4544
|
readonly SkippedUnits?: {
|
|
4464
4545
|
[key: string]: string;
|
|
4465
4546
|
};
|
|
@@ -4632,6 +4713,7 @@ interface components {
|
|
|
4632
4713
|
Action?: string;
|
|
4633
4714
|
Error?: string;
|
|
4634
4715
|
Links?: components["schemas"]["ChangeOrderPromotionFailureLink"][];
|
|
4716
|
+
Message?: string;
|
|
4635
4717
|
Reason?: string;
|
|
4636
4718
|
/**
|
|
4637
4719
|
* Format: uuid
|
|
@@ -4686,6 +4768,28 @@ interface components {
|
|
|
4686
4768
|
*/
|
|
4687
4769
|
SpaceID?: string;
|
|
4688
4770
|
};
|
|
4771
|
+
ChangeOrderReviewRequest: {
|
|
4772
|
+
/**
|
|
4773
|
+
* Format: date-time
|
|
4774
|
+
* @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time.
|
|
4775
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4776
|
+
*/
|
|
4777
|
+
RequestedAt?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* Format: uuid
|
|
4780
|
+
* @description Who requested the review, or last re-requested it. Set by the server.
|
|
4781
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4782
|
+
*/
|
|
4783
|
+
readonly RequestedByUserID?: string;
|
|
4784
|
+
/** @description The stage whose Spaces are to be reviewed, which is where an Attestation recorded with that TargetStage goes. Empty is the change order's own Space. */
|
|
4785
|
+
Stage?: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* Format: uuid
|
|
4788
|
+
* @description The User asked to review.
|
|
4789
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4790
|
+
*/
|
|
4791
|
+
UserID: string;
|
|
4792
|
+
};
|
|
4689
4793
|
ChangeOrderSpaceContainerImages: {
|
|
4690
4794
|
/** @description The images that changed, by Unit, resource, and path. */
|
|
4691
4795
|
Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
|
|
@@ -5351,7 +5455,7 @@ interface components {
|
|
|
5351
5455
|
/** @description Demote, Unchanged, Skipped, or Failed. */
|
|
5352
5456
|
Action?: string;
|
|
5353
5457
|
Error?: components["schemas"]["ResponseError"];
|
|
5354
|
-
/** @description
|
|
5458
|
+
/** @description For Skipped: NotMarked, when the change order marks no Unit of the Space. */
|
|
5355
5459
|
Reason?: string;
|
|
5356
5460
|
/**
|
|
5357
5461
|
* Format: uuid
|
|
@@ -6839,10 +6943,14 @@ interface components {
|
|
|
6839
6943
|
[key: string]: components["schemas"]["Subjects"];
|
|
6840
6944
|
};
|
|
6841
6945
|
PromoteGateResult: {
|
|
6946
|
+
/** @description For an attestation prerequisite, what was counted, whether or not the gate holds. */
|
|
6947
|
+
Attestation?: components["schemas"]["AttestationGateResult"];
|
|
6842
6948
|
/** @description Why the gate does not hold. */
|
|
6843
6949
|
Message?: string;
|
|
6844
|
-
/** @description Promoted, Validated, Released, Healthy, or a custom prerequisite
|
|
6950
|
+
/** @description Promoted, Validated, Released, Healthy, or the name of a custom or attestation prerequisite. */
|
|
6845
6951
|
Prerequisite?: string;
|
|
6952
|
+
/** @description Why the gate does not hold, as a code: NotPromoted, PreviousStageEmpty, NotReleased, ValidationErrors, NotMarked, NoReleaseTarget, NoRelease, NoLiveStatus, NotSynced, Deploying, DeployFailed, Unhealthy, AttestationsMissing, AttestationRejected, ExpressionFalse, EvaluationFailed, or UnknownPrerequisite. A client that does not know a code shows Message. */
|
|
6953
|
+
Reason?: string;
|
|
6846
6954
|
Satisfied?: boolean;
|
|
6847
6955
|
/**
|
|
6848
6956
|
* Format: uuid
|
|
@@ -6862,6 +6970,9 @@ interface components {
|
|
|
6862
6970
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6863
6971
|
*/
|
|
6864
6972
|
LinkID?: string;
|
|
6973
|
+
/** @description Why the Link was skipped or orphaned, in words. */
|
|
6974
|
+
Message?: string;
|
|
6975
|
+
/** @description Adopted for an Unchanged Link, TargetUnitMissing for a Skip, or UpstreamLinkDeleted for an Orphaned one. */
|
|
6865
6976
|
Reason?: string;
|
|
6866
6977
|
Slug?: string;
|
|
6867
6978
|
ToSpaceSlug?: string;
|
|
@@ -6937,6 +7048,10 @@ interface components {
|
|
|
6937
7048
|
Complete?: boolean;
|
|
6938
7049
|
/** @description True when nothing was written. */
|
|
6939
7050
|
DryRun?: boolean;
|
|
7051
|
+
/** @description Set when the gates refused the promotion: why, with each failed gate's message among its Details. */
|
|
7052
|
+
Error?: components["schemas"]["ResponseError"];
|
|
7053
|
+
/** @description When Complete, the gates of the ChangeWorkflow's Final, evaluated over each Space of the last Stage. The ChangeOrder's Stage becomes Completed once they all hold. */
|
|
7054
|
+
Final?: components["schemas"]["PromoteGateResult"][];
|
|
6940
7055
|
/** @description Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan. */
|
|
6941
7056
|
Plan?: string;
|
|
6942
7057
|
/** @description In the order they were, or would be, promoted: a Space after any selected Space it takes from. */
|
|
@@ -6949,9 +7064,11 @@ interface components {
|
|
|
6949
7064
|
Action?: string;
|
|
6950
7065
|
Error?: components["schemas"]["ResponseError"];
|
|
6951
7066
|
Links?: components["schemas"]["PromoteLinkResult"][];
|
|
7067
|
+
/** @description Why the Space was Skipped or Blocked, in words. */
|
|
7068
|
+
Message?: string;
|
|
6952
7069
|
/** @description A dry run previewed this Space against its upstream as it is now, although the same request promotes that upstream first. */
|
|
6953
7070
|
PreviewedAgainstCurrentUpstream?: boolean;
|
|
6954
|
-
/** @description Why the Space was Skipped or Blocked. */
|
|
7071
|
+
/** @description Why the Space was Skipped or Blocked, as a code: ChangeOrderSpace, NotInScope, UpstreamPromotedFirst, or UpstreamFailed. */
|
|
6955
7072
|
Reason?: string;
|
|
6956
7073
|
/**
|
|
6957
7074
|
* Format: uuid
|
|
@@ -6975,7 +7092,7 @@ interface components {
|
|
|
6975
7092
|
Forced?: boolean;
|
|
6976
7093
|
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
6977
7094
|
Name?: string;
|
|
6978
|
-
/** @description The Stage whose Spaces the gates are evaluated over. Empty for the first Stage,
|
|
7095
|
+
/** @description The Stage whose Spaces the gates are evaluated over. Empty for the first Stage, whose gates are evaluated over the change order's own Space. */
|
|
6979
7096
|
PreviousStage?: string;
|
|
6980
7097
|
};
|
|
6981
7098
|
PromoteUnitResult: {
|
|
@@ -7167,7 +7284,7 @@ interface components {
|
|
|
7167
7284
|
* @description Monotonically increasing sequence number of the Release within its Target, assigned at publish time. The highest ReleaseNum is the latest Release for the Target.
|
|
7168
7285
|
*/
|
|
7169
7286
|
readonly ReleaseNum?: number;
|
|
7170
|
-
/** @description SkippedUnits names the Units assigned to the Release's Target that the Release does not bundle, mapped to the reason.
|
|
7287
|
+
/** @description SkippedUnits names the Units assigned to the Release's Target that the Release does not bundle, mapped to the reason as a code. NotMarked: publishing with a TagID leaves out a Unit that has never been released and that the Tag marks no Revision of; a Unit that has been released must be marked. (readonly) */
|
|
7171
7288
|
readonly SkippedUnits?: {
|
|
7172
7289
|
[key: string]: string;
|
|
7173
7290
|
};
|
|
@@ -7285,7 +7402,11 @@ interface components {
|
|
|
7285
7402
|
TagID?: string;
|
|
7286
7403
|
};
|
|
7287
7404
|
ReleasePublishResponse: {
|
|
7288
|
-
/** @description
|
|
7405
|
+
/** @description Why the Release was not published. */
|
|
7406
|
+
Error?: components["schemas"]["ResponseError"];
|
|
7407
|
+
/** @description For a change order, each ReleasePrerequisite of the stage the Space belongs to, evaluated over the Revisions the Release bundles, whether or not it holds. */
|
|
7408
|
+
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
7409
|
+
/** @description Why no Release was created: nothing changed since the latest published Release, or, on a refusal, the error as one string. */
|
|
7289
7410
|
Message?: string;
|
|
7290
7411
|
/** @description The published Release, or the latest published Release when no Release was created. */
|
|
7291
7412
|
Release?: components["schemas"]["Release"];
|
|
@@ -7493,15 +7614,13 @@ interface components {
|
|
|
7493
7614
|
ResponseError: {
|
|
7494
7615
|
/** @description Additional context messages */
|
|
7495
7616
|
Details?: string[];
|
|
7496
|
-
/** @description The type of error (e.g., validation, not-found) */
|
|
7497
|
-
ErrorCategory?: string;
|
|
7498
7617
|
/** @description Structured error details like field violations */
|
|
7499
7618
|
ErrorMetadata?: components["schemas"]["ErrorMetadata"];
|
|
7500
7619
|
/** @description The primary error message */
|
|
7501
7620
|
Message?: string;
|
|
7502
7621
|
/** @description HTTP status code */
|
|
7503
7622
|
Status?: number;
|
|
7504
|
-
/** @description The
|
|
7623
|
+
/** @description The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable */
|
|
7505
7624
|
Type?: string;
|
|
7506
7625
|
};
|
|
7507
7626
|
/** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */
|
|
@@ -8051,12 +8170,12 @@ interface components {
|
|
|
8051
8170
|
Error?: components["schemas"]["ResponseError"];
|
|
8052
8171
|
Space?: components["schemas"]["Space"];
|
|
8053
8172
|
};
|
|
8054
|
-
/** @description
|
|
8173
|
+
/** @description The body of an error response: the error as data (Error), and as one string (message) for clients written before Error. */
|
|
8055
8174
|
StandardErrorResponse: {
|
|
8056
|
-
/** @description HTTP status
|
|
8057
|
-
|
|
8058
|
-
/** @description
|
|
8059
|
-
|
|
8175
|
+
/** @description The error: its message, category (Type), HTTP status, details, and structured items. */
|
|
8176
|
+
Error?: components["schemas"]["ResponseError"];
|
|
8177
|
+
/** @description The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error. */
|
|
8178
|
+
message?: string;
|
|
8060
8179
|
};
|
|
8061
8180
|
Subjects: {
|
|
8062
8181
|
GroupIDs?: {
|
|
@@ -13594,7 +13713,7 @@ interface operations {
|
|
|
13594
13713
|
* An example conjunction is:
|
|
13595
13714
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13596
13715
|
*
|
|
13597
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13716
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13598
13717
|
*
|
|
13599
13718
|
* The whole string must be query-encoded.
|
|
13600
13719
|
*/
|
|
@@ -13798,7 +13917,7 @@ interface operations {
|
|
|
13798
13917
|
* An example conjunction is:
|
|
13799
13918
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13800
13919
|
*
|
|
13801
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13920
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13802
13921
|
*
|
|
13803
13922
|
* The whole string must be query-encoded.
|
|
13804
13923
|
*/
|
|
@@ -13964,6 +14083,7 @@ interface operations {
|
|
|
13964
14083
|
} | null;
|
|
13965
14084
|
PriorRevisions?: string | null;
|
|
13966
14085
|
ReleasePriorRevisions?: string | null;
|
|
14086
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
13967
14087
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13968
14088
|
Slug?: string | null;
|
|
13969
14089
|
/** Format: uuid */
|
|
@@ -14102,7 +14222,7 @@ interface operations {
|
|
|
14102
14222
|
* An example conjunction is:
|
|
14103
14223
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14104
14224
|
*
|
|
14105
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14225
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14106
14226
|
*
|
|
14107
14227
|
* The whole string must be query-encoded.
|
|
14108
14228
|
*/
|
|
@@ -14304,7 +14424,7 @@ interface operations {
|
|
|
14304
14424
|
* An example conjunction is:
|
|
14305
14425
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14306
14426
|
*
|
|
14307
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14427
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14308
14428
|
*
|
|
14309
14429
|
* The whole string must be query-encoded.
|
|
14310
14430
|
*/
|
|
@@ -14408,6 +14528,7 @@ interface operations {
|
|
|
14408
14528
|
} | null;
|
|
14409
14529
|
PriorRevisions?: string | null;
|
|
14410
14530
|
ReleasePriorRevisions?: string | null;
|
|
14531
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
14411
14532
|
/** @description Unique URL-safe identifier for the entity. */
|
|
14412
14533
|
Slug?: string | null;
|
|
14413
14534
|
/** Format: uuid */
|
|
@@ -30566,7 +30687,7 @@ interface operations {
|
|
|
30566
30687
|
* An example conjunction is:
|
|
30567
30688
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30568
30689
|
*
|
|
30569
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
30690
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
30570
30691
|
*
|
|
30571
30692
|
* The whole string must be query-encoded.
|
|
30572
30693
|
*/
|
|
@@ -31181,6 +31302,7 @@ interface operations {
|
|
|
31181
31302
|
} | null;
|
|
31182
31303
|
PriorRevisions?: string | null;
|
|
31183
31304
|
ReleasePriorRevisions?: string | null;
|
|
31305
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
31184
31306
|
/** @description Unique URL-safe identifier for the entity. */
|
|
31185
31307
|
Slug?: string | null;
|
|
31186
31308
|
/** Format: uuid */
|
|
@@ -38076,13 +38198,13 @@ interface operations {
|
|
|
38076
38198
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
38077
38199
|
};
|
|
38078
38200
|
};
|
|
38079
|
-
/** @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 */
|
|
38201
|
+
/** @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. Error says why, Message repeats its message, and Gates lists each ReleasePrerequisite evaluated. */
|
|
38080
38202
|
422: {
|
|
38081
38203
|
headers: {
|
|
38082
38204
|
[name: string]: unknown;
|
|
38083
38205
|
};
|
|
38084
38206
|
content: {
|
|
38085
|
-
"application/json": components["schemas"]["
|
|
38207
|
+
"application/json": components["schemas"]["ReleasePublishResponse"];
|
|
38086
38208
|
};
|
|
38087
38209
|
};
|
|
38088
38210
|
/** @description Something went wrong while processing Release. */
|
package/dist/index.d.ts
CHANGED
|
@@ -3954,7 +3954,84 @@ interface components {
|
|
|
3954
3954
|
SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][];
|
|
3955
3955
|
Subjects?: components["schemas"]["AttestationSubject"][];
|
|
3956
3956
|
};
|
|
3957
|
+
AttestationGateCaller: {
|
|
3958
|
+
/** @description How many of the Revisions evaluated the caller wrote part of. */
|
|
3959
|
+
AuthoredRevisions?: number;
|
|
3960
|
+
/** @description A Pass the caller records would count on every Revision evaluated. */
|
|
3961
|
+
Counts?: boolean;
|
|
3962
|
+
/** @description Why it would not: NotEligible, when the prerequisite names neither the caller nor a Group of theirs, or Author, when the caller wrote part of the change on some Revision. */
|
|
3963
|
+
Reason?: string;
|
|
3964
|
+
};
|
|
3965
|
+
AttestationGateEntry: {
|
|
3966
|
+
/**
|
|
3967
|
+
* Format: uuid
|
|
3968
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3969
|
+
*/
|
|
3970
|
+
AttestationID?: string;
|
|
3971
|
+
/** @description How many of the Revisions evaluated it counts on. A Fail that counts rejects them. */
|
|
3972
|
+
CountedOn?: number;
|
|
3973
|
+
/**
|
|
3974
|
+
* Format: date-time
|
|
3975
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
3976
|
+
*/
|
|
3977
|
+
CreatedAt?: string;
|
|
3978
|
+
/** @description Why it counts on none of the Revisions it covers: Revoked, Expired, TooOld (older than MaxAge), NotEligible, Author, or FailIgnored (a Fail, under IgnoreFail). */
|
|
3979
|
+
Reason?: string;
|
|
3980
|
+
/** @description Pass or Fail. */
|
|
3981
|
+
Result?: string;
|
|
3982
|
+
/**
|
|
3983
|
+
* Format: uuid
|
|
3984
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3985
|
+
*/
|
|
3986
|
+
UserID?: string;
|
|
3987
|
+
/**
|
|
3988
|
+
* Format: date-time
|
|
3989
|
+
* @description When it stops counting: the earlier of its ExpiresAt and its CreatedAt plus the prerequisite's MaxAge. Absent when neither is set.
|
|
3990
|
+
*/
|
|
3991
|
+
ValidUntil?: string | null;
|
|
3992
|
+
};
|
|
3993
|
+
AttestationGateResult: {
|
|
3994
|
+
/** @description Every Attestation of Type covering a Revision evaluated, directly or carried forward from an earlier Revision of the same Unit with the same DataHash, and what became of it. */
|
|
3995
|
+
Attestations?: components["schemas"]["AttestationGateEntry"][];
|
|
3996
|
+
/** @description Users excluded from counting on some Revision because they wrote part of the change there. Empty with AllowAuthors. */
|
|
3997
|
+
AuthorUserIDs?: components["schemas"]["UUID"][];
|
|
3998
|
+
/** @description Whether a Pass recorded by the caller would count here. */
|
|
3999
|
+
Caller?: components["schemas"]["AttestationGateCaller"];
|
|
4000
|
+
/** @description The fewest attesters counted on any Revision evaluated: the gate's progress toward Required. */
|
|
4001
|
+
Counted?: number;
|
|
4002
|
+
/** @description How many distinct attesters each Revision needs: Count, or the number of FromGroupIDs with DistinctGroups. */
|
|
4003
|
+
Required?: number;
|
|
4004
|
+
/** @description How many Revisions were evaluated: one of each Unit the change changed in the Space, or each Revision a Release bundles. */
|
|
4005
|
+
Revisions?: number;
|
|
4006
|
+
/** @description How many of them have what the prerequisite asks for. */
|
|
4007
|
+
SatisfiedRevisions?: number;
|
|
4008
|
+
/** @description More Revisions fall short than Unsatisfied lists. */
|
|
4009
|
+
Truncated?: boolean;
|
|
4010
|
+
/** @description The Attestation Type the prerequisite counts. */
|
|
4011
|
+
Type?: string;
|
|
4012
|
+
/** @description The Revisions that fall short, at most 100. */
|
|
4013
|
+
Unsatisfied?: components["schemas"]["AttestationGateRevision"][];
|
|
4014
|
+
};
|
|
4015
|
+
AttestationGateRevision: {
|
|
4016
|
+
/** @description Users excluded from counting on this Revision because they wrote part of the change on this Unit. Empty with AllowAuthors. */
|
|
4017
|
+
AuthorUserIDs?: components["schemas"]["UUID"][];
|
|
4018
|
+
/** @description Distinct attesters counted on this Revision. */
|
|
4019
|
+
Counted?: number;
|
|
4020
|
+
/** @description AttestationsMissing or AttestationRejected. */
|
|
4021
|
+
Reason?: string;
|
|
4022
|
+
/** Format: int64 */
|
|
4023
|
+
RevisionNum?: number;
|
|
4024
|
+
/**
|
|
4025
|
+
* Format: uuid
|
|
4026
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4027
|
+
*/
|
|
4028
|
+
UnitID?: string;
|
|
4029
|
+
UnitSlug?: string;
|
|
4030
|
+
};
|
|
3957
4031
|
AttestationSkippedUnit: {
|
|
4032
|
+
/** @description Why the Unit is not covered, in words. */
|
|
4033
|
+
Message?: string;
|
|
4034
|
+
/** @description Why the Unit is not covered, as a code: NoTarget or NoRevision. */
|
|
3958
4035
|
Reason?: string;
|
|
3959
4036
|
/**
|
|
3960
4037
|
* Format: uuid
|
|
@@ -3964,6 +4041,8 @@ interface components {
|
|
|
3964
4041
|
UnitSlug?: string;
|
|
3965
4042
|
};
|
|
3966
4043
|
AttestationSubject: {
|
|
4044
|
+
/** @description With a ChangeOrder, the caller wrote one of the Revisions of the change on this Unit in this Space, so the Attestation does not count here for a prerequisite that excludes authors. */
|
|
4045
|
+
Authored?: boolean;
|
|
3967
4046
|
/**
|
|
3968
4047
|
* Format: uuid
|
|
3969
4048
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
@@ -4459,7 +4538,9 @@ interface components {
|
|
|
4459
4538
|
readonly RestoreTagID?: string;
|
|
4460
4539
|
/** @description RestoredSpaceIDs is where the ChangeOrder has been undone: the Spaces whose Units all carry the restore Tag. Derived when the ChangeOrder is read. */
|
|
4461
4540
|
readonly RestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
4462
|
-
/** @description
|
|
4541
|
+
/** @description ReviewRequests records whose review the change is waiting for: for each, the stage whose Spaces are to be reviewed (empty for the change order's own Space), the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */
|
|
4542
|
+
ReviewRequests?: components["schemas"]["ChangeOrderReviewRequest"][];
|
|
4543
|
+
/** @description SkippedUnits names the Units of the ChangeOrder's Space that it carries no Revisions of, mapped to the reason as a code: NotFollowed (nothing follows the Unit by Links of the change order's UpdateType, and it was never cloned), FollowedByOtherLinks (it is followed downstream, but not by Links of that UpdateType), NotMarked (the end Tag marks no Revision of it), NoStartRevision (a Link to it has never merged or resolved, and it predates empty start Revisions), AlreadyTaken (the Spaces in scope have already taken it as far as the end, so it is marked, carrying no Revisions), or TakenPastEnd (the Spaces in scope have taken it past the end, so it is not marked). Written when the scope is derived. */
|
|
4463
4544
|
readonly SkippedUnits?: {
|
|
4464
4545
|
[key: string]: string;
|
|
4465
4546
|
};
|
|
@@ -4632,6 +4713,7 @@ interface components {
|
|
|
4632
4713
|
Action?: string;
|
|
4633
4714
|
Error?: string;
|
|
4634
4715
|
Links?: components["schemas"]["ChangeOrderPromotionFailureLink"][];
|
|
4716
|
+
Message?: string;
|
|
4635
4717
|
Reason?: string;
|
|
4636
4718
|
/**
|
|
4637
4719
|
* Format: uuid
|
|
@@ -4686,6 +4768,28 @@ interface components {
|
|
|
4686
4768
|
*/
|
|
4687
4769
|
SpaceID?: string;
|
|
4688
4770
|
};
|
|
4771
|
+
ChangeOrderReviewRequest: {
|
|
4772
|
+
/**
|
|
4773
|
+
* Format: date-time
|
|
4774
|
+
* @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time.
|
|
4775
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4776
|
+
*/
|
|
4777
|
+
RequestedAt?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* Format: uuid
|
|
4780
|
+
* @description Who requested the review, or last re-requested it. Set by the server.
|
|
4781
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4782
|
+
*/
|
|
4783
|
+
readonly RequestedByUserID?: string;
|
|
4784
|
+
/** @description The stage whose Spaces are to be reviewed, which is where an Attestation recorded with that TargetStage goes. Empty is the change order's own Space. */
|
|
4785
|
+
Stage?: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* Format: uuid
|
|
4788
|
+
* @description The User asked to review.
|
|
4789
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4790
|
+
*/
|
|
4791
|
+
UserID: string;
|
|
4792
|
+
};
|
|
4689
4793
|
ChangeOrderSpaceContainerImages: {
|
|
4690
4794
|
/** @description The images that changed, by Unit, resource, and path. */
|
|
4691
4795
|
Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
|
|
@@ -5351,7 +5455,7 @@ interface components {
|
|
|
5351
5455
|
/** @description Demote, Unchanged, Skipped, or Failed. */
|
|
5352
5456
|
Action?: string;
|
|
5353
5457
|
Error?: components["schemas"]["ResponseError"];
|
|
5354
|
-
/** @description
|
|
5458
|
+
/** @description For Skipped: NotMarked, when the change order marks no Unit of the Space. */
|
|
5355
5459
|
Reason?: string;
|
|
5356
5460
|
/**
|
|
5357
5461
|
* Format: uuid
|
|
@@ -6839,10 +6943,14 @@ interface components {
|
|
|
6839
6943
|
[key: string]: components["schemas"]["Subjects"];
|
|
6840
6944
|
};
|
|
6841
6945
|
PromoteGateResult: {
|
|
6946
|
+
/** @description For an attestation prerequisite, what was counted, whether or not the gate holds. */
|
|
6947
|
+
Attestation?: components["schemas"]["AttestationGateResult"];
|
|
6842
6948
|
/** @description Why the gate does not hold. */
|
|
6843
6949
|
Message?: string;
|
|
6844
|
-
/** @description Promoted, Validated, Released, Healthy, or a custom prerequisite
|
|
6950
|
+
/** @description Promoted, Validated, Released, Healthy, or the name of a custom or attestation prerequisite. */
|
|
6845
6951
|
Prerequisite?: string;
|
|
6952
|
+
/** @description Why the gate does not hold, as a code: NotPromoted, PreviousStageEmpty, NotReleased, ValidationErrors, NotMarked, NoReleaseTarget, NoRelease, NoLiveStatus, NotSynced, Deploying, DeployFailed, Unhealthy, AttestationsMissing, AttestationRejected, ExpressionFalse, EvaluationFailed, or UnknownPrerequisite. A client that does not know a code shows Message. */
|
|
6953
|
+
Reason?: string;
|
|
6846
6954
|
Satisfied?: boolean;
|
|
6847
6955
|
/**
|
|
6848
6956
|
* Format: uuid
|
|
@@ -6862,6 +6970,9 @@ interface components {
|
|
|
6862
6970
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6863
6971
|
*/
|
|
6864
6972
|
LinkID?: string;
|
|
6973
|
+
/** @description Why the Link was skipped or orphaned, in words. */
|
|
6974
|
+
Message?: string;
|
|
6975
|
+
/** @description Adopted for an Unchanged Link, TargetUnitMissing for a Skip, or UpstreamLinkDeleted for an Orphaned one. */
|
|
6865
6976
|
Reason?: string;
|
|
6866
6977
|
Slug?: string;
|
|
6867
6978
|
ToSpaceSlug?: string;
|
|
@@ -6937,6 +7048,10 @@ interface components {
|
|
|
6937
7048
|
Complete?: boolean;
|
|
6938
7049
|
/** @description True when nothing was written. */
|
|
6939
7050
|
DryRun?: boolean;
|
|
7051
|
+
/** @description Set when the gates refused the promotion: why, with each failed gate's message among its Details. */
|
|
7052
|
+
Error?: components["schemas"]["ResponseError"];
|
|
7053
|
+
/** @description When Complete, the gates of the ChangeWorkflow's Final, evaluated over each Space of the last Stage. The ChangeOrder's Stage becomes Completed once they all hold. */
|
|
7054
|
+
Final?: components["schemas"]["PromoteGateResult"][];
|
|
6940
7055
|
/** @description Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan. */
|
|
6941
7056
|
Plan?: string;
|
|
6942
7057
|
/** @description In the order they were, or would be, promoted: a Space after any selected Space it takes from. */
|
|
@@ -6949,9 +7064,11 @@ interface components {
|
|
|
6949
7064
|
Action?: string;
|
|
6950
7065
|
Error?: components["schemas"]["ResponseError"];
|
|
6951
7066
|
Links?: components["schemas"]["PromoteLinkResult"][];
|
|
7067
|
+
/** @description Why the Space was Skipped or Blocked, in words. */
|
|
7068
|
+
Message?: string;
|
|
6952
7069
|
/** @description A dry run previewed this Space against its upstream as it is now, although the same request promotes that upstream first. */
|
|
6953
7070
|
PreviewedAgainstCurrentUpstream?: boolean;
|
|
6954
|
-
/** @description Why the Space was Skipped or Blocked. */
|
|
7071
|
+
/** @description Why the Space was Skipped or Blocked, as a code: ChangeOrderSpace, NotInScope, UpstreamPromotedFirst, or UpstreamFailed. */
|
|
6955
7072
|
Reason?: string;
|
|
6956
7073
|
/**
|
|
6957
7074
|
* Format: uuid
|
|
@@ -6975,7 +7092,7 @@ interface components {
|
|
|
6975
7092
|
Forced?: boolean;
|
|
6976
7093
|
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
6977
7094
|
Name?: string;
|
|
6978
|
-
/** @description The Stage whose Spaces the gates are evaluated over. Empty for the first Stage,
|
|
7095
|
+
/** @description The Stage whose Spaces the gates are evaluated over. Empty for the first Stage, whose gates are evaluated over the change order's own Space. */
|
|
6979
7096
|
PreviousStage?: string;
|
|
6980
7097
|
};
|
|
6981
7098
|
PromoteUnitResult: {
|
|
@@ -7167,7 +7284,7 @@ interface components {
|
|
|
7167
7284
|
* @description Monotonically increasing sequence number of the Release within its Target, assigned at publish time. The highest ReleaseNum is the latest Release for the Target.
|
|
7168
7285
|
*/
|
|
7169
7286
|
readonly ReleaseNum?: number;
|
|
7170
|
-
/** @description SkippedUnits names the Units assigned to the Release's Target that the Release does not bundle, mapped to the reason.
|
|
7287
|
+
/** @description SkippedUnits names the Units assigned to the Release's Target that the Release does not bundle, mapped to the reason as a code. NotMarked: publishing with a TagID leaves out a Unit that has never been released and that the Tag marks no Revision of; a Unit that has been released must be marked. (readonly) */
|
|
7171
7288
|
readonly SkippedUnits?: {
|
|
7172
7289
|
[key: string]: string;
|
|
7173
7290
|
};
|
|
@@ -7285,7 +7402,11 @@ interface components {
|
|
|
7285
7402
|
TagID?: string;
|
|
7286
7403
|
};
|
|
7287
7404
|
ReleasePublishResponse: {
|
|
7288
|
-
/** @description
|
|
7405
|
+
/** @description Why the Release was not published. */
|
|
7406
|
+
Error?: components["schemas"]["ResponseError"];
|
|
7407
|
+
/** @description For a change order, each ReleasePrerequisite of the stage the Space belongs to, evaluated over the Revisions the Release bundles, whether or not it holds. */
|
|
7408
|
+
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
7409
|
+
/** @description Why no Release was created: nothing changed since the latest published Release, or, on a refusal, the error as one string. */
|
|
7289
7410
|
Message?: string;
|
|
7290
7411
|
/** @description The published Release, or the latest published Release when no Release was created. */
|
|
7291
7412
|
Release?: components["schemas"]["Release"];
|
|
@@ -7493,15 +7614,13 @@ interface components {
|
|
|
7493
7614
|
ResponseError: {
|
|
7494
7615
|
/** @description Additional context messages */
|
|
7495
7616
|
Details?: string[];
|
|
7496
|
-
/** @description The type of error (e.g., validation, not-found) */
|
|
7497
|
-
ErrorCategory?: string;
|
|
7498
7617
|
/** @description Structured error details like field violations */
|
|
7499
7618
|
ErrorMetadata?: components["schemas"]["ErrorMetadata"];
|
|
7500
7619
|
/** @description The primary error message */
|
|
7501
7620
|
Message?: string;
|
|
7502
7621
|
/** @description HTTP status code */
|
|
7503
7622
|
Status?: number;
|
|
7504
|
-
/** @description The
|
|
7623
|
+
/** @description The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable */
|
|
7505
7624
|
Type?: string;
|
|
7506
7625
|
};
|
|
7507
7626
|
/** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */
|
|
@@ -8051,12 +8170,12 @@ interface components {
|
|
|
8051
8170
|
Error?: components["schemas"]["ResponseError"];
|
|
8052
8171
|
Space?: components["schemas"]["Space"];
|
|
8053
8172
|
};
|
|
8054
|
-
/** @description
|
|
8173
|
+
/** @description The body of an error response: the error as data (Error), and as one string (message) for clients written before Error. */
|
|
8055
8174
|
StandardErrorResponse: {
|
|
8056
|
-
/** @description HTTP status
|
|
8057
|
-
|
|
8058
|
-
/** @description
|
|
8059
|
-
|
|
8175
|
+
/** @description The error: its message, category (Type), HTTP status, details, and structured items. */
|
|
8176
|
+
Error?: components["schemas"]["ResponseError"];
|
|
8177
|
+
/** @description The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error. */
|
|
8178
|
+
message?: string;
|
|
8060
8179
|
};
|
|
8061
8180
|
Subjects: {
|
|
8062
8181
|
GroupIDs?: {
|
|
@@ -13594,7 +13713,7 @@ interface operations {
|
|
|
13594
13713
|
* An example conjunction is:
|
|
13595
13714
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13596
13715
|
*
|
|
13597
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13716
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13598
13717
|
*
|
|
13599
13718
|
* The whole string must be query-encoded.
|
|
13600
13719
|
*/
|
|
@@ -13798,7 +13917,7 @@ interface operations {
|
|
|
13798
13917
|
* An example conjunction is:
|
|
13799
13918
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13800
13919
|
*
|
|
13801
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13920
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13802
13921
|
*
|
|
13803
13922
|
* The whole string must be query-encoded.
|
|
13804
13923
|
*/
|
|
@@ -13964,6 +14083,7 @@ interface operations {
|
|
|
13964
14083
|
} | null;
|
|
13965
14084
|
PriorRevisions?: string | null;
|
|
13966
14085
|
ReleasePriorRevisions?: string | null;
|
|
14086
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
13967
14087
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13968
14088
|
Slug?: string | null;
|
|
13969
14089
|
/** Format: uuid */
|
|
@@ -14102,7 +14222,7 @@ interface operations {
|
|
|
14102
14222
|
* An example conjunction is:
|
|
14103
14223
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14104
14224
|
*
|
|
14105
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14225
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14106
14226
|
*
|
|
14107
14227
|
* The whole string must be query-encoded.
|
|
14108
14228
|
*/
|
|
@@ -14304,7 +14424,7 @@ interface operations {
|
|
|
14304
14424
|
* An example conjunction is:
|
|
14305
14425
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14306
14426
|
*
|
|
14307
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14427
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
14308
14428
|
*
|
|
14309
14429
|
* The whole string must be query-encoded.
|
|
14310
14430
|
*/
|
|
@@ -14408,6 +14528,7 @@ interface operations {
|
|
|
14408
14528
|
} | null;
|
|
14409
14529
|
PriorRevisions?: string | null;
|
|
14410
14530
|
ReleasePriorRevisions?: string | null;
|
|
14531
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
14411
14532
|
/** @description Unique URL-safe identifier for the entity. */
|
|
14412
14533
|
Slug?: string | null;
|
|
14413
14534
|
/** Format: uuid */
|
|
@@ -30566,7 +30687,7 @@ interface operations {
|
|
|
30566
30687
|
* An example conjunction is:
|
|
30567
30688
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30568
30689
|
*
|
|
30569
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
30690
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
30570
30691
|
*
|
|
30571
30692
|
* The whole string must be query-encoded.
|
|
30572
30693
|
*/
|
|
@@ -31181,6 +31302,7 @@ interface operations {
|
|
|
31181
31302
|
} | null;
|
|
31182
31303
|
PriorRevisions?: string | null;
|
|
31183
31304
|
ReleasePriorRevisions?: string | null;
|
|
31305
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
31184
31306
|
/** @description Unique URL-safe identifier for the entity. */
|
|
31185
31307
|
Slug?: string | null;
|
|
31186
31308
|
/** Format: uuid */
|
|
@@ -38076,13 +38198,13 @@ interface operations {
|
|
|
38076
38198
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
38077
38199
|
};
|
|
38078
38200
|
};
|
|
38079
|
-
/** @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 */
|
|
38201
|
+
/** @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. Error says why, Message repeats its message, and Gates lists each ReleasePrerequisite evaluated. */
|
|
38080
38202
|
422: {
|
|
38081
38203
|
headers: {
|
|
38082
38204
|
[name: string]: unknown;
|
|
38083
38205
|
};
|
|
38084
38206
|
content: {
|
|
38085
|
-
"application/json": components["schemas"]["
|
|
38207
|
+
"application/json": components["schemas"]["ReleasePublishResponse"];
|
|
38086
38208
|
};
|
|
38087
38209
|
};
|
|
38088
38210
|
/** @description Something went wrong while processing Release. */
|