Skip to content

Commit

Permalink
feat(vdp): expose raw_recipe field in pipeline endpoint (#373)
Browse files Browse the repository at this point in the history
Because

- We are going to support pipeline recipes in YAML format. We will
return the recipe in YAML format in the response and also allow users to
create/update recipes using YAML format.

This commit

- Exposes the `raw_recipe` field in the pipeline and pipeline_release
messages.
  • Loading branch information
donch1989 committed Jun 24, 2024
1 parent bcac24f commit afe1b7d
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
30 changes: 30 additions & 0 deletions openapiv2/vdp/service.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,11 @@ paths:
stats:
$ref: '#/definitions/PipelineStats'
description: Statistic data.
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
title: The pipeline fields that will replace the existing ones.
tags:
- Pipeline
Expand Down Expand Up @@ -1020,6 +1025,11 @@ paths:
$ref: '#/definitions/v1betaDataSpecification'
description: Data specifications.
readOnly: true
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
title: |-
The pipeline release fields that will replace the existing ones.
A pipeline release resource to update
Expand Down Expand Up @@ -1501,6 +1511,11 @@ paths:
stats:
$ref: '#/definitions/PipelineStats'
description: Statistic data.
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
title: The pipeline fields that will replace the existing ones.
tags:
- Pipeline
Expand Down Expand Up @@ -2022,6 +2037,11 @@ paths:
$ref: '#/definitions/v1betaDataSpecification'
description: Data specifications.
readOnly: true
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
title: |-
The pipeline release fields that will replace the existing ones.
A pipeline release resource to update
Expand Down Expand Up @@ -4482,6 +4502,11 @@ definitions:
stats:
$ref: '#/definitions/PipelineStats'
description: Statistic data.
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
description: |-
A Pipeline is an end-to-end workflow that automates a sequence of components
to process data.
Expand Down Expand Up @@ -4545,6 +4570,11 @@ definitions:
$ref: '#/definitions/v1betaDataSpecification'
description: Data specifications.
readOnly: true
rawRecipe:
type: string
description: |-
Recipe in YAML format describes the components of a pipeline and how they
are connected.
description: |-
Pipeline releases contain the version control information of a pipeline.
This allows users to track changes in the pipeline over time.
Expand Down
6 changes: 6 additions & 0 deletions vdp/pipeline/v1beta/pipeline.proto
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,9 @@ message Pipeline {
repeated string tags = 25 [(google.api.field_behavior) = OUTPUT_ONLY];
// Statistic data.
Stats stats = 26;
// Recipe in YAML format describes the components of a pipeline and how they
// are connected.
string raw_recipe = 27 [(google.api.field_behavior) = OPTIONAL];
}

// TriggerMetadata contains the traces of the pipeline inference.
Expand Down Expand Up @@ -240,6 +243,9 @@ message PipelineRelease {
string readme = 13 [(google.api.field_behavior) = OPTIONAL];
// Data specifications.
DataSpecification data_specification = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
// Recipe in YAML format describes the components of a pipeline and how they
// are connected.
string raw_recipe = 15 [(google.api.field_behavior) = OPTIONAL];
}

// ListPipelinesRequest represents a request to list pipelines.
Expand Down

0 comments on commit afe1b7d

Please sign in to comment.