Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.

[KF-334] User Action Document #12

Merged
7eben merged 6 commits into from
Jul 5, 2022
Merged

[KF-334] User Action Document #12

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4de07f
User Action Document
7eben Jun 22, 2022
2c4a955
Merge remote-tracking branch 'origin/main' into feature/KF-334-add-us…
7eben Jul 1, 2022
1fe214d
reponse type for user action
7eben Jul 4, 2022
f2ec150
Rename api
7eben Jul 4, 2022
c2bf501
Requested changes
7eben Jul 4, 2022
0616f0e
Misspelling
7eben Jul 4, 2022
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
67 changes: 52 additions & 15 deletions src/main/resources/openapi/specs/api.kuflow.com/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,41 @@ paths:
default:
$ref: "#/components/responses/DefaultError"

/processes/{id}/~actions/save-user-action-value-document:
Copy link
Contributor

@jrpedrianes jrpedrianes Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but maybe here we should use: /processes/{id}/~actions/save-user-action-document:

🤔

Copy link
Contributor Author

@7eben 7eben Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, I left it like that for homogeneity with that of element...

Copy link
Contributor Author

@7eben 7eben Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

save-element-value-document:

Copy link
Contributor

@jrpedrianes jrpedrianes Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yap, but a user action can't have more than one value, isn't it?

Copy link
Contributor

@jrpedrianes jrpedrianes Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just thinking

Copy link
Contributor Author

@7eben 7eben Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nop, only one value

Copy link
Contributor

@jrpedrianes jrpedrianes Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's why I commented that 'value' is redundant, 🤔

Copy link
Contributor

@jrpedrianes jrpedrianes Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but maybe is better left as is, as you have it, to avoid confusion.

Copy link
Contributor Author

@7eben 7eben Jul 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know about the naming, but now is the right moment to make any change because later is a new API version :S

post:
summary: Upload and save a document in a user action
description: |
Allow saving a user action document uploading the content.
operationId: actionsSaveProcessUserActionValueDocument
tags:
- process
parameters:
- $ref: "#/components/parameters/IdPathParam"
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
json:
$ref: "#/components/schemas/SaveProcessUserActionValueDocumentCommand"
file:
type: string
format: binary
required:
- json
- file
responses:
"200":
description: Document Saved in user action
content:
application/json:
schema:
$ref: "#/components/schemas/Process"
"304":
description: Untouched process

/tasks:
get:
summary: Find all accessible Taks
Expand Down Expand Up @@ -330,23 +365,16 @@ paths:
{
"element_code_1": { type: "STRING", "value": "string" },
"element_code_2": { type: "NUMBER", "valid": false, "value": 1111 },
"element_code_3": [
{ type: "STRING", "value": "string" },
{ type: "STRING", "value": "string" }
],
"element_code_4": {
type: "OBJECT",
"value": { "form_field_1": "string", "form_field_2": "string" }
},
"element_code_3": [{ type: "STRING", "value": "string" }, { type: "STRING", "value": "string" }],
"element_code_4": { type: "OBJECT", "value": { "form_field_1": "string", "form_field_2": "string" } },
"element_code_5": { type: "DOCUMENT", "value": { "uri": "string" } },
"element_code_6": [
{ type: "DOCUMENT", "value": { "uri": "string" } }
],
"element_code_6": [{ type: "DOCUMENT", "value": { "uri": "string" } }],
"element_code_7": { type: "PRINCIPAL", "value": { "id": "b90c9ae9-444c-4bfd-9594-7468955d2eda", "type": "USER" } },
"element_code_8": [
{ type: "PRINCIPAL", "value": { "id": "b90c9ae9-444c-4bfd-9594-7468955d2eda", "type": "USER" } },
{ type: "PRINCIPAL", "value": { "id": "f4be313c-c0a2-426c-bdd3-c3113d7bbf37", "type": "USER" } }
]
"element_code_8":
[
{ type: "PRINCIPAL", "value": { "id": "b90c9ae9-444c-4bfd-9594-7468955d2eda", "type": "USER" } },
{ type: "PRINCIPAL", "value": { "id": "f4be313c-c0a2-426c-bdd3-c3113d7bbf37", "type": "USER" } },
],
},
}
responses:
Expand Down Expand Up @@ -1061,6 +1089,15 @@ components:
required:
- code

SaveProcessUserActionValueDocumentCommand:
type: object
properties:
id:
type: string
format: uuid
required:
- id

ProcessDefinitionSummary:
type: object
properties:
Expand Down