Skip to content
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.

Sign up for GitHub

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

Common.DraftXxx: sync with RAP implementation #192

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Common.DraftXxx: sync with RAP implementation #192

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
2e0d168
Common.DraftXxx: sync with RAP implementation
ralfhandl Jul 20, 2022
a7f0b8f
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Jul 25, 2022
3850ff7
Improved descriptions
ralfhandl Jul 25, 2022
b1eefa6
Renzo's proposal
ralfhandl Jul 25, 2022
a699c32
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Dec 15, 2022
b9d5b00
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Jan 10, 2023
9f8a5d4
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Apr 27, 2023
08d5e5d
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Nov 29, 2024
8042008
Apply suggestions from code review
ralfhandl Nov 29, 2024
c941c4e
auto-refreshed
ralfhandl Nov 29, 2024
d28dfd7
Merge branch 'main' into fix/Common.DraftXxx
ralfhandl Dec 3, 2024
49dd3a9
Deprecate term DraftNode
ralfhandl Dec 3, 2024
c58f4cf
ResumeAction
HeikoTheissen Jan 16, 2025
22ff169
Merge remote-tracking branch 'origin/main' into fix/Common.DraftXxx
HeikoTheissen Jan 16, 2025
d256df7
experimental
HeikoTheissen Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions vocabularies/Common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,39 +1197,43 @@
"DraftRootType": {
"$Kind": "ComplexType",
"$BaseType": "Common.DraftNodeType",
"PreparationAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Core.Description": "Action that prepares a draft document for later activation"
},
"ActivationAction": {
"$Type": "Common.QualifiedName",
"@Core.Description": "Action that activates a draft document"
},
"DiscardAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Common.Experimental": true,
"@Core.Description": "Action that discards a draft document"
},
"EditAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Core.Description": "Action that creates an edit draft"
"@Core.Description": "Action that creates an edit draft",
"@Core.LongDescription": "The action is bound to the active document root node and has the following signature:\n\n - `PreserveChanges`: optional, of type `Boolean`, `true` means that an outdated draft of another user is not overwritten"
},
"NewAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Core.Description": "Action that creates a new draft",
"@Core.LongDescription": "New drafts may also be created by POSTing an empty entity without any properties to the entity set."
"@Core.LongDescription": "The action is bound to the draft document root entity set and has the following signature:\n\n - `ResultIsActiveEntity` of type `Boolean` with default `false`, `true` means that an active entity is created\n\n New drafts may also be created by POSTing an empty entity without any properties to the entity set."
},
"AdditionalNewActions": {
"$Collection": true,
"$Type": "Common.QualifiedName",
"@Common.Experimental": true,
"@Core.Description": "Additional actions that create a new draft",
"@Core.LongDescription": "Additional actions beside the default POST or standard `NewAction` that create a new draft."
"@Core.Description": "Additional actions beside the default POST or standard `NewAction`that create a new draft",
"@Core.LongDescription": "The actions are bound to the draft document root entity set and have the following signature:\n\n - `ResultIsActiveEntity` of type `Boolean` with default `false`, `true` means that an active entity is created"
},
"ShareAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Core.Description": "Action that shares a draft document with other users",
"@Core.LongDescription": "The action is bound to the draft document root node and has the following signature:\n\n - `Users`: collection of structure with properties\n\n   - `UserID` of type `String` and\n\n   - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)\n\n It restricts access to the listed users in their specified roles."
"@Core.Description": "Action that shares a draft document with other users and restricts access to the listed users in their specified roles",
"@Core.LongDescription": "The action is bound to the draft document root node and has the following signature:\n\n - `Users`: collection of structure with properties\n\n   ◦ `UserID` of type `String`\n\n   ◦ `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)\n\n - `ShareAll` of type `Boolean` with default value `false`, `true` means sharing with all users that are authorized to create drafts;\n the `Users` parameter is optional in this case, provide it to actively notify the listed users"
}
},
"DraftNode": {
Expand All @@ -1245,6 +1249,12 @@
"PreparationAction": {
"$Type": "Common.QualifiedName",
"$Nullable": true,
"@Core.Revisions": [
{
"Kind": "Deprecated",
"Description": "Preparation is always called on the draft root node"
}
],
"@Core.Description": "Action that prepares a draft document for later activation"
},
"ValidationFunction": {
Expand Down
Loading