chore: improve testdata

Author: ThomasRooney

pkg/overlay/testdata/openapi-overlayed.yaml

@@ -106,11 +106,15 @@ paths:
   /drinks:
     x-speakeasy-note:
       "$ref": "./removeNote.yaml"
-  /drink/{name}: #TODO: this should be by product code and we should have search by name
+  /drink/{name}: # Example comment -- should be maintained
     get:
       operationId: getDrink
       summary: Get a drink.
-      description: Get a drink by name, if authenticated this will include stock levels and product codes otherwise it will only include public information.
+      description: |
+        A long description
+        to validate that we handle indentation properly
+
+        With a second paragraph
       tags:
         - drinks
       parameters:

pkg/overlay/testdata/openapi-strict-onechange.yaml

@@ -128,7 +128,7 @@ paths:
           $ref: "#/components/responses/APIError"
         default:
           $ref: "#/components/responses/UnknownError"
-  /drink/{name}: #TODO: this should be by product code and we should have search by name
+  /drink/{name}: # Example comment -- should be maintained
     get:
       operationId: getDrink
       summary: Get a drink.

pkg/overlay/testdata/openapi.yaml

@@ -131,7 +131,7 @@ paths:
         default:
           $ref: "#/components/responses/UnknownError"
 
-  /drink/{name}: #TODO: this should be by product code and we should have search by name
+  /drink/{name}: # Example comment -- should be maintained
     get:
       operationId: getDrink
       summary: Get a drink.

pkg/overlay/testdata/overlay-generated.yaml

@@ -18,6 +18,12 @@ actions:
         "$ref": "./removeNote.yaml"
   - target: $["paths"]["/drinks"]["get"]
     remove: true
+  - target: $["paths"]["/drink/{name}"]["get"]["description"]
+    update: |
+      A long description
+      to validate that we handle indentation properly
+
+      With a second paragraph
   - target: $["paths"]["/drink/{name}"]["get"]["parameters"]
     update:
       - x-parameter-extension: foo

pkg/overlay/testdata/overlay.yaml

@@ -40,4 +40,11 @@ actions:
       servers:
         - url: http://localhost:35123
           description: The default server.
+  - target: $.paths["/drink/{name}"].get
+    update:
+      description: |
+        A long description
+        to validate that we handle indentation properly
+
+        With a second paragraph
 x-top-level-extension: true