Support for multi-line scalars

[dzucker-tab]

Currently, I cannot find any way to create an overlay that updates a description: field so that it contains a multiline scalar. Is this on your roadmap?

For example:

  description: |-
    First line of markdown content.

    Second line of mark content.

[thim81]

hi @dzucker-tab

I can have a look to introduce it, I'll use your example to see where we land.

[thim81]

hi @dzucker-tab

I was able to create an example overlay in the openapi-playground, which seems to work just out-of-the-box.

Is this what you are looking for?

overlay.yaml

overlay: 1.0.0
info:
  title: Set multiline description
  version: '1.0'
actions:
  - target: $.info
    update:
      description: |-
        First line of markdown content.

        Second line of markdown content.
  - target: "$.paths['/test'].get"
    update:
      description: |-
        Path description line 1.

        Path description line 2.