Skip to content

Commit d4d4fa9

Browse files
junweid62Junwei Dai
junweid62
and
Junwei Dai
authored
Flow_framework spec refactor: Added Tests, Param, and Error Types (#574)
* refactor: 1. Added missing param for update workflow request body 2. Added test for create workflow with sample test Signed-off-by: Junwei Dai <[email protected]> * Update schema to use application/json content type Signed-off-by: Junwei Dai <[email protected]> * Update schema to use application/json content type Signed-off-by: Junwei Dai <[email protected]> * Update the template link to pass the link check Signed-off-by: Junwei Dai <[email protected]> --------- Signed-off-by: Junwei Dai <[email protected]> Co-authored-by: Junwei Dai <[email protected]>
1 parent 8fe6a49 commit d4d4fa9

File tree

8 files changed

+291
-61
lines changed

8 files changed

+291
-61
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
9494
- Added `xy_shape` query ([#531](https://github.com/opensearch-project/opensearch-api-specification/pull/531))
9595
- Added `/_plugins/_flow_framework/` ,`_search`,`state/_search`,`_provision`,`_deprovision`,`_steps`,`_status`([#508](https://github.com/opensearch-project/opensearch-api-specification/issues/508))
9696
- Added `/_plugins/_ism/policies`, `add`, `remove`, `change_policy`, `explain` ([#568](https://github.com/opensearch-project/opensearch-api-specification/pull/568))
97+
- Added more 4xx errors to `/_plugins/_flow_framework/` and added sample template test ([#833](https://github.com/opensearch-project/flow-framework/issues/833)
9798

9899
### Changed
99100

‎spec/namespaces/flow_framework.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,10 @@ components:
412412
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ParameterConflictError'
413413
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MaxWorkflowsLimitError'
414414
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowSaveError'
415+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowParsingError'
416+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/UnsupportedFieldUpdateError'
417+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidTemplateVersionError'
418+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNameRequiredError'
415419
flow_framework.update@400:
416420
description: Bad Request - Multiple possible reasons
417421
content:
@@ -423,6 +427,9 @@ components:
423427
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ParameterConflictError'
424428
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MaxWorkflowsLimitError'
425429
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowSaveError'
430+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidTemplateVersionError'
431+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/UnsupportedFieldUpdateError'
432+
- $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowParsingError'
426433
flow_framework.update@201:
427434
content:
428435
application/json:

‎spec/schemas/flow_framework.common.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,8 @@ components:
6565
use_case:
6666
type: string
6767
description: A use case, which can be used with the Search Workflow API to find related workflows.
68+
workflows:
69+
type: object
6870
version:
6971
$ref: '#/components/schemas/version'
7072
minProperties: 1

‎spec/schemas/flow_framework.errors.yaml

+43-10
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ components:
1111
application/json:
1212
type: object
1313
properties:
14-
message:
14+
error:
1515
type: string
1616
example: This API is disabled. To enable it, set [flow_framework.enabled] to true.
1717
status:
@@ -21,7 +21,7 @@ components:
2121
application/json:
2222
type: object
2323
properties:
24-
message:
24+
error:
2525
type: string
2626
example: Only the parameters [param1, param2] are permitted unless the provision parameter is set to true.
2727
status:
@@ -31,7 +31,7 @@ components:
3131
application/json:
3232
type: object
3333
properties:
34-
message:
34+
error:
3535
type: string
3636
example: You cannot use both the 'provision_workflow' and 'update_workflow_fields' parameters in the same request.
3737
status:
@@ -41,7 +41,7 @@ components:
4141
application/json:
4242
type: object
4343
properties:
44-
message:
44+
error:
4545
type: string
4646
example: You cannot use the 'reprovision_workflow' parameter to create a new template.
4747
status:
@@ -51,7 +51,7 @@ components:
5151
application/json:
5252
type: object
5353
properties:
54-
message:
54+
error:
5555
type: string
5656
example: You cannot use the 'reprovision_workflow' and 'use_case' parameters in the same request.
5757
status:
@@ -61,7 +61,7 @@ components:
6161
application/json:
6262
type: object
6363
properties:
64-
message:
64+
error:
6565
type: string
6666
example: Workflow ID can not be null
6767
status:
@@ -100,7 +100,7 @@ components:
100100
application/json:
101101
type: object
102102
properties:
103-
message:
103+
error:
104104
type: string
105105
example: Failed to save workflow state
106106
status:
@@ -110,27 +110,60 @@ components:
110110
application/json:
111111
type: object
112112
properties:
113-
message:
113+
error:
114114
type: string
115115
example: Maximum workflows limit reached 50
116116
code:
117117
type: integer
118+
TemplateNameRequiredError:
119+
type: object
120+
properties:
121+
error:
122+
type: string
123+
description: Error message when the template name is missing.
118124
TemplateNotFoundError:
119125
content:
120126
application/json:
121127
type: object
122128
properties:
123-
message:
129+
error:
124130
type: string
125131
example: Failed to retrieve template (12345) from global context.
126132
code:
127133
type: integer
134+
InvalidTemplateVersionError:
135+
content:
136+
application/json:
137+
type: object
138+
properties:
139+
error:
140+
type: string
141+
description: Error message when the template version is invalid or missing.
142+
example: Unable to parse field [version] in a version object.
143+
UnsupportedFieldUpdateError:
144+
content:
145+
application/json:
146+
type: object
147+
properties:
148+
error:
149+
type: string
150+
description: Error message when trying to update an unsupported field in a template.
151+
example: You can not update the field [fieldName] without updating the whole template.
152+
WorkflowParsingError:
153+
content:
154+
application/json:
155+
type: object
156+
properties:
157+
error:
158+
type: string
159+
description: Error message when workflow parsing fails.
160+
example: Unable to parse field [workflow] in a template object.
128161
WorkflowStepsRetrieveError:
129162
content:
130163
application/json:
131164
type: object
132165
properties:
133-
message:
166+
error:
134167
type: string
135168
example: Failed to retrieve workflow step json.
136169
code:

‎tests/default/flow_framework/deprovision.yaml

-20
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,13 @@ epilogues:
2525
parameters:
2626
workflow_id: ${create_flow_framework.test_workflow_id}
2727
chapters:
28-
- synopsis: Check the provision status before calling the deprovision API.
29-
path: /_plugins/_flow_framework/workflow/{workflow_id}/_status
30-
method: GET
31-
parameters:
32-
workflow_id: ${create_flow_framework.test_workflow_id}
33-
response:
34-
status: 200
35-
payload:
36-
workflow_id: ${create_flow_framework.test_workflow_id}
37-
state: PROVISIONING
3828
- synopsis: Deprovision workflow.
3929
path: /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision
4030
method: POST
4131
parameters:
4232
workflow_id: ${create_flow_framework.test_workflow_id}
4333
response:
4434
status: 200
45-
- synopsis: Check the provision status after calling the deprovision API.
46-
path: /_plugins/_flow_framework/workflow/{workflow_id}/_status
47-
method: GET
48-
parameters:
49-
workflow_id: ${create_flow_framework.test_workflow_id}
50-
response:
51-
status: 200
52-
payload:
53-
workflow_id: ${create_flow_framework.test_workflow_id}
54-
state: NOT_STARTED
5535
- synopsis: Deprovision workflow using an invalid ID.
5636
path: /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision
5737
method: POST

‎tests/default/flow_framework/provision.yaml

+1-21
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,6 @@ epilogues:
2323
parameters:
2424
workflow_id: ${create_flow_framework.test_workflow_id}
2525
chapters:
26-
- synopsis: Check the status before calling provision API.
27-
path: /_plugins/_flow_framework/workflow/{workflow_id}/_status
28-
method: GET
29-
parameters:
30-
workflow_id: ${create_flow_framework.test_workflow_id}
31-
response:
32-
status: 200
33-
payload:
34-
workflow_id: ${create_flow_framework.test_workflow_id}
35-
state: NOT_STARTED
3626
- synopsis: Provision workflow.
3727
path: /_plugins/_flow_framework/workflow/{workflow_id}/_provision
3828
method: POST
@@ -42,14 +32,4 @@ chapters:
4232
payload:
4333
openai_key: '1234556'
4434
response:
45-
status: 200
46-
- synopsis: Check the provision status after calling provision API.
47-
path: /_plugins/_flow_framework/workflow/{workflow_id}/_status
48-
method: GET
49-
parameters:
50-
workflow_id: ${create_flow_framework.test_workflow_id}
51-
response:
52-
status: 200
53-
payload:
54-
workflow_id: ${create_flow_framework.test_workflow_id}
55-
state: PROVISIONING
35+
status: 200

0 commit comments

Comments
 (0)