add maintainence comments for manually edited types files

Author: sid-rl

src/runloop_api_client/types/devbox_create_params.py

@@ -11,7 +11,14 @@
 
 __all__ = ["DevboxCreateParams"]
 
+# We split up the original DevboxCreateParams into two nested classes to enable us to
+# omit blueprint_id, blueprint_name, and snapshot_id when we unpack the TypedDict
+# params for methods like create_from_blueprint_id, create_from_blueprint_name, and
+# create_from_snapshot, which shouldn't allow you to specify creation source kwargs.
 
+
+# DevboxBaseCreateParams should contain all the fields that are common to all the
+# create methods. Any updates to the OpenAPI spec should be reflected here.
 class DevboxBaseCreateParams(TypedDict, total=False):
     code_mounts: Optional[Iterable[CodeMountParameters]]
     """A list of code mounts to be included in the Devbox."""
@@ -53,6 +60,8 @@ class DevboxBaseCreateParams(TypedDict, total=False):
     """
 
 
+# DevboxCreateParams should only implement fields that specify the devbox creation source.
+# These are omitted from specialized create methods.
 class DevboxCreateParams(DevboxBaseCreateParams, total=False):
     blueprint_id: Optional[str]
     """Blueprint ID to use for the Devbox.

src/runloop_api_client/types/object_create_params.py

@@ -8,6 +8,8 @@
 __all__ = ["ObjectCreateParams"]
 
 
+# We manually define the content type here to use as a type hint in the SDK.
+# If the API supports new content types, update this list accordingly.
 ContentType = Literal["unspecified", "text", "binary", "gzip", "tar", "tgz"]