Add multipartfile model in Azure.Core

.chronus/changes/add-multipartfile-model-2024-8-2-16-33-33.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-azure-core"
+---
+
+Add model MultiPartFile with required `filename` and `contentType`

docs/libraries/azure-core/reference/data-types.md

@@ -220,6 +220,21 @@ model Azure.Core.MaxPageSizeQueryParameter
 | ------------ | ------- | -------------------------------------------- |
 | maxpagesize? | `int32` | The maximum number of result items per page. |
 
+### `MultiPartFile` {#Azure.Core.MultiPartFile}
+
+Used in file part of multipart request body
+
+```typespec
+model Azure.Core.MultiPartFile
+```
+
+#### Properties
+
+| Name        | Type     | Description                                             |
+| ----------- | -------- | ------------------------------------------------------- |
+| filename    | `string` | The file name in file part of multipart request body    |
+| contentType | `string` | The content type in file part of multipart request body |
+
 ### `OrderByQueryParameter` {#Azure.Core.OrderByQueryParameter}
 
 Provides the standard 'orderby' query parameter for list operations.

docs/libraries/azure-core/reference/index.mdx

@@ -96,6 +96,7 @@ npm install --save-peer @azure-tools/typespec-azure-core
 - [`FilterParameter`](./data-types.md#Azure.Core.FilterParameter)
 - [`FilterQueryParameter`](./data-types.md#Azure.Core.FilterQueryParameter)
 - [`MaxPageSizeQueryParameter`](./data-types.md#Azure.Core.MaxPageSizeQueryParameter)
+- [`MultiPartFile`](./data-types.md#Azure.Core.MultiPartFile)
 - [`OrderByQueryParameter`](./data-types.md#Azure.Core.OrderByQueryParameter)
 - [`Page`](./data-types.md#Azure.Core.Page)
 - [`PollingOptions`](./data-types.md#Azure.Core.PollingOptions)

packages/typespec-azure-core/lib/models.tsp

@@ -400,3 +400,12 @@ model ArmResourceIdentifierAllowedResource {
    */
   scopes?: ArmResourceDeploymentScope[];
 }
+
+@doc("Used in file part of multipart request body")
+model MultiPartFile extends File {
+  @doc("The file name in file part of multipart request body")
+  filename: string;
+
+  @doc("The content type in file part of multipart request body")
+  contentType: string;
+}

packages/typespec-azure-core/test/models.test.ts

@@ -0,0 +1,30 @@
+import { expectDiagnosticEmpty } from "@typespec/compiler/testing";
+import { getHttpPart, isOrExtendsHttpFile } from "@typespec/http";
+import { ok, strictEqual } from "assert";
+import { describe, it } from "vitest";
+import { getOperations } from "./test-host.js";
+
+describe("typespec-azure-core: models", () => {
+  it("MultiPartFile could be recognized by @typespec/http", async () => {
+    const [operations, diagnostics, runner] = await getOperations(
+      `
+      model TestModel {
+        file: HttpPart<MultiPartFile>;
+      };
+
+      @post op TestOperation(@header contentType: "multipart/form-date", @multipartBody body: TestModel): void;
+      `
+    );
+
+    ok(operations.length === 1);
+    ok(operations[0].parameters.body);
+    strictEqual(operations[0].parameters.body.bodyKind, "multipart");
+    strictEqual(operations[0].parameters.body.type.kind, "Model");
+    const fileHttpPart = operations[0].parameters.body.type.properties.get("file");
+    ok(fileHttpPart);
+    const file = getHttpPart(runner.program, fileHttpPart.type);
+    ok(file !== undefined);
+    ok(isOrExtendsHttpFile(runner.program, file.type));
+    expectDiagnosticEmpty(diagnostics);
+  });
+});

packages/typespec-client-generator-core/test/types/multipart-types.test.ts

@@ -1,3 +1,4 @@
+import { AzureCoreTestLibrary } from "@azure-tools/typespec-azure-core/testing";
 import { expectDiagnostics } from "@typespec/compiler/testing";
 import { deepEqual, ok, strictEqual } from "assert";
 import { beforeEach, describe, it } from "vitest";
@@ -454,6 +455,52 @@ describe("typespec-client-generator-core: multipart types", () => {
     strictEqual(fileRequiredFileName.multipartOptions.contentType.optional, false);
   });
 
+  it("with MultiPartFile of Azure.Core", async function () {
+    const runnerCore = await createSdkTestRunner({
+      librariesToAdd: [AzureCoreTestLibrary],
+      emitterName: "@azure-tools/typespec-java",
+      autoUsings: ["Azure.Core"],
+    });
+    await runnerCore.compileWithBuiltInService(`
+        model MultiPartRequest{
+            fileOptionalFileName: HttpPart<File>;
+            fileRequiredFileName: HttpPart<MultiPartFile>;
+        }
+        @post
+        op upload(@header contentType: "multipart/form-data", @multipartBody body: MultiPartRequest): void;
+        `);
+    const models = runnerCore.context.sdkPackage.models;
+    strictEqual(models.length, 2);
+    const MultiPartRequest = models.find((x) => x.name === "MultiPartRequest");
+    ok(MultiPartRequest);
+    ok(MultiPartRequest.usage & UsageFlags.MultipartFormData);
+    const fileOptionalFileName = MultiPartRequest.properties.find(
+      (x) => x.name === "fileOptionalFileName"
+    ) as SdkBodyModelPropertyType;
+    ok(fileOptionalFileName);
+    strictEqual(fileOptionalFileName.optional, false);
+    ok(fileOptionalFileName.multipartOptions);
+    strictEqual(fileOptionalFileName.name, "fileOptionalFileName");
+    strictEqual(fileOptionalFileName.multipartOptions.isFilePart, true);
+    ok(fileOptionalFileName.multipartOptions.filename);
+    strictEqual(fileOptionalFileName.multipartOptions.filename.optional, true);
+    ok(fileOptionalFileName.multipartOptions.contentType);
+    strictEqual(fileOptionalFileName.multipartOptions.contentType.optional, true);
+
+    const fileRequiredFileName = MultiPartRequest.properties.find(
+      (x) => x.name === "fileRequiredFileName"
+    ) as SdkBodyModelPropertyType;
+    ok(fileRequiredFileName);
+    strictEqual(fileRequiredFileName.optional, false);
+    ok(fileRequiredFileName.multipartOptions);
+    strictEqual(fileRequiredFileName.name, "fileRequiredFileName");
+    strictEqual(fileRequiredFileName.multipartOptions.isFilePart, true);
+    ok(fileRequiredFileName.multipartOptions.filename);
+    strictEqual(fileRequiredFileName.multipartOptions.filename.optional, false);
+    ok(fileRequiredFileName.multipartOptions.contentType);
+    strictEqual(fileRequiredFileName.multipartOptions.contentType.optional, false);
+  });
+
   it("check 'multi' of multipart with @multipartBody for model", async function () {
     await runner.compileWithBuiltInService(`
         model Address {