pipe-cd/pipecd

Proposal: Provide official JSON Schema for ECS configuration(maybe other providers too ?)

Open

#6,684 opened on 2026年4月17日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Go (319 forks)auto 404
good first issue

Repository metrics

Stars
 (1,329 stars)
PR merge metrics
 (PR metrics pending)

説明

What would you like to be added: A helper mechanism for validating and exploring YAML configuration fields, ideally with autocomplete and schema validation support.

Why is this needed:

  • Context: When working with the ECS UpdateService API, configuration errors can be surprisingly hard to detect, especially when they involve incorrect field names that are silently ignored or not clearly validated

Example

deploymentConfiguration:
  deploymentStrategy: BLUE_GREEN # Wrong field name, it should be strategy

There is no immediate feedback, the API does not clearly indicate the mismatch which led to significant debugging time. At one point, it even caused confusion for me about whether UpdateService API supports changing deployment strategy at all

My implication for the above example is there should be a way to enforce and robust the way we write config.

Potential solution: Leverage YAML schema validation via JSON Schema, which is already supported by tools like the Red Hat YAML Language Server

How it works ?: By adding this line at the top of a YAML file:

# yaml-language-server: $schema=<path-to-json-schema-file>

How to generate JSON schema ?: By using package github.com/invopop/jsonschema, we can generate a JSON schema like this

	// Generate schema
	r := &jsonschema.Reflector{
		KeyNamer: func(s string) string {
			if len(s) == 0 {
				return s
			}
			return strings.ToLower(s[:1]) + s[1:] // lowercase the first character
		},
		RequiredFromJSONSchemaTags: true,
	}
	schema := r.Reflect(&ecs.CreateServiceInput{})
	output, _ := json.MarshalIndent(schema, "", "  ")

	file, err := os.Create("output.json")
	if err != nil {
		panic(err)
	}
	defer file.Close()

	file.Write(output)

Example result

Should we create and maintain something like this ? https://pipecd.dev/jsonschema/plugins/ecs/service.json

I would love to have discussion about this

コントリビューターガイド