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

Updated Flowpipe SDK to incorporate latest API changes and the new Trigger API endpoints. #13

Merged
merged 4 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
More update
  • Loading branch information
vhadianto committed Jul 25, 2024
commit d79913cdb0c7ede6f3fe25571208b3f3c5ad1afe
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ api_variable.go
client.go
configuration.go
docs/CmdPipeline.md
docs/CmdTrigger.md
docs/ExecutionExecution.md
docs/ExecutionPipelineExecution.md
docs/ExecutionStepExecution.md
Expand All @@ -20,6 +21,7 @@ docs/ExecutionStepExecutionStepForEach.md
docs/ExecutionStepStatus.md
docs/FlowpipeRequire.md
docs/FlowpipeResponseMetadata.md
docs/FlowpipeTriggerResponseMetadata.md
docs/FpIntegration.md
docs/FpNotifier.md
docs/FpNotify.md
Expand Down Expand Up @@ -60,11 +62,13 @@ docs/ProcessApi.md
docs/ProcessEventLog.md
docs/Require.md
docs/TriggerApi.md
docs/TriggerExecutionResponse.md
docs/VariableApi.md
git_push.sh
go.mod
go.sum
model_cmd_pipeline.go
model_cmd_trigger.go
model_execution_execution.go
model_execution_pipeline_execution.go
model_execution_step_execution.go
Expand All @@ -73,6 +77,7 @@ model_execution_step_execution_step_for_each.go
model_execution_step_status.go
model_flowpipe_require.go
model_flowpipe_response_metadata.go
model_flowpipe_trigger_response_metadata.go
model_fp_integration.go
model_fp_notifier.go
model_fp_notify.go
Expand Down Expand Up @@ -107,5 +112,6 @@ model_pipeline_execution_response.go
model_process.go
model_process_event_log.go
model_require.go
model_trigger_execution_response.go
response.go
utils.go
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
## Documentation For Models

- [CmdPipeline](docs/CmdPipeline.md)
- [CmdTrigger](docs/CmdTrigger.md)
- [ExecutionExecution](docs/ExecutionExecution.md)
- [ExecutionPipelineExecution](docs/ExecutionPipelineExecution.md)
- [ExecutionStepExecution](docs/ExecutionStepExecution.md)
Expand All @@ -110,6 +111,7 @@ Class | Method | HTTP request | Description
- [ExecutionStepStatus](docs/ExecutionStepStatus.md)
- [FlowpipeRequire](docs/FlowpipeRequire.md)
- [FlowpipeResponseMetadata](docs/FlowpipeResponseMetadata.md)
- [FlowpipeTriggerResponseMetadata](docs/FlowpipeTriggerResponseMetadata.md)
- [FpIntegration](docs/FpIntegration.md)
- [FpNotifier](docs/FpNotifier.md)
- [FpNotify](docs/FpNotify.md)
Expand Down Expand Up @@ -144,6 +146,7 @@ Class | Method | HTTP request | Description
- [Process](docs/Process.md)
- [ProcessEventLog](docs/ProcessEventLog.md)
- [Require](docs/Require.md)
- [TriggerExecutionResponse](docs/TriggerExecutionResponse.md)


