Skip to content

Commit

Permalink
SDK Update from Integrated 2023. (#3)
Browse files Browse the repository at this point in the history 
* Add description field in pipeline Get API

* Update pipeline GET API to include param default and type

* Add API to list the process logs in JSON format

* Update process log API

* Fix process log get API endpoint

* Add created_at property to the process LIST

---------

Co-authored-by: sourav chakraborty <[email protected]>
Co-authored-by: Subhajit Mondal <[email protected]>
  • Loading branch information
@vhadianto @bigdatasourav @Subhajit97
3 people authored Oct 16, 2023
1 parent e6aa2be commit 5a36616
Show file tree
Hide file tree
Showing 17 changed files with 1,213 additions and 47 deletions.
8 changes: 6 additions & 2 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,22 @@ docs/ExecutionSnapshotLayout.md
docs/ExecutionSnapshotPanel.md
docs/ExecutionSnapshotPanelData.md
docs/ExecutionSnapshotPanelDataColumn.md
docs/FpPipelineParam.md
docs/FpTrigger.md
docs/GetPipelineResponse.md
docs/ListPipelineResponse.md
docs/ListPipelineResponseItem.md
docs/ListProcessLogJSONResponse.md
docs/ListProcessResponse.md
docs/ListTriggerResponse.md
docs/ListVariableResponse.md
docs/ModconfigPipelineOutput.md
docs/ModconfigPipelineParam.md
docs/PerrErrorDetailModel.md
docs/PerrErrorModel.md
docs/PipelineApi.md
docs/Process.md
docs/ProcessApi.md
docs/ProcessEventLog.md
docs/ProcessOutputData.md
docs/TriggerApi.md
docs/Variable.md
Expand All @@ -41,18 +43,20 @@ model_execution_snapshot_layout.go
model_execution_snapshot_panel.go
model_execution_snapshot_panel_data.go
model_execution_snapshot_panel_data_column.go
model_fp_pipeline_param.go
model_fp_trigger.go
model_get_pipeline_response.go
model_list_pipeline_response.go
model_list_pipeline_response_item.go
model_list_process_log_json_response.go
model_list_process_response.go
model_list_trigger_response.go
model_list_variable_response.go
model_modconfig_pipeline_output.go
model_modconfig_pipeline_param.go
model_perr_error_detail_model.go
model_perr_error_model.go
model_process.go
model_process_event_log.go
model_process_output_data.go
model_variable.go
response.go
Expand Down
5 changes: 4 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ Class | Method | HTTP request | Description
*PipelineApi* | [**Get**](docs/PipelineApi.md#get) | **Get** /pipeline/{pipeline_name} | Get pipeline
*PipelineApi* | [**List**](docs/PipelineApi.md#list) | **Get** /pipeline | List pipelines
*ProcessApi* | [**Get**](docs/ProcessApi.md#get) | **Get** /process/{process_id} | Get process
*ProcessApi* | [**GetLog**](docs/ProcessApi.md#getlog) | **Get** /process/{process_id}/log/process.json | Get process log
*ProcessApi* | [**GetOutput**](docs/ProcessApi.md#getoutput) | **Get** /process/{process_id}/output | Get process output
*ProcessApi* | [**GetSnapshot**](docs/ProcessApi.md#getsnapshot) | **Get** /process/:process_id/log/process.sps | Get process snapshot
*ProcessApi* | [**List**](docs/ProcessApi.md#list) | **Get** /process | List processs
Expand All @@ -101,18 +102,20 @@ Class | Method | HTTP request | Description
- [ExecutionSnapshotPanel](docs/ExecutionSnapshotPanel.md)
- [ExecutionSnapshotPanelData](docs/ExecutionSnapshotPanelData.md)
- [ExecutionSnapshotPanelDataColumn](docs/ExecutionSnapshotPanelDataColumn.md)
- [FpPipelineParam](docs/FpPipelineParam.md)
- [FpTrigger](docs/FpTrigger.md)
- [GetPipelineResponse](docs/GetPipelineResponse.md)
- [ListPipelineResponse](docs/ListPipelineResponse.md)
- [ListPipelineResponseItem](docs/ListPipelineResponseItem.md)
- [ListProcessLogJSONResponse](docs/ListProcessLogJSONResponse.md)
- [ListProcessResponse](docs/ListProcessResponse.md)
- [ListTriggerResponse](docs/ListTriggerResponse.md)
- [ListVariableResponse](docs/ListVariableResponse.md)
- [ModconfigPipelineOutput](docs/ModconfigPipelineOutput.md)
- [ModconfigPipelineParam](docs/ModconfigPipelineParam.md)
- [PerrErrorDetailModel](docs/PerrErrorDetailModel.md)
- [PerrErrorModel](docs/PerrErrorModel.md)
- [Process](docs/Process.md)
- [ProcessEventLog](docs/ProcessEventLog.md)
- [ProcessOutputData](docs/ProcessOutputData.md)
- [Variable](docs/Variable.md)

Expand Down
155 changes: 135 additions & 20 deletions api/openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,66 @@ paths:
summary: Get process
tags:
- Process
/process/{process_id}/log/process.json:
get:
description: Get process log
operationId: process_get_log
parameters:
- description: The id of the process
explode: false
in: path
name: process_id
required: true
schema:
format: "^[a-z]{0,32}$"
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ListProcessLogJSONResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Bad Request
"401":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Unauthorized
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Forbidden
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Not Found
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Too Many Requests
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/perr.ErrorModel'
description: Internal Server Error
summary: Get process log
tags:
- Process
/process/{process_id}/output:
get:
description: Get process output
Expand Down Expand Up @@ -741,6 +801,25 @@ components:
required:
- command
type: object
FpPipelineParam:
example:
default: default
name: name
description: description
optional: true
type: type
properties:
default:
type: string
description:
type: string
name:
type: string
optional:
type: boolean
type:
type: string
type: object
FpTrigger:
example:
pipeline: pipeline
Expand Down Expand Up @@ -779,13 +858,15 @@ components:
- depends_on
- depends_on
name: name
description: description
sensitive: true
value: "{}"
resolved: true
- depends_on:
- depends_on
- depends_on
name: name
description: description
sensitive: true
value: "{}"
resolved: true
Expand All @@ -794,10 +875,16 @@ components:
name: name
description: description
params:
key:
name: name
description: description
optional: true
- default: default
name: name
description: description
optional: true
type: type
- default: default
name: name
description: description
optional: true
type: type
title: title
steps:
- "{}"
Expand All @@ -818,9 +905,9 @@ components:
$ref: '#/components/schemas/modconfig.PipelineOutput'
type: array
params:
additionalProperties:
$ref: '#/components/schemas/modconfig.PipelineParam'
type: object
items:
$ref: '#/components/schemas/FpPipelineParam'
type: array
steps:
items:
type: object
Expand Down Expand Up @@ -883,15 +970,35 @@ components:
title:
type: string
type: object
ListProcessLogJSONResponse:
example:
next_token: next_token
items:
- event_type: event_type
payload: payload
ts: ts
- event_type: event_type
payload: payload
ts: ts
properties:
items:
items:
$ref: '#/components/schemas/ProcessEventLog'
type: array
next_token:
type: string
type: object
ListProcessResponse:
example:
next_token: next_token
items:
- pipeline: pipeline
execution_id: execution_id
created_at: created_at
status: status
- pipeline: pipeline
execution_id: execution_id
created_at: created_at
status: status
properties:
items:
Expand Down Expand Up @@ -953,15 +1060,33 @@ components:
example:
pipeline: pipeline
execution_id: execution_id
created_at: created_at
status: status
properties:
created_at:
type: string
execution_id:
type: string
pipeline:
type: string
status:
type: string
type: object
ProcessEventLog:
example:
event_type: event_type
payload: payload
ts: ts
properties:
event_type:
type: string
payload:
description: "Setting the type as string for now, as the CLI need to print\
\ the payload"
type: string
ts:
type: string
type: object
ProcessOutputData:
example:
output: "{}"
Expand Down Expand Up @@ -1122,6 +1247,7 @@ components:
- depends_on
- depends_on
name: name
description: description
sensitive: true
value: "{}"
resolved: true
Expand All @@ -1130,6 +1256,8 @@ components:
items:
type: string
type: array
description:
type: string
name:
type: string
resolved:
Expand All @@ -1139,19 +1267,6 @@ components:
value:
type: object
type: object
modconfig.PipelineParam:
example:
name: name
description: description
optional: true
properties:
description:
type: string
name:
type: string
optional:
type: boolean
type: object
perr.ErrorDetailModel:
properties:
location:
Expand Down
Loading

0 comments on commit 5a36616

Please sign in to comment.