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.

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

Rename getDataAttributes in SDK #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions iwf-sdk.yaml
Expand Up @@ -70,19 +70,19 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/workflow/dataobjects/get:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems this path needs to be modified after the server supports it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah and we can’t just change the path in the server without more work to support backward compatibility. So I decided to keep the wrong name in the yaml file for now. And it’s invisible for users anyway

post:
summary: "get workflow data objects"
summary: "get workflow data attributes"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetDataObjectsRequest'
$ref: '#/components/schemas/WorkflowGetDataAttributesRequest'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/WorkflowGetDataObjectsResponse'
$ref: '#/components/schemas/WorkflowGetDataAttributesResponse'
'400':
description: Invalid input
content:
Expand Down Expand Up @@ -597,7 +597,7 @@ components:
- CANCEL # default behavior
- TERMINATE # this will hard terminate the workflow
- FAIL
WorkflowGetDataObjectsRequest:
WorkflowGetDataAttributesRequest:
type: object
required:
- workflowId
Expand All @@ -612,7 +612,7 @@ components:
type: string
useMemoForDataAttributes:
type: boolean
WorkflowGetDataObjectsResponse:
WorkflowGetDataAttributesResponse:
type: object
properties:
objects:
Expand Down