## Documentation For Authorization
Expand Down
166 changes: 164 additions & 2 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -918,15 +918,15 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/CmdPipeline'
$ref: '#/components/schemas/CmdTrigger'
description: Trigger command.
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/PipelineExecutionResponse'
$ref: '#/components/schemas/TriggerExecutionResponse'
description: OK
"400":
content:
Expand Down Expand Up @@ -1102,6 +1102,43 @@ components:
example:
args:
key: ""
execution_id: execution_id
args_string:
key: args_string
execution_mode: synchronous
wait_retry: 0
command: run
properties:
args:
additionalProperties: true
type: object
args_string:
additionalProperties:
type: string
type: object
command:
enum:
- run
type: string
execution_id:
description: "Sepcify execution id, if not specified, a new execution id\
\ will be created"
type: string
execution_mode:
enum:
- synchronous
- asynchronous
type: string
wait_retry:
type: integer
required:
- command
type: object
CmdTrigger:
example:
args:
key: ""
execution_id: execution_id
args_string:
key: args_string
execution_mode: synchronous
Expand All @@ -1118,6 +1155,11 @@ components:
command:
enum:
- run
- reset
type: string
execution_id:
description: "Sepcify execution id, if not specified, a new execution id\
\ will be created"
type: string
execution_mode:
enum:
Expand All @@ -1143,6 +1185,7 @@ components:
pipeline_execution_id: pipeline_execution_id
last_loaded: last_loaded
is_stale: true
status: status
properties:
execution_id:
type: string
Expand All @@ -1154,6 +1197,27 @@ components:
type: string
pipeline_execution_id:
type: string
status:
type: string
type: object
FlowpipeTriggerResponseMetadata:
example:
process_id: process_id
last_loaded: last_loaded
name: name
is_stale: true
type: type
properties:
is_stale:
type: boolean
last_loaded:
type: string
name:
type: string
process_id:
type: string
type:
type: string
type: object
FpIntegration:
example:
Expand Down Expand Up @@ -1988,6 +2052,7 @@ components:
pipeline_execution_id: pipeline_execution_id
last_loaded: last_loaded
is_stale: true
status: status
errors:
- pipeline: pipeline
pipeline_execution_id: pipeline_execution_id
Expand Down Expand Up @@ -2078,6 +2143,103 @@ components:
$ref: '#/components/schemas/ModVersionConstraint'
type: array
type: object
TriggerExecutionResponse:
example:
flowpipe:
process_id: process_id
last_loaded: last_loaded
name: name
is_stale: true
type: type
results:
- output:
key: ""
flowpipe:
pipeline: pipeline
execution_id: execution_id
pipeline_execution_id: pipeline_execution_id
last_loaded: last_loaded
is_stale: true
status: status
errors:
- pipeline: pipeline
pipeline_execution_id: pipeline_execution_id
step_execution_id: step_execution_id
step: step
error:
instance: instance
validation_errors:
- location: location
message: message
- location: location
message: message
detail: detail
title: title
type: type
status: 0
- pipeline: pipeline
pipeline_execution_id: pipeline_execution_id
step_execution_id: step_execution_id
step: step
error:
instance: instance
validation_errors:
- location: location
message: message
- location: location
message: message
detail: detail
title: title
type: type
status: 0
- output:
key: ""
flowpipe:
pipeline: pipeline
execution_id: execution_id
pipeline_execution_id: pipeline_execution_id
last_loaded: last_loaded
is_stale: true
status: status
errors:
- pipeline: pipeline
pipeline_execution_id: pipeline_execution_id
step_execution_id: step_execution_id
step: step
error:
instance: instance
validation_errors:
- location: location
message: message
- location: location
message: message
detail: detail
title: title
type: type
status: 0
- pipeline: pipeline
pipeline_execution_id: pipeline_execution_id
step_execution_id: step_execution_id
step: step
error:
instance: instance
validation_errors:
- location: location
message: message
- location: location
message: message
detail: detail
title: title
type: type
status: 0
properties:
flowpipe:
$ref: '#/components/schemas/FlowpipeTriggerResponseMetadata'
results:
items:
$ref: '#/components/schemas/PipelineExecutionResponse'
type: array
type: object
execution.Execution:
example:
pipeline_executions:
Expand Down
12 changes: 6 additions & 6 deletions api_trigger.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions docs/CmdPipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**Args** | Pointer to **map[string]interface{}** | | [optional]
**ArgsString** | Pointer to **map[string]string** | | [optional]
**Command** | **string** | |
**ExecutionId** | Pointer to **string** | Sepcify execution id, if not specified, a new execution id will be created | [optional]
**ExecutionMode** | Pointer to **string** | | [optional]
**WaitRetry** | Pointer to **int32** | | [optional]

Expand Down Expand Up @@ -99,6 +100,31 @@ and a boolean to check if the value has been set.
SetCommand sets Command field to given value.


### GetExecutionId

`func (o *CmdPipeline) GetExecutionId() string`

GetExecutionId returns the ExecutionId field if non-nil, zero value otherwise.

### GetExecutionIdOk

`func (o *CmdPipeline) GetExecutionIdOk() (*string, bool)`

GetExecutionIdOk returns a tuple with the ExecutionId field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.

### SetExecutionId

`func (o *CmdPipeline) SetExecutionId(v string)`

SetExecutionId sets ExecutionId field to given value.

### HasExecutionId

`func (o *CmdPipeline) HasExecutionId() bool`

HasExecutionId returns a boolean if a field has been set.

### GetExecutionMode

`func (o *CmdPipeline) GetExecutionMode() string`
Expand Down
Loading