Skip to content

Commit 2154cd8

Browse files
docs(api): clarify port_sharing_disabled behavior in organization policy
1 parent fb0560e commit 2154cd8

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 172
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-bb4e6859a80947948a22daab52f6d72617c89201cc0d06f94e4fedfc95eb6dbd.yml
3-
openapi_spec_hash: 76e9882895783cabd4c25a84c4c18ed0
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-4e76b45ac7aedb89d725b01fea9f009672c3f3b0117393178e034718095339a3.yml
3+
openapi_spec_hash: 11437695b49cfe5d28bef5d4ee65d696
44
config_hash: 401f8a117c48e880889ed27a8403db29

src/gitpod/resources/organizations/policies.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,9 @@ def update(
204204
members_require_projects: members_require_projects controls whether environments can only be created from
205205
projects by non-admin users
206206
207-
port_sharing_disabled: port_sharing_disabled controls whether port sharing is disabled in the
208-
organization
207+
port_sharing_disabled: port_sharing_disabled controls whether user-initiated port sharing is disabled
208+
in the organization. System ports (VS Code Browser, agents) are always exempt
209+
from this policy.
209210
210211
require_custom_domain_access: require_custom_domain_access controls whether users must access via custom
211212
domain when one is configured. When true, access via app.gitpod.io is blocked.
@@ -439,8 +440,9 @@ async def update(
439440
members_require_projects: members_require_projects controls whether environments can only be created from
440441
projects by non-admin users
441442
442-
port_sharing_disabled: port_sharing_disabled controls whether port sharing is disabled in the
443-
organization
443+
port_sharing_disabled: port_sharing_disabled controls whether user-initiated port sharing is disabled
444+
in the organization. System ports (VS Code Browser, agents) are always exempt
445+
from this policy.
444446
445447
require_custom_domain_access: require_custom_domain_access controls whether users must access via custom
446448
domain when one is configured. When true, access via app.gitpod.io is blocked.

src/gitpod/types/organizations/organization_policies.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,9 @@ class OrganizationPolicies(BaseModel):
7878

7979
port_sharing_disabled: bool = FieldInfo(alias="portSharingDisabled")
8080
"""
81-
port_sharing_disabled controls whether port sharing is disabled in the
82-
organization
81+
port_sharing_disabled controls whether user-initiated port sharing is disabled
82+
in the organization. System ports (VS Code Browser, agents) are always exempt
83+
from this policy.
8384
"""
8485

8586
require_custom_domain_access: bool = FieldInfo(alias="requireCustomDomainAccess")

src/gitpod/types/organizations/policy_update_params.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,9 @@ class PolicyUpdateParams(TypedDict, total=False):
109109

110110
port_sharing_disabled: Annotated[Optional[bool], PropertyInfo(alias="portSharingDisabled")]
111111
"""
112-
port_sharing_disabled controls whether port sharing is disabled in the
113-
organization
112+
port_sharing_disabled controls whether user-initiated port sharing is disabled
113+
in the organization. System ports (VS Code Browser, agents) are always exempt
114+
from this policy.
114115
"""
115116

116117
require_custom_domain_access: Annotated[Optional[bool], PropertyInfo(alias="requireCustomDomainAccess")]

0 commit comments

Comments
 (0)