Validate and update sample output for media type hint change (#2369)

This is the Azure companion of
microsoft/typespec#6357

This PR updates the recorded sample output to account for changes to the
default content types of scalars.

Author: witemple-msft

.chronus/changes/witemple-msft-media-type-hint-2025-2-14-16-25-14.md

@@ -0,0 +1,7 @@
+---
+changeKind: internal
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Update some tests and logic around constant/string content-type parameters.

core

@@ -139,6 +139,9 @@
           "LibraryService"
         ],
         "description": "Merges two shelves by adding all books from the shelf named\n`other_shelf_name` to shelf `name`, and deletes\n`other_shelf_name`. Returns the updated shelf.\nThe book ids of the moved books may not be the same as the original books.\nReturns NOT_FOUND if either shelf does not exist.\nThis call is a no-op if the specified shelves are the same.",
+        "consumes": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "$ref": "#/parameters/MergeShelvesRequest.name"

packages/samples/test/output/core/grpc-library-example/@azure-tools/typespec-autorest/openapi.json

@@ -180,6 +180,10 @@
           "Widgets"
         ],
         "description": "Analyze a widget",
+        "produces": [
+          "text/plain",
+          "application/json"
+        ],
         "parameters": [
           {
             "name": "id",

packages/samples/test/output/core/init/@azure-tools/typespec-autorest/openapi.json

@@ -23,6 +23,9 @@
     "/": {
       "post": {
         "operationId": "SubC_AnotherOp",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "body",
@@ -58,6 +61,9 @@
     "/sub/a/subsub": {
       "post": {
         "operationId": "SubSubA_DoSomething",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "thing",
@@ -81,6 +87,9 @@
     "/sub/b": {
       "post": {
         "operationId": "SubB_DoSomething",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "thing",

packages/samples/test/output/core/nested/@azure-tools/typespec-autorest/openapi.json

@@ -23,6 +23,9 @@
     "/test": {
       "get": {
         "operationId": "OptionalMethods_Read",
+        "consumes": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "queryString",

packages/samples/test/output/core/optional/@azure-tools/typespec-autorest/openapi.json

@@ -23,6 +23,9 @@
     "/alpha/{id}": {
       "get": {
         "operationId": "DoAlpha",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "id",
@@ -44,6 +47,9 @@
     "/beta/{id}": {
       "get": {
         "operationId": "DoBeta",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "id",

packages/samples/test/output/core/simple/@azure-tools/typespec-autorest/openapi.json

@@ -46,6 +46,10 @@
       "put": {
         "operationId": "bool_putFalse",
         "description": "Set Boolean value false",
+        "produces": [
+          "text/plain",
+          "application/json"
+        ],
         "parameters": [
           {
             "name": "value",
@@ -79,6 +83,10 @@
       "get": {
         "operationId": "bool_getInvalid",
         "description": "Get invalid Boolean value",
+        "produces": [
+          "text/plain",
+          "application/json"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -100,6 +108,10 @@
       "get": {
         "operationId": "bool_getNull",
         "description": "Get null Boolean value",
+        "produces": [
+          "text/plain",
+          "application/json"
+        ],
         "parameters": [],
         "responses": {
           "200": {

packages/samples/test/output/core/testserver/body-boolean/@azure-tools/typespec-autorest/openapi.json

@@ -31,13 +31,16 @@
           "String Operations"
         ],
         "description": "Get value that is base64 encoded",
+        "produces": [
+          "application/octet-stream",
+          "application/json"
+        ],
         "parameters": [],
         "responses": {
           "200": {
             "description": "The request has succeeded.",
             "schema": {
-              "type": "string",
-              "format": "byte"
+              "type": "file"
             }
           },
           "default": {
@@ -54,14 +57,17 @@
           "String Operations"
         ],
         "description": "Put value that is base64 encoded",
+        "consumes": [
+          "application/octet-stream"
+        ],
         "parameters": [
           {
             "name": "value",
             "in": "body",
             "required": true,
             "schema": {
               "type": "string",
-              "format": "byte"
+              "format": "binary"
             }
           }
         ],

packages/samples/test/output/core/testserver/body-string/@azure-tools/typespec-autorest/openapi.json

@@ -24,6 +24,10 @@
       "get": {
         "operationId": "Time_Get",
         "description": "Get time value \"11:34:56\"",
+        "produces": [
+          "text/plain",
+          "application/json"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -44,6 +48,9 @@
       "put": {
         "operationId": "Time_Put",
         "description": "Put time value \"08:07:56\"",
+        "consumes": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "value",

packages/samples/test/output/core/testserver/body-time/@azure-tools/typespec-autorest/openapi.json

@@ -24,6 +24,9 @@
       "post": {
         "operationId": "AnalyzeBody",
         "description": "Analyze body, that could be different media types.",
+        "produces": [
+          "text/plain"
+        ],
         "consumes": [
           "application/pdf",
           "application/json",
@@ -50,6 +53,9 @@
       "post": {
         "operationId": "contentTypeWithEncoding",
         "description": "Pass in contentType 'text/plain; encoding=UTF-8' to pass test. Value for input does not matter",
+        "produces": [
+          "text/plain"
+        ],
         "consumes": [
           "text/plain"
         ],

packages/samples/test/output/core/testserver/media-types/@azure-tools/typespec-autorest/openapi.json

@@ -24,6 +24,10 @@
       "get": {
         "operationId": "MultipleInheritance_GetCat",
         "description": "Get a cat with name 'Whiskers' where likesMilk, meows, and hisses is true",
+        "produces": [
+          "application/json",
+          "text/plain"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -43,6 +47,9 @@
       "put": {
         "operationId": "MultipleInheritance_PutCat",
         "description": "Put a cat with name 'Boots' where likesMilk and hisses is false, meows is true",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "cat",
@@ -73,6 +80,10 @@
       "get": {
         "operationId": "MultipleInheritance_GetFeline",
         "description": "Get a feline where meows and hisses are true",
+        "produces": [
+          "application/json",
+          "text/plain"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -92,6 +103,9 @@
       "put": {
         "operationId": "MultipleInheritance_PutFeline",
         "description": "Put a feline who hisses and doesn't meow",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "feline",
@@ -122,6 +136,10 @@
       "get": {
         "operationId": "MultipleInheritance_GetHorse",
         "description": "Get a horse with name 'Fred' and isAShowHorse true",
+        "produces": [
+          "application/json",
+          "text/plain"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -141,6 +159,9 @@
       "put": {
         "operationId": "MultipleInheritance_PutHorse",
         "description": "Put a horse with name 'General' and isAShowHorse false",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "horse",
@@ -171,6 +192,10 @@
       "get": {
         "operationId": "MultipleInheritance_GetKitten",
         "description": "Get a kitten with name 'Gatito' where likesMilk and meows is true, and hisses and eatsMiceYet is false",
+        "produces": [
+          "application/json",
+          "text/plain"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -190,6 +215,9 @@
       "put": {
         "operationId": "MultipleInheritance_PutKitten",
         "description": "Put a kitten with name 'Kitty' where likesMilk and hisses is false, meows and eatsMiceYet is true",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "kitten",
@@ -220,6 +248,10 @@
       "get": {
         "operationId": "MultipleInheritance_GetPet",
         "description": "Get a pet with name 'Peanut'",
+        "produces": [
+          "application/json",
+          "text/plain"
+        ],
         "parameters": [],
         "responses": {
           "200": {
@@ -239,6 +271,9 @@
       "put": {
         "operationId": "MultipleInheritance_PutPet",
         "description": "Put a pet with name 'Butter'",
+        "produces": [
+          "text/plain"
+        ],
         "parameters": [
           {
             "name": "horse",

packages/samples/test/output/core/testserver/multiple-inheritance/@azure-tools/typespec-autorest/openapi.json

@@ -545,9 +545,8 @@ describe("binary responses", () => {
       @get op read(): bytes;
     `);
     const operation = res.paths["/"].get;
-    deepStrictEqual(operation.produces, undefined);
-    strictEqual(operation.responses["200"].schema.type, "string");
-    strictEqual(operation.responses["200"].schema.format, "byte");
+    deepStrictEqual(operation.produces, ["application/octet-stream"]);
+    strictEqual(operation.responses["200"].schema.type, "file");
   });
 
   it("@body body: bytes responses should produce application/json with byte schema", async () => {
@@ -556,9 +555,8 @@ describe("binary responses", () => {
     `);
 
     const operation = res.paths["/"].get;
-    deepStrictEqual(operation.produces, undefined);
-    strictEqual(operation.responses["200"].schema.type, "string");
-    strictEqual(operation.responses["200"].schema.format, "byte");
+    deepStrictEqual(operation.produces, ["application/octet-stream"]);
+    strictEqual(operation.responses["200"].schema.type, "file");
   });
 
   it("@header contentType should override content type and set type to file", async () => {

packages/typespec-autorest-canonical/test/return-types.test.ts

@@ -341,6 +341,7 @@ describe("typespec-autorest: metadata", () => {
       "/single/{p}": {
         get: {
           operationId: "Single",
+          produces: ["text/plain"],
           parameters: [
             { $ref: "#/parameters/Parameters.q" },
             { $ref: "#/parameters/Parameters.p" },
@@ -357,6 +358,7 @@ describe("typespec-autorest: metadata", () => {
       "/batch": {
         get: {
           operationId: "Batch",
+          produces: ["text/plain"],
           responses: {
             "200": {
               description: "The request has succeeded.",

packages/typespec-autorest/test/metadata.test.ts

@@ -587,11 +587,11 @@ describe("typespec-autorest: request", () => {
         @post op read(@body body: bytes): {};
       `);
       const operation = res.paths["/"].post;
-      deepStrictEqual(operation.consumes, undefined);
+      deepStrictEqual(operation.consumes, ["application/octet-stream"]);
       const requestBody = operation.parameters[0];
       ok(requestBody);
       strictEqual(requestBody.schema.type, "string");
-      strictEqual(requestBody.schema.format, "byte");
+      strictEqual(requestBody.schema.format, "binary");
     });
 
     it("bytes request should respect @header contentType", async () => {

packages/typespec-autorest/test/openapi-output.test.ts

@@ -478,7 +478,7 @@ describe("content type parameter", () => {
       ): void;
       `,
     );
-    strictEqual(res.paths["/"].post.consumes, undefined);
+    deepStrictEqual(res.paths["/"].post.consumes, ["text/plain"]);
   });
 });
 

packages/typespec-autorest/test/parameters.test.ts

@@ -543,9 +543,8 @@ describe("typespec-autorest: return types", () => {
         @get op read(): bytes;
       `);
       const operation = res.paths["/"].get;
-      deepStrictEqual(operation.produces, undefined);
-      strictEqual(operation.responses["200"].schema.type, "string");
-      strictEqual(operation.responses["200"].schema.format, "byte");
+      deepStrictEqual(operation.produces, ["application/octet-stream"]);
+      strictEqual(operation.responses["200"].schema.type, "file");
     });
 
     it("@body body: bytes responses should produce application/json with byte schema", async () => {
@@ -554,9 +553,8 @@ describe("typespec-autorest: return types", () => {
       `);
 
       const operation = res.paths["/"].get;
-      deepStrictEqual(operation.produces, undefined);
-      strictEqual(operation.responses["200"].schema.type, "string");
-      strictEqual(operation.responses["200"].schema.format, "byte");
+      deepStrictEqual(operation.produces, ["application/octet-stream"]);
+      strictEqual(operation.responses["200"].schema.type, "file");
     });
 
     it("@header contentType should override content type and set type to file", async () => {