-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat!: Add WITHDRAWN state to Requisition #212
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @SanjayVas)
src/main/proto/wfa/measurement/api/v2alpha/requisition.proto
line 187 at r1 (raw file):
// `measurement` will be in the `FAILED` state. REFUSED = 3; // The `Requisition` has been withdrawn. Terminal state.
should this be
The `Requisition` has been withdrawn by a party other than the `DataProvider`. Terminal State.
Also, this will mean that the measurement
will be in the FAILED
state, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @SanjayVas)
src/main/proto/wfa/measurement/api/v2alpha/requisition.proto
line 187 at r1 (raw file):
Previously, stevenwarejones (Steven Ware Jones) wrote…
should this be
The `Requisition` has been withdrawn by a party other than the `DataProvider`. Terminal State.
Also, this will mean that the
measurement
will be in theFAILED
state, correct?
my wording makes an assumption that the operator may want the ability to withdraw. If we don't want to cover that use case for now, we could just comment that this means it was withdrawn by the MC.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @stevenwarejones)
src/main/proto/wfa/measurement/api/v2alpha/requisition.proto
line 187 at r1 (raw file):
Previously, stevenwarejones (Steven Ware Jones) wrote…
my wording makes an assumption that the operator may want the ability to withdraw. If we don't want to cover that use case for now, we could just comment that this means it was withdrawn by the MC.
The existing wording is correct, IMO. The DataProvider
cannot withdraw a Requisition themselves, as is apparent by the lack of a WithdrawRequisition method. They can instead refuse.
This intentionally does not enumerate all the conditions that can result in a Requisition being withdrawn. At the moment, this can happen any time the Measurement transitions to FAILED or CANCELLED. This is not limited to MC cancellation, and can include a different EDP refusing their Requisition, a Duchy indicating a failure, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed 1 of 1 files at r1.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @SanjayVas)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dismissed @stevenwarejones from a discussion.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @SanjayVas)
This change should generally be safe for DataProvider integrators:
Requisition.State.UNFULFILLED
UNRECOGNIZED
value for every protobuf enum.