chore: add missing docstrings

Author: stainless-app[bot]

src/gitpod/types/account_list_login_providers_params.py

@@ -22,11 +22,15 @@ class AccountListLoginProvidersParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
+    """filter contains the filter options for listing login methods"""
+
     invite_id: Annotated[str, PropertyInfo(alias="inviteId")]
     """invite_id is the ID of the invite URL the user wants to login with"""
 
 
 class Pagination(TypedDict, total=False):
+    """pagination contains the pagination options for listing login methods"""
+
     token: str
     """
     Token for the next set of results that was returned as next_token of a

src/gitpod/types/editor_list_params.py

@@ -22,6 +22,8 @@ class EditorListParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
+    """filter contains the filter options for listing editors"""
+
     allowed_by_policy: Annotated[bool, PropertyInfo(alias="allowedByPolicy")]
     """
     allowed_by_policy filters the response to only editors that are allowed by the
@@ -30,6 +32,8 @@ class Filter(TypedDict, total=False):
 
 
 class Pagination(TypedDict, total=False):
+    """pagination contains the pagination options for listing environments"""
+
     token: str
     """
     Token for the next set of results that was returned as next_token of a

src/gitpod/types/environment.py

@@ -11,6 +11,8 @@
 
 
 class Environment(BaseModel):
+    """+resource get environment"""
+
     id: str
     """ID is a unique identifier of this environment.
 

src/gitpod/types/environment_activity_signal.py

@@ -9,6 +9,8 @@
 
 
 class EnvironmentActivitySignal(BaseModel):
+    """EnvironmentActivitySignal used to signal activity for an environment."""
+
     source: Optional[str] = None
     """
     source of the activity signal, such as "VS Code", "SSH", or "Automations". It

src/gitpod/types/environment_activity_signal_param.py

@@ -12,6 +12,8 @@
 
 
 class EnvironmentActivitySignalParam(TypedDict, total=False):
+    """EnvironmentActivitySignal used to signal activity for an environment."""
+
     source: str
     """
     source of the activity signal, such as "VS Code", "SSH", or "Automations". It

src/gitpod/types/environment_initializer.py

@@ -49,4 +49,6 @@ class Spec(BaseModel):
 
 
 class EnvironmentInitializer(BaseModel):
+    """EnvironmentInitializer specifies how an environment is to be initialized"""
+
     specs: Optional[List[Spec]] = None

src/gitpod/types/environment_initializer_param.py

@@ -50,4 +50,6 @@ class Spec(TypedDict, total=False):
 
 
 class EnvironmentInitializerParam(TypedDict, total=False):
+    """EnvironmentInitializer specifies how an environment is to be initialized"""
+
     specs: Iterable[Spec]

src/gitpod/types/environment_list_params.py

@@ -69,6 +69,8 @@ class Filter(TypedDict, total=False):
 
 
 class Pagination(TypedDict, total=False):
+    """pagination contains the pagination options for listing environments"""
+
     token: str
     """
     Token for the next set of results that was returned as next_token of a

src/gitpod/types/environment_metadata.py

@@ -12,6 +12,11 @@
 
 
 class EnvironmentMetadata(BaseModel):
+    """
+    EnvironmentMetadata is data associated with an environment that's required for
+     other parts of the system to function
+    """
+
     annotations: Optional[Dict[str, str]] = None
     """
     annotations are key/value pairs that gets attached to the environment.

src/gitpod/types/environment_spec.py

@@ -24,6 +24,8 @@
 
 
 class AutomationsFile(BaseModel):
+    """automations_file is the automations file spec of the environment"""
+
     automations_file_path: Optional[str] = FieldInfo(alias="automationsFilePath", default=None)
     """
     automations_file_path is the path to the automations file that is applied in the
@@ -39,6 +41,8 @@ class AutomationsFile(BaseModel):
 
 
 class Content(BaseModel):
+    """content is the content spec of the environment"""
+
     git_email: Optional[str] = FieldInfo(alias="gitEmail", default=None)
     """The Git email address"""
 
@@ -52,11 +56,15 @@ class Content(BaseModel):
 
 
 class DevcontainerDotfiles(BaseModel):
+    """Experimental: dotfiles is the dotfiles configuration of the devcontainer"""
+
     repository: str
     """URL of a dotfiles Git repository (e.g. https://github.com/owner/repository)"""
 
 
 class Devcontainer(BaseModel):
+    """devcontainer is the devcontainer spec of the environment"""
+
     default_devcontainer_image: Optional[str] = FieldInfo(alias="defaultDevcontainerImage", default=None)
     """
     default_devcontainer_image is the default image that is used to start the
@@ -80,6 +88,8 @@ class Devcontainer(BaseModel):
 
 
 class Machine(BaseModel):
+    """machine is the machine spec of the environment"""
+
     class_: Optional[str] = FieldInfo(alias="class", default=None)
     """Class denotes the class of the environment we ought to start"""
 
@@ -139,6 +149,8 @@ class SSHPublicKey(BaseModel):
 
 
 class Timeout(BaseModel):
+    """Timeout configures the environment timeout"""
+
     disconnected: Optional[str] = None
     """
     inacitivity is the maximum time of disconnection before the environment is
@@ -147,6 +159,11 @@ class Timeout(BaseModel):
 
 
 class EnvironmentSpec(BaseModel):
+    """
+    EnvironmentSpec specifies the configuration of an environment for an environment
+     start
+    """
+
     admission: Optional[AdmissionLevel] = None
     """admission controlls who can access the environment and its ports."""