feat(api): add recommended editors configuration to project settings

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 160
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-665d1d0e7f0040c5fbbb664487724af4ecc58d3c702e8099ceef4a05ba589369.yml
-openapi_spec_hash: 3688253b79ec0cf6d41ff586d71e9f07
-config_hash: 8e1b089e9f5af438fd56b523014af4f2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-6f686822d27e00f05b67afc31efefd873ce20db2be25174500da54a30f650875.yml
+openapi_spec_hash: 24bd6ab0ff2eed7121942da895863810
+config_hash: 06c6c8640b0bb0692f8f2361c6660f8a

api.md

@@ -498,6 +498,7 @@ from gitpod.types import (
     ProjectMetadata,
     ProjectPhase,
     ProjectPrebuildConfiguration,
+    RecommendedEditors,
     ProjectCreateResponse,
     ProjectRetrieveResponse,
     ProjectUpdateResponse,

src/gitpod/resources/projects/projects.py

@@ -46,6 +46,7 @@
 from ...types.project_create_response import ProjectCreateResponse
 from ...types.project_update_response import ProjectUpdateResponse
 from ...types.project_retrieve_response import ProjectRetrieveResponse
+from ...types.recommended_editors_param import RecommendedEditorsParam
 from ...types.environment_initializer_param import EnvironmentInitializerParam
 from ...types.project_prebuild_configuration_param import ProjectPrebuildConfigurationParam
 from ...types.project_create_from_environment_response import ProjectCreateFromEnvironmentResponse
@@ -244,6 +245,7 @@ def update(
         name: Optional[str] | Omit = omit,
         prebuild_configuration: Optional[ProjectPrebuildConfigurationParam] | Omit = omit,
         project_id: str | Omit = omit,
+        recommended_editors: Optional[RecommendedEditorsParam] | Omit = omit,
         technical_description: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -313,6 +315,10 @@ def update(
 
           project_id: project_id specifies the project identifier
 
+          recommended_editors: recommended_editors specifies the editors recommended for this project. If not
+              provided, the existing recommended editors are not modified. To clear all
+              recommended editors, set to an empty RecommendedEditors message.
+
           technical_description: technical_description is a detailed technical description of the project This
               field is not returned by default in GetProject or ListProjects responses 8KB max
 
@@ -334,6 +340,7 @@ def update(
                     "name": name,
                     "prebuild_configuration": prebuild_configuration,
                     "project_id": project_id,
+                    "recommended_editors": recommended_editors,
                     "technical_description": technical_description,
                 },
                 project_update_params.ProjectUpdateParams,
@@ -716,6 +723,7 @@ async def update(
         name: Optional[str] | Omit = omit,
         prebuild_configuration: Optional[ProjectPrebuildConfigurationParam] | Omit = omit,
         project_id: str | Omit = omit,
+        recommended_editors: Optional[RecommendedEditorsParam] | Omit = omit,
         technical_description: Optional[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -785,6 +793,10 @@ async def update(
 
           project_id: project_id specifies the project identifier
 
+          recommended_editors: recommended_editors specifies the editors recommended for this project. If not
+              provided, the existing recommended editors are not modified. To clear all
+              recommended editors, set to an empty RecommendedEditors message.
+
           technical_description: technical_description is a detailed technical description of the project This
               field is not returned by default in GetProject or ListProjects responses 8KB max
 
@@ -806,6 +818,7 @@ async def update(
                     "name": name,
                     "prebuild_configuration": prebuild_configuration,
                     "project_id": project_id,
+                    "recommended_editors": recommended_editors,
                     "technical_description": technical_description,
                 },
                 project_update_params.ProjectUpdateParams,

src/gitpod/types/__init__.py

@@ -94,6 +94,7 @@
 from .organization_member import OrganizationMember as OrganizationMember
 from .prebuild_spec_param import PrebuildSpecParam as PrebuildSpecParam
 from .project_list_params import ProjectListParams as ProjectListParams
+from .recommended_editors import RecommendedEditors as RecommendedEditors
 from .environment_metadata import EnvironmentMetadata as EnvironmentMetadata
 from .event_watch_response import EventWatchResponse as EventWatchResponse
 from .exception_info_param import ExceptionInfoParam as ExceptionInfoParam
@@ -154,6 +155,7 @@
 from .exception_mechanism_param import ExceptionMechanismParam as ExceptionMechanismParam
 from .organization_leave_params import OrganizationLeaveParams as OrganizationLeaveParams
 from .project_retrieve_response import ProjectRetrieveResponse as ProjectRetrieveResponse
+from .recommended_editors_param import RecommendedEditorsParam as RecommendedEditorsParam
 from .secret_get_value_response import SecretGetValueResponse as SecretGetValueResponse
 from .user_set_suspended_params import UserSetSuspendedParams as UserSetSuspendedParams
 from .agent_create_prompt_params import AgentCreatePromptParams as AgentCreatePromptParams

src/gitpod/types/project.py

@@ -8,6 +8,7 @@
 from .project_phase import ProjectPhase
 from .shared.subject import Subject
 from .project_metadata import ProjectMetadata
+from .recommended_editors import RecommendedEditors
 from .environment_initializer import EnvironmentInitializer
 from .project_prebuild_configuration import ProjectPrebuildConfiguration
 from .shared.project_environment_class import ProjectEnvironmentClass
@@ -64,6 +65,9 @@ class Project(BaseModel):
     )
     """prebuild_configuration defines how prebuilds are created for this project."""
 
+    recommended_editors: Optional[RecommendedEditors] = FieldInfo(alias="recommendedEditors", default=None)
+    """recommended_editors specifies the editors recommended for this project."""
+
     technical_description: Optional[str] = FieldInfo(alias="technicalDescription", default=None)
     """
     technical_description is a detailed technical description of the project This

src/gitpod/types/project_update_params.py

@@ -6,6 +6,7 @@
 from typing_extensions import Annotated, TypedDict
 
 from .._utils import PropertyInfo
+from .recommended_editors_param import RecommendedEditorsParam
 from .environment_initializer_param import EnvironmentInitializerParam
 from .project_prebuild_configuration_param import ProjectPrebuildConfigurationParam
 
@@ -50,6 +51,13 @@ class ProjectUpdateParams(TypedDict, total=False):
     project_id: Annotated[str, PropertyInfo(alias="projectId")]
     """project_id specifies the project identifier"""
 
+    recommended_editors: Annotated[Optional[RecommendedEditorsParam], PropertyInfo(alias="recommendedEditors")]
+    """
+    recommended_editors specifies the editors recommended for this project. If not
+    provided, the existing recommended editors are not modified. To clear all
+    recommended editors, set to an empty RecommendedEditors message.
+    """
+
     technical_description: Annotated[Optional[str], PropertyInfo(alias="technicalDescription")]
     """
     technical_description is a detailed technical description of the project This

src/gitpod/types/recommended_editors.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["RecommendedEditors", "Editors"]
+
+
+class Editors(BaseModel):
+    """EditorVersions contains the recommended versions for an editor."""
+
+    versions: Optional[List[str]] = None
+    """
+    versions is the list of recommended versions for this editor. If empty, all
+    available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"]
+    """
+
+
+class RecommendedEditors(BaseModel):
+    """RecommendedEditors contains the map of recommended editors and their versions."""
+
+    editors: Optional[Dict[str, Editors]] = None
+    """
+    editors maps editor aliases to their recommended versions. Key is the editor
+    alias (e.g., "intellij", "goland", "vscode"). Value contains the list of
+    recommended versions for that editor. If versions list is empty, all available
+    versions are recommended. Example: {"intellij": {versions: ["2025.1",
+    "2024.3"]}, "goland": {}}
+    """

src/gitpod/types/recommended_editors_param.py

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["RecommendedEditorsParam", "Editors"]
+
+
+class Editors(TypedDict, total=False):
+    """EditorVersions contains the recommended versions for an editor."""
+
+    versions: SequenceNotStr[str]
+    """
+    versions is the list of recommended versions for this editor. If empty, all
+    available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"]
+    """
+
+
+class RecommendedEditorsParam(TypedDict, total=False):
+    """RecommendedEditors contains the map of recommended editors and their versions."""
+
+    editors: Dict[str, Editors]
+    """
+    editors maps editor aliases to their recommended versions. Key is the editor
+    alias (e.g., "intellij", "goland", "vscode"). Value contains the list of
+    recommended versions for that editor. If versions list is empty, all available
+    versions are recommended. Example: {"intellij": {versions: ["2025.1",
+    "2024.3"]}, "goland": {}}
+    """

tests/api_resources/test_projects.py

@@ -169,6 +169,7 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                 "trigger": {"daily_schedule": {"hour_utc": 2}},
             },
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
+            recommended_editors={"editors": {"foo": {"versions": ["string"]}}},
             technical_description="technicalDescription",
         )
         assert_matches_type(ProjectUpdateResponse, project, path=["response"])
@@ -466,6 +467,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                 "trigger": {"daily_schedule": {"hour_utc": 2}},
             },
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
+            recommended_editors={"editors": {"foo": {"versions": ["string"]}}},
             technical_description="technicalDescription",
         )
         assert_matches_type(ProjectUpdateResponse, project, path=["response"])