-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
NXP-32841: Move Routing Swagger resources
- Loading branch information
Showing
20 changed files
with
731 additions
and
0 deletions.
There are no files selected for viewing
193 changes: 193 additions & 0 deletions
193
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/datatypes/task.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
"task" : { | ||
"id": "task", | ||
"type": "any", | ||
"required": false, | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"id": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"name": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"workflowId": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"state": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"directive": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"created": { | ||
"uniqueItems": false, | ||
"type": "Date", | ||
"required": false | ||
}, | ||
"dueDate": { | ||
"uniqueItems": false, | ||
"type": "Date", | ||
"required": false | ||
}, | ||
"type": { | ||
"uniqueItems": false, | ||
"type": "Date", | ||
"required": false | ||
}, | ||
"nodeName": { | ||
"uniqueItems": false, | ||
"type": "Date", | ||
"required": false | ||
}, | ||
"targetDocumentIds": { | ||
"type": "array", | ||
"items" : { | ||
"type":"string" | ||
}, | ||
"required": false | ||
}, | ||
"actors": { | ||
"type": "array", | ||
"items" : { | ||
"type":"string" | ||
}, | ||
"required": false | ||
}, | ||
"comments": { | ||
"type": "array", | ||
"items":{ | ||
"$ref":"taskComments" | ||
}, | ||
"required": false | ||
}, | ||
"variables": { | ||
"uniqueItems": true, | ||
"type": "container", | ||
"items":{ | ||
"$ref":"Property" | ||
} | ||
}, | ||
"taskInfo": { | ||
"uniqueItems": true, | ||
"type": "taskInfo", | ||
"required": false | ||
} | ||
} | ||
|
||
}, | ||
|
||
"taskInfo" : { | ||
"id": "taskInfo", | ||
"uniqueItems": false, | ||
"properties": { | ||
"actions": { | ||
"uniqueItems": false, | ||
"type": "array", | ||
"items": { | ||
"$ref":"taskAction" | ||
}, | ||
"required": true | ||
}, | ||
"layoutResource": { | ||
"uniqueItems": false, | ||
"type": "layoutResource", | ||
"required": true | ||
} | ||
} | ||
}, | ||
|
||
"layoutResource" : { | ||
"id": "layoutResource", | ||
"uniqueItems": false, | ||
"properties": { | ||
"name": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"url": { | ||
"uniqueItems": false, | ||
"type": "layoutResource", | ||
"required": true | ||
} | ||
} | ||
}, | ||
|
||
"taskComments" : { | ||
"id": "taskComments", | ||
"uniqueItems": false, | ||
"properties": { | ||
"author": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"author": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"date": { | ||
"uniqueItems": false, | ||
"type": "Date", | ||
"required": true | ||
} | ||
} | ||
}, | ||
|
||
"taskAction" : { | ||
"id": "taskAction", | ||
"uniqueItems": false, | ||
"properties": { | ||
"name": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"url": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"label": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
} | ||
} | ||
}, | ||
|
||
"tasks" : { | ||
"id": "tasks", | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"entries": { | ||
"uniqueItems": false, | ||
"type": "array", | ||
"items": { | ||
"$ref":"task" | ||
}, | ||
"required": true | ||
} | ||
} | ||
}, |
40 changes: 40 additions & 0 deletions
40
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/datatypes/taskCompletionRequest.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
"taskCompletionRequest" : { | ||
"id": "taskCompletionRequest", | ||
"type": "any", | ||
"required": false, | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true, | ||
"enum": ["task"] | ||
}, | ||
"id": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"comment": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"nodeVariables": { | ||
"uniqueItems": true, | ||
"type": "container", | ||
"items":{ | ||
"$ref":"Property" | ||
} | ||
}, | ||
"worflowVariables": { | ||
"uniqueItems": true, | ||
"type": "container", | ||
"items":{ | ||
"$ref":"Property" | ||
} | ||
} | ||
|
||
} | ||
|
||
} |
66 changes: 66 additions & 0 deletions
66
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/datatypes/workflow.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
"workflow" : { | ||
"id": "workflow", | ||
"type": "any", | ||
"required": false, | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"id": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"name": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"initiator": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"attachedDocumentIds": { | ||
|
||
"type": "array", | ||
"items" : { | ||
"type":"string" | ||
}, | ||
"required": false | ||
}, | ||
"variables": { | ||
"uniqueItems": true, | ||
"type": "container", | ||
"items":{ | ||
"$ref":"Property" | ||
} | ||
} | ||
|
||
} | ||
|
||
}, | ||
|
||
"workflows" : { | ||
"id": "workflows", | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"entries": { | ||
"uniqueItems": false, | ||
"type": "array", | ||
"items": { | ||
"$ref":"workflow" | ||
}, | ||
"required": true | ||
} | ||
|
||
} | ||
}, |
10 changes: 10 additions & 0 deletions
10
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/datatypes/workflowGraph.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
"workflowGraph" : { | ||
"id": "workflowGraph", | ||
"type": "any", | ||
"required": false, | ||
"uniqueItems": false, | ||
"properties": { | ||
|
||
} | ||
|
||
} |
34 changes: 34 additions & 0 deletions
34
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/datatypes/workflowRequest.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
"workflowRequest" : { | ||
"id": "workflowRequest", | ||
"type": "any", | ||
"required": false, | ||
"uniqueItems": false, | ||
"properties": { | ||
"entity-type": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": true | ||
}, | ||
"workflowModelName": { | ||
"uniqueItems": false, | ||
"type": "string", | ||
"required": false | ||
}, | ||
"documentIds": { | ||
"type": "array", | ||
"items" : { | ||
"type":"string" | ||
}, | ||
"required": false | ||
}, | ||
"worflowVariables": { | ||
"uniqueItems": true, | ||
"type": "container", | ||
"items":{ | ||
"$ref":"Property" | ||
} | ||
} | ||
|
||
} | ||
|
||
} |
7 changes: 7 additions & 0 deletions
7
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/paramtypes/actors.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"paramType": "query", | ||
"name": "actors", | ||
"description": "comma separated ids of the new actors", | ||
"dataType": "string", | ||
"required": true | ||
} |
7 changes: 7 additions & 0 deletions
7
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/paramtypes/comment.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"paramType": "query", | ||
"name": "comment", | ||
"description": "comment", | ||
"dataType": "string", | ||
"required": false | ||
} |
7 changes: 7 additions & 0 deletions
7
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/paramtypes/delegatedActors.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"paramType": "query", | ||
"name": "delegatedActors", | ||
"description": "comma separated ids of the delegated actors", | ||
"dataType": "string", | ||
"required": true | ||
} |
7 changes: 7 additions & 0 deletions
7
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/paramtypes/modelName.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"paramType": "path", | ||
"name": "modelName", | ||
"description": "Name of the workflow model", | ||
"dataType": "string", | ||
"required": true | ||
} |
7 changes: 7 additions & 0 deletions
7
nuxeo-rest-api-doc/src/main/resources/skin/views/doc/paramtypes/taskAction.ftl
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"paramType": "path", | ||
"name": "action", | ||
"description": "the action to be applied when completed the task. The action determines the transition to be followed and the next task within the workflow.", | ||
"dataType": "string", | ||
"required": true | ||
} |
Oops, something went wrong.