Skip to content

Commit a103636

Browse files
committed
feat: Add three states to document submission and change the names to more align with intent vs business logic behaviour.
1 parent 2191d7f commit a103636

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

specs/signed_docs/docs/payload_schemas/proposal_submission_action.schema.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@
2020
"type": "string",
2121
"description": "The action being performed on the Proposal.",
2222
"enum": [
23-
"submission",
24-
"retraction"
23+
"final",
24+
"draft",
25+
"hide"
2526
]
2627
}
2728
},

specs/signed_docs/docs/proposal_submission_action.cue

+7
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,13 @@ docs: #DocumentDefinitions & {
3838
description: """
3939
The kind of action is controlled by this payload.
4040
The Payload is a JSON Document, and must conform to this schema.
41+
42+
States:
43+
44+
* `final` : All collaborators must publish a `final` status for the proposal to be `final`.
45+
* `draft` : Reverses the previous `final` state for a signer.
46+
* `hide` : Requests the proposal be hidden (not final, but a hidden draft).
47+
`hide` is only actioned if sent by the author, for a collaborator its synonymous with `draft`.
4148
"""
4249
schema: _ @embed(file="payload_schemas/proposal_submission_action.schema.json")
4350
}

0 commit comments

Comments
 (0)