File Download

[yeaharh]

Hi

We're building an OpenAPI compliant API that will return a pdf file from a get request.
Is there an example we can look at?

Rgds
Jim

[timotheeguerin]

You can do that by setting the content type and the body to be bytes

import "@typespec/http";

using TypeSpec.Http;

op download(): {
  @header contentType: "application/pdf";
  @body file: bytes;
};

Playground

[yeaharh]

Thanks you.

Is it possible to return (download) both the pdf and a json payload. Something like a multipart/form-data upload.

[timotheeguerin]

not sure what you mean, can you share what openapi you would like to see?

[yeaharh]

We have a file upload API which is using the multipart/form-data content type. This allows a file to be uploaded as one part and json in another part.

@doc("ScanRequest Payload")
model ScanRequest {

// Request Headers
// api version header
@doc("api version header")
@Header apiVersion: apiVersionNumber;
// content-type header
@Header contentType: "multipart/form-data";
// tenantName header associated with the scan request
@doc("tenantName header")
@Header tenantName: string;

// Request Query Parameters
@doc("Unique identifier for the scan request")
@Format("uuid")
@query scanRequestId?: string;

// Request Body
@doc("filename of file to scan")
fileName: string;
@doc("file content to scan")
@Format("binary")
fileToScan: string;
}

Just wondering if the same (multipart) approach is possible with a download.