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

Chore/upgrade wf client #269

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

Chore/upgrade wf client #269

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf53774
chore(wf-client): update client with new spec
Jan 23, 2025
6bec3e9
Merge branch 'main' into chore/upgrade-wf-client
Jan 23, 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
37 changes: 6 additions & 31 deletions clients/workflow-client/src/openapi.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ declare namespace Components {
*/
export interface DynamicDueDate {
numberOfUnits: number;
timePeriod: "minutes" | "hours" | "days" | "weeks" | "months";
timePeriod: "days" | "weeks" | "months";
actionTypeCondition?: "WORKFLOW_STARTED" | "STEP_CLOSED";
stepId?: string;
}
Expand Down Expand Up @@ -517,21 +517,11 @@ declare namespace Components {
*/
userIds?: number[];
assignedTo?: string[];
/**
* example:
* 2021-04-27T12:00:00.000Z
*/
dueDate?: string;
dynamicDueDate?: /* set a Duedate for a step then a specific */ DynamicDueDate;
startedTime?: string;
completedTime?: string;
status?: SectionStatus;
type: ItemType;
steps: Step[];
/**
* Taxonomy ids (purposes in this case) that are associated with this section and used for filtering
*/
taxonomies?: string[];
}
/**
* A group of Steps that define the progress of the Workflow
Expand All @@ -547,7 +537,6 @@ declare namespace Components {
name: string;
type: ItemType;
steps: StepSimplified[];
assignedTo?: string[];
}
export type SectionStatus = "OPEN" | "IN_PROGRESS" | "COMPLETED";
export interface StartFlowReq {
Expand Down Expand Up @@ -958,10 +947,6 @@ declare namespace Components {
* Version of the workflow execution
*/
version?: number;
/**
* Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
*/
taxonomies?: string[];
flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
}
export interface WorkflowExecutionBase {
Expand Down Expand Up @@ -1007,16 +992,13 @@ declare namespace Components {
* Version of the workflow execution
*/
version?: number;
/**
* Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
*/
taxonomies?: string[];
}
/**
* example:
* {
* "workflowId": "j3f23fh23uif98",
* "trigger": "AUTOMATIC",
* "dueDate": "2021-04-27T12:01:13.000Z",
* "contexts": [
* {
* "id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
Expand All @@ -1034,10 +1016,6 @@ declare namespace Components {
trigger?: TriggerType;
assignedTo?: string[];
contexts?: WorkflowContext[];
/**
* An array of purposes to filter workflow phases.
*/
purposes?: string[];
}
/**
* example:
Expand Down Expand Up @@ -1114,10 +1092,6 @@ declare namespace Components {
* Version of the workflow execution
*/
version?: number;
/**
* Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering
*/
taxonomies?: string[];
flow: (/* A group of Steps that define the progress of the Workflow */ Section | Step)[];
}
export interface WorkflowExecutionUpdateReq {
Expand All @@ -1143,13 +1117,13 @@ declare namespace Components {
name?: string;
status?: WorkflowStatus;
assignees?: string[];
duedate?: string; // date-time
last_update_time?: string; // date-time
duedate?: string;
last_update_time?: string;
progress?: number;
task_id?: string;
task_name?: string;
task_assignees?: string[];
task_duedate?: string; // date-time
task_duedate?: string;
task_execution_type?: StepType;
task_status?: StepStatus;
phase_id?: string;
Expand All @@ -1170,6 +1144,7 @@ declare namespace Paths {
* {
* "workflowId": "j3f23fh23uif98",
* "trigger": "AUTOMATIC",
* "dueDate": "2021-04-27T12:01:13.000Z",
* "contexts": [
* {
* "id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
Expand Down
46 changes: 4 additions & 42 deletions clients/workflow-client/src/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -981,13 +981,6 @@
"items": {
"$ref": "#/components/schemas/WorkflowContext"
}
},
"purposes": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of purposes to filter workflow phases."
}
},
"required": [
Expand All @@ -996,6 +989,7 @@
"example": {
"workflowId": "j3f23fh23uif98",
"trigger": "AUTOMATIC",
"dueDate": "2021-04-27T12:01:13.000Z",
"contexts": [
{
"id": "3fa3fa86-0907-4642-a57e-0fe30a19874d",
Expand Down Expand Up @@ -1172,13 +1166,6 @@
"version": {
"type": "integer",
"description": "Version of the workflow execution"
},
"taxonomies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Taxonomy ids (both Labels and Purposes) that are associated with this workflow and used for filtering"
}
}
},
Expand Down Expand Up @@ -1349,12 +1336,6 @@
"items": {
"$ref": "#/components/schemas/StepSimplified"
}
},
"assignedTo": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
Expand Down Expand Up @@ -1393,13 +1374,6 @@
"type": "string"
}
},
"dueDate": {
"type": "string",
"example": "2021-04-27T12:00:00.000Z"
},
"dynamicDueDate": {
"$ref": "#/components/schemas/DynamicDueDate"
},
"startedTime": {
"type": "string"
},
Expand All @@ -1417,13 +1391,6 @@
"items": {
"$ref": "#/components/schemas/Step"
}
},
"taxonomies": {
"type": "array",
"items": {
"type": "string"
},
"description": "Taxonomy ids (purposes in this case) that are associated with this section and used for filtering"
}
},
"required": [
Expand Down Expand Up @@ -2006,12 +1973,10 @@
}
},
"duedate": {
"type": "string",
"format": "date-time"
"type": "string"
},
"last_update_time": {
"type": "string",
"format": "date-time"
"type": "string"
},
"progress": {
"type": "number"
Expand All @@ -2029,8 +1994,7 @@
}
},
"task_duedate": {
"type": "string",
"format": "date-time"
"type": "string"
},
"task_execution_type": {
"$ref": "#/components/schemas/StepType"
Expand Down Expand Up @@ -2114,8 +2078,6 @@
"timePeriod": {
"type": "string",
"enum": [
"minutes",
"hours",
"days",
"weeks",
"months"
Expand Down
Loading