File Download

[Jawsome Rodeo (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

[Timothee Guerin (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

[Jawsome Rodeo (yeaharh)]

Thanks you.

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

[Timothee Guerin (timotheeguerin)]

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

[Jawsome Rodeo (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.

Mark (@doc)("ScanRequest Payload")
model ScanRequest {

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

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

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

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