Skip to content

Commit bf0b2d2

Browse files
committed
Docs: Add XML docs to governance enums
1 parent a734206 commit bf0b2d2

9 files changed

Lines changed: 124 additions & 0 deletions

src/Governance/Abstractions/Approval/Model/MutationApprovalRequirementStatus.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,24 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Approval.Model;
55
/// </summary>
66
public enum MutationApprovalRequirementStatus
77
{
8+
/// <summary>
9+
/// The approval requirement is still waiting for a decision.
10+
/// </summary>
811
Pending = 0,
12+
/// <summary>
13+
/// The approval requirement has been approved.
14+
/// </summary>
915
Approved = 1,
16+
/// <summary>
17+
/// The approval requirement has been rejected.
18+
/// </summary>
1019
Rejected = 2,
20+
/// <summary>
21+
/// The approval requirement has been satisfied by quorum or equivalent policy.
22+
/// </summary>
1123
Satisfied = 3,
24+
/// <summary>
25+
/// The approval requirement expired before it was resolved.
26+
/// </summary>
1227
Expired = 4
1328
}

src/Governance/Abstractions/Lifecycle/Model/MutationRequestStatus.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,36 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Lifecycle.Model;
55
/// </summary>
66
public enum MutationRequestStatus
77
{
8+
/// <summary>
9+
/// The request has been created but not yet processed.
10+
/// </summary>
811
Created = 0,
12+
/// <summary>
13+
/// The request is waiting for an external governance condition.
14+
/// </summary>
915
Pending = 1,
16+
/// <summary>
17+
/// The request has been approved and may proceed to execution.
18+
/// </summary>
1019
Approved = 2,
20+
/// <summary>
21+
/// The request has been rejected and will not proceed.
22+
/// </summary>
1123
Rejected = 3,
24+
/// <summary>
25+
/// The request has been canceled by an explicit action.
26+
/// </summary>
1227
Canceled = 4,
28+
/// <summary>
29+
/// The request expired before it could be completed.
30+
/// </summary>
1331
Expired = 5,
32+
/// <summary>
33+
/// The request has been superseded by another request.
34+
/// </summary>
1435
Superseded = 6,
36+
/// <summary>
37+
/// The request has been executed successfully.
38+
/// </summary>
1539
Executed = 7
1640
}

src/Governance/Abstractions/Lifecycle/Model/PendingMutationReason.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,9 @@ public enum PendingMutationReason
3434
/// The request is waiting for manual review.
3535
/// </summary>
3636
ManualReview = 5,
37+
38+
/// <summary>
39+
/// The request is pending because it must be revalidated against the latest state before execution.
40+
/// </summary>
3741
Revalidation = 6
3842
}

src/Governance/Abstractions/Requests/Decisions/MutationRequestApprovalDecisionType.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,24 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Requests.Decisions;
55
/// </summary>
66
public enum MutationRequestApprovalDecisionType
77
{
8+
/// <summary>
9+
/// The approval requirement was requested.
10+
/// </summary>
811
Requested = 0,
12+
/// <summary>
13+
/// The approval requirement was granted.
14+
/// </summary>
915
Granted = 1,
16+
/// <summary>
17+
/// The approval requirement was rejected.
18+
/// </summary>
1019
Rejected = 2,
20+
/// <summary>
21+
/// The approval quorum for a group was satisfied.
22+
/// </summary>
1123
QuorumSatisfied = 3,
24+
/// <summary>
25+
/// The approval requirement expired.
26+
/// </summary>
1227
Expired = 4
1328
}

src/Governance/Abstractions/Requests/Decisions/MutationRequestDecisionCategory.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Requests.Decisions;
55
/// </summary>
66
public enum MutationRequestDecisionCategory
77
{
8+
/// <summary>
9+
/// Lifecycle decisions describe request state transitions.
10+
/// </summary>
811
Lifecycle = 0,
12+
/// <summary>
13+
/// Approval decisions describe request-level approval processing.
14+
/// </summary>
915
Approval = 1,
16+
/// <summary>
17+
/// Version-resolution decisions describe stale and version-aware handling.
18+
/// </summary>
1019
VersionResolution = 2
1120
}

src/Governance/Abstractions/Requests/Decisions/MutationRequestLifecycleDecisionType.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,36 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Requests.Decisions;
55
/// </summary>
66
public enum MutationRequestLifecycleDecisionType
77
{
8+
/// <summary>
9+
/// The request was submitted into the governance system.
10+
/// </summary>
811
Submitted = 0,
12+
/// <summary>
13+
/// The request entered a pending lifecycle state.
14+
/// </summary>
915
Pending = 1,
16+
/// <summary>
17+
/// The request was approved.
18+
/// </summary>
1019
Approved = 2,
20+
/// <summary>
21+
/// The request was rejected.
22+
/// </summary>
1123
Rejected = 3,
24+
/// <summary>
25+
/// The request was canceled.
26+
/// </summary>
1227
Canceled = 4,
28+
/// <summary>
29+
/// The request expired before completion.
30+
/// </summary>
1331
Expired = 5,
32+
/// <summary>
33+
/// The request was superseded by another request.
34+
/// </summary>
1435
Superseded = 6,
36+
/// <summary>
37+
/// The request executed successfully.
38+
/// </summary>
1539
Executed = 7
1640
}

src/Governance/Abstractions/Requests/Decisions/MutationRequestVersionResolutionDecisionType.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,20 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Requests.Decisions;
55
/// </summary>
66
public enum MutationRequestVersionResolutionDecisionType
77
{
8+
/// <summary>
9+
/// The request version matched the current state version.
10+
/// </summary>
811
Validated = 0,
12+
/// <summary>
13+
/// The request must be revalidated against the latest state.
14+
/// </summary>
915
RevalidationRequired = 1,
16+
/// <summary>
17+
/// The request must obtain renewed approval before proceeding.
18+
/// </summary>
1019
RenewedApprovalRequired = 2,
20+
/// <summary>
21+
/// The request was rejected because it was stale.
22+
/// </summary>
1123
RejectedAsStale = 3
1224
}

src/Governance/Abstractions/Resolution/Model/MutationRequestVersionResolutionOutcome.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,20 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Resolution.Model;
55
/// </summary>
66
public enum MutationRequestVersionResolutionOutcome
77
{
8+
/// <summary>
9+
/// The request can be executed with its approved version.
10+
/// </summary>
811
ExecuteApprovedVersion = 0,
12+
/// <summary>
13+
/// The request should be revalidated on the latest state.
14+
/// </summary>
915
RevalidateOnLatestState = 1,
16+
/// <summary>
17+
/// The request was rejected as stale.
18+
/// </summary>
1019
RejectedAsStale = 2,
20+
/// <summary>
21+
/// The request requires renewed approval.
22+
/// </summary>
1123
RequiresRenewedApproval = 3
1224
}

src/Governance/Abstractions/Resolution/Strategies/VersionedRequestResolutionStrategy.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,16 @@ namespace ModularityKit.Mutator.Governance.Abstractions.Resolution.Strategies;
55
/// </summary>
66
public enum VersionedRequestResolutionStrategy
77
{
8+
/// <summary>
9+
/// Reject the request if the observed state version differs from the expected version.
10+
/// </summary>
811
RejectStale = 0,
12+
/// <summary>
13+
/// Send the request back through approval when the state has drifted.
14+
/// </summary>
915
RequireRenewedApproval = 1,
16+
/// <summary>
17+
/// Revalidate the request against the latest state before execution.
18+
/// </summary>
1019
RevalidateOnLatestState = 2
1120
}

0 commit comments

Comments
 (0)