← All recipes
Open source

Change key

Recipe IDorg.openrewrite.yaml.ChangeKey
Artifactorg.openrewrite:rewrite-yaml

Change a YAML mapping entry key while leaving the value intact.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.yaml.ChangeKey --recipe-option "oldKeyPath=$.subjects.kind" --recipe-option "newKey=kind"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-yaml:8.88.0

Options

NameTypeDescription
oldKeyPathrequiredStringA JsonPath expression to locate a YAML entry.
e.g. $.subjects.kind
newKeyrequiredStringThe new name for the key selected by the oldKeyPath.
e.g. kind

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats