yaml 模板（可能是 yq）

Question

Hello currently I try to find a tool (I'm pretty sure yq does not the magic for me) to remove some content from a yaml file. My file looks as following:

  paths:
    /entity/{id}:
      get:
        tags: a
        summary: b
      ...

So its a typical openapi-specification. I would like to add a magic property for example 'env: prod' so that some endpoints look as following:

  paths:
    /entity/{id}:
      get:
        env: prod
        tags: a
        summary: b
      ...

Is there a solution to remove all endpoints, which contain env: prod?

I am also free to change the concept. If there would be some transformation with a if else I would be very happy.

Answer 1

Using kislyuk/yq :

yq -y '.[][][] |= ({env: "prod"} + .)'

Using mikefarah/yq :

yq '.[][][] |= ({"env": "prod"} + .)'

Both produce:

paths:
  /entity/{id}:
    get:
      env: prod
      tags: a
      summary: b

This adds env: prod to every object that is three levels deep. If you want the criteria be more sophisticated, you will have to adapt .[][][] accordingly.

Answer 2

yq 'del(.. | select(.env == "prod"))' file.yaml

Explanation: You want to delete all the nodes that have a child 'env' property set to 'prod'.

• .. recursively matches all nodes
• select(.env == "prod") select the ones that have a env property equal to "prod"
• del(.. | select(.env == "prod") delete those nodes :)

Disclaimer: I wrote mikefarah/yq