From e24c3a7cd25b74ce998fb8c965a738ce648959d9 Mon Sep 17 00:00:00 2001 From: Shreyas Goenka Date: Mon, 7 Oct 2024 11:52:25 +0200 Subject: [PATCH] address comments --- bundle/internal/schema/main.go | 16 ++++++++++++---- ...yment.yml => hidden_job_field_deployment.yml} | 0 ...t_mode.yml => hidden_job_field_edit_mode.yml} | 0 3 files changed, 12 insertions(+), 4 deletions(-) rename bundle/internal/schema/testdata/fail/{deprecated_job_field_deployment.yml => hidden_job_field_deployment.yml} (100%) rename bundle/internal/schema/testdata/fail/{deprecated_job_field_edit_mode.yml => hidden_job_field_edit_mode.yml} (100%) diff --git a/bundle/internal/schema/main.go b/bundle/internal/schema/main.go index 8d97571bd..482c1b4ae 100644 --- a/bundle/internal/schema/main.go +++ b/bundle/internal/schema/main.go @@ -68,14 +68,22 @@ func addInterpolationPatterns(typ reflect.Type, s jsonschema.Schema) jsonschema. } } -func removeDeprecatedJobsFields(typ reflect.Type, s jsonschema.Schema) jsonschema.Schema { +func removeJobsFields(typ reflect.Type, s jsonschema.Schema) jsonschema.Schema { switch typ { case reflect.TypeOf(resources.Job{}): - delete(s.Properties, "deployment") - delete(s.Properties, "edit_mode") + // This field has been deprecated in jobs API v2.1 and is always set to + // "MULTI_TASK" in the backend. We should not expose it to the user. delete(s.Properties, "format") + // These fields are only meant to be set by the DABs client (ie the CLI) + // and thus should not be exposed to the user. These are used to annotate + // jobs that were created by DABs. + delete(s.Properties, "deployment") + delete(s.Properties, "edit_mode") + + case reflect.TypeOf(jobs.GitSource{}): + // These fields are readonly and are not meant to be set by the user. delete(s.Properties, "job_source") delete(s.Properties, "git_snapshot") @@ -110,7 +118,7 @@ func main() { s, err := jsonschema.FromType(reflect.TypeOf(config.Root{}), []func(reflect.Type, jsonschema.Schema) jsonschema.Schema{ p.addDescriptions, p.addEnums, - removeDeprecatedJobsFields, + removeJobsFields, addInterpolationPatterns, }) if err != nil { diff --git a/bundle/internal/schema/testdata/fail/deprecated_job_field_deployment.yml b/bundle/internal/schema/testdata/fail/hidden_job_field_deployment.yml similarity index 100% rename from bundle/internal/schema/testdata/fail/deprecated_job_field_deployment.yml rename to bundle/internal/schema/testdata/fail/hidden_job_field_deployment.yml diff --git a/bundle/internal/schema/testdata/fail/deprecated_job_field_edit_mode.yml b/bundle/internal/schema/testdata/fail/hidden_job_field_edit_mode.yml similarity index 100% rename from bundle/internal/schema/testdata/fail/deprecated_job_field_edit_mode.yml rename to bundle/internal/schema/testdata/fail/hidden_job_field_edit_mode.yml