Skip to content

Commit

Permalink
Update pipeline LIST/GET API
Browse files Browse the repository at this point in the history
  • Loading branch information
@Subhajit97
Subhajit97 committed Oct 11, 2023
1 parent d67ff5a commit 1c7c587
Show file tree
Hide file tree
Showing 15 changed files with 1,534 additions and 397 deletions.
12 changes: 6 additions & 6 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ docs/ExecutionSnapshotLayout.md
docs/ExecutionSnapshotPanel.md
docs/ExecutionSnapshotPanelData.md
docs/ExecutionSnapshotPanelDataColumn.md
docs/FpPipeline.md
docs/FpTrigger.md
docs/GetPipelineResponse.md
docs/ListPipelineResponse.md
docs/ListPipelineResponseItem.md
docs/ListProcessResponse.md
docs/ListTriggerResponse.md
docs/ListVariableResponse.md
docs/ModconfigPipeline.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 +41,18 @@ 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.go
model_fp_trigger.go
model_get_pipeline_response.go
model_list_pipeline_response.go
model_list_pipeline_response_item.go
model_list_process_response.go
model_list_trigger_response.go
model_list_variable_response.go
model_modconfig_pipeline.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
7 changes: 3 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ 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.jsonl | Get process logs
*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 @@ -102,18 +101,18 @@ Class | Method | HTTP request | Description
- [ExecutionSnapshotPanel](docs/ExecutionSnapshotPanel.md)
- [ExecutionSnapshotPanelData](docs/ExecutionSnapshotPanelData.md)
- [ExecutionSnapshotPanelDataColumn](docs/ExecutionSnapshotPanelDataColumn.md)
- [FpPipeline](docs/FpPipeline.md)
- [FpTrigger](docs/FpTrigger.md)
- [GetPipelineResponse](docs/GetPipelineResponse.md)
- [ListPipelineResponse](docs/ListPipelineResponse.md)
- [ListPipelineResponseItem](docs/ListPipelineResponseItem.md)
- [ListProcessResponse](docs/ListProcessResponse.md)
- [ListTriggerResponse](docs/ListTriggerResponse.md)
- [ListVariableResponse](docs/ListVariableResponse.md)
- [ModconfigPipeline](docs/ModconfigPipeline.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
216 changes: 85 additions & 131 deletions api/openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/modconfig.Pipeline'
$ref: '#/components/schemas/GetPipelineResponse'
description: OK
"400":
content:
Expand Down Expand Up @@ -276,66 +276,6 @@ paths:
summary: List processs
tags:
- Process
/process/:process_id/log/process.jsonl:
get:
description: Get process logs
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/ProcessEventLog'
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 logs
tags:
- Process
/process/:process_id/log/process.sps:
get:
description: Get process snapshot
Expand Down Expand Up @@ -801,61 +741,95 @@ components:
required:
- command
type: object
FpPipeline:
FpTrigger:
example:
mod: mod
pipeline: pipeline
documentation: documentation
name: name
description: description
title: title
type: type
url: url
tags:
key: tags
properties:
description:
type: string
documentation:
type: string
mod:
type: string
name:
type: string
pipeline:
type: string
tags:
additionalProperties:
type: string
type: object
title:
type: string
type:
type: string
url:
type: string
type: object
FpTrigger:
GetPipelineResponse:
example:
pipeline: pipeline
outputs:
- depends_on:
- depends_on
- depends_on
name: name
sensitive: true
value: "{}"
resolved: true
- depends_on:
- depends_on
- depends_on
name: name
sensitive: true
value: "{}"
resolved: true
mod: mod
documentation: documentation
name: name
description: description
params:
key:
name: name
description: description
title: title
type: type
url: url
steps:
- "{}"
- "{}"
tags:
key: tags
properties:
description:
type: string
documentation:
type: string
name:
mod:
type: string
pipeline:
name:
type: string
outputs:
items:
$ref: '#/components/schemas/modconfig.PipelineOutput'
type: array
params:
additionalProperties:
$ref: '#/components/schemas/modconfig.PipelineParam'
type: object
steps:
items:
type: object
type: array
tags:
additionalProperties:
type: string
type: object
title:
type: string
type:
type: string
url:
type: string
type: object
ListPipelineResponse:
example:
Expand All @@ -878,11 +852,36 @@ components:
properties:
items:
items:
$ref: '#/components/schemas/FpPipeline'
$ref: '#/components/schemas/ListPipelineResponseItem'
type: array
next_token:
type: string
type: object
ListPipelineResponseItem:
example:
mod: mod
documentation: documentation
name: name
description: description
title: title
tags:
key: tags
properties:
description:
type: string
documentation:
type: string
mod:
type: string
name:
type: string
tags:
additionalProperties:
type: string
type: object
title:
type: string
type: object
ListProcessResponse:
example:
next_token: next_token
Expand Down Expand Up @@ -962,23 +961,6 @@ components:
status:
type: string
type: object
ProcessEventLog:
example:
event_type: event_type
payload:
- 0
- 0
ts: ts
properties:
event_type:
type: string
payload:
items:
type: integer
type: array
ts:
type: string
type: object
ProcessOutputData:
example:
output: "{}"
Expand Down Expand Up @@ -1133,44 +1115,6 @@ components:
type: object
execution.SnapshotPanelDataRow:
type: object
modconfig.Pipeline:
example:
outputs:
- depends_on:
- depends_on
- depends_on
name: name
sensitive: true
value: "{}"
resolved: true
- depends_on:
- depends_on
- depends_on
name: name
sensitive: true
value: "{}"
resolved: true
name: name
steps:
- "{}"
- "{}"
pipeline_name: pipeline_name
properties:
name:
type: string
outputs:
items:
$ref: '#/components/schemas/modconfig.PipelineOutput'
type: array
pipeline_name:
description: "TODO: hack to serialise pipeline name because HclResourceImpl\
\ is not serialised"
type: string
steps:
items:
type: object
type: array
type: object
modconfig.PipelineOutput:
example:
depends_on:
Expand All @@ -1194,6 +1138,16 @@ components:
value:
type: object
type: object
modconfig.PipelineParam:
example:
name: name
description: description
properties:
description:
type: string
name:
type: string
type: object
perr.ErrorDetailModel:
properties:
location:
Expand Down
Loading

0 comments on commit 1c7c587

Please sign in to comment.