From c7a432fd735944dca0f7a18a99bc14980ae22f0f Mon Sep 17 00:00:00 2001
From: Denis DelGrosso <ddelgrosso@google.com>
Date: Wed, 3 Apr 2024 13:30:59 +0000
Subject: [PATCH] add spec note

---
 src/gaxios.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/gaxios.ts b/src/gaxios.ts
index 7447e287..be9ffb0d 100644
--- a/src/gaxios.ts
+++ b/src/gaxios.ts
@@ -434,6 +434,8 @@ export class Gaxios {
 
   /**
    * Creates an async generator that yields the pieces of a multipart/related request body.
+   * This implementation follows the spec: https://www.ietf.org/rfc/rfc2387.txt. However, recursive
+   * multipart/related requests are not currently supported.
    *
    * @param {GaxioMultipartOptions[]} multipartOptions the pieces to turn into a multipart/related body.
    * @param {string} boundary the boundary string to be placed between each part.