docs(api): update min_size parameter docs in prebuilds warm pool methods · gitpod-io/gitpod-sdk-python@ffe05fc · GitHub

gitpod-io / gitpod-sdk-python Public

• Notifications You must be signed in to change notification settings
• Fork 4
• Star 9

• Code
• Issues
• Pull requests 2
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit ffe05fc

Browse filesBrowse the repository at this point in the historyBrowse files

stainless-app[bot]

committed

docs(api): update min_size parameter docs in prebuilds warm pool methods

1 parent b390afb commit ffe05fc
Copy full SHA for ffe05fc

6 files changed

+20-13Lines changed: 20 additions & 13 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• .stats.yml
• src/gitpod
  • resources
    • prebuilds.py
  • types
    • prebuild_create_warm_pool_params.py
    • prebuild_update_warm_pool_params.py
    • warm_pool_spec.py
• tests/api_resources
  • test_prebuilds.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎.stats.yml‎

Copy file name to clipboard

+2-2Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
@@ -1,4 +1,4 @@
1	1	configured_endpoints: 193
2		- openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-46b2bdeb8322ab3291dc87f9ac5d2e899a8ea34f79b2c2b1beadc551a1700fcf.yml
3		- openapi_spec_hash: 1a1032b0d0f6ce441d13430b58abb3a0
	2	+ openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-dc7143aaf5c9250839a926b35309a54fab505e05d50ea7bc06adf2bcbcdbc889.yml
	3	+ openapi_spec_hash: b1b47e82090bf165700db79dd40533fe
4	4	config_hash: de54bcc58fea1260a6792f8fd013439b

Collapse file

‎src/gitpod/resources/prebuilds.py‎

Copy file name to clipboardExpand all lines: src/gitpod/resources/prebuilds.py

+8-4Lines changed: 8 additions & 4 deletions

Original file line number	Diff line number	Diff line change
@@ -466,7 +466,8 @@ def create_warm_pool(
466	466	never scale above this value. Must be >= min_size and <= 20.
467	467
468	468	min_size: min_size is the minimum number of warm instances to maintain. The pool will
469		- never scale below this value. Must be >= 1 and <= max_size.
	469	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	470	+ full scale-down.
470	471
471	472	extra_headers: Send extra headers
472	473
@@ -704,7 +705,8 @@ def update_warm_pool(
704	705	never scale above this value. Must be >= min_size and <= 20.
705	706
706	707	min_size: min_size updates the minimum number of warm instances to maintain. The pool will
707		- never scale below this value. Must be >= 1 and <= max_size.
	708	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	709	+ full scale-down.
708	710
709	711	extra_headers: Send extra headers
710	712
@@ -1155,7 +1157,8 @@ async def create_warm_pool(
1155	1157	never scale above this value. Must be >= min_size and <= 20.
1156	1158
1157	1159	min_size: min_size is the minimum number of warm instances to maintain. The pool will
1158		- never scale below this value. Must be >= 1 and <= max_size.
	1160	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	1161	+ full scale-down.
1159	1162
1160	1163	extra_headers: Send extra headers
1161	1164
@@ -1393,7 +1396,8 @@ async def update_warm_pool(
1393	1396	never scale above this value. Must be >= min_size and <= 20.
1394	1397
1395	1398	min_size: min_size updates the minimum number of warm instances to maintain. The pool will
1396		- never scale below this value. Must be >= 1 and <= max_size.
	1399	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	1400	+ full scale-down.
1397	1401
1398	1402	extra_headers: Send extra headers
1399	1403

Collapse file

‎src/gitpod/types/prebuild_create_warm_pool_params.py‎

Copy file name to clipboardExpand all lines: src/gitpod/types/prebuild_create_warm_pool_params.py

+2-1Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -38,5 +38,6 @@ class PrebuildCreateWarmPoolParams(TypedDict, total=False):
38	38	min_size: Annotated[Optional[int], PropertyInfo(alias="minSize")]
39	39	"""
40	40	min_size is the minimum number of warm instances to maintain. The pool will
41		- never scale below this value. Must be >= 1 and <= max_size.
	41	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	42	+ full scale-down.
42	43	"""

Collapse file

‎src/gitpod/types/prebuild_update_warm_pool_params.py‎

Copy file name to clipboardExpand all lines: src/gitpod/types/prebuild_update_warm_pool_params.py

+2-1Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -29,5 +29,6 @@ class PrebuildUpdateWarmPoolParams(TypedDict, total=False):
29	29	min_size: Annotated[Optional[int], PropertyInfo(alias="minSize")]
30	30	"""
31	31	min_size updates the minimum number of warm instances to maintain. The pool will
32		- never scale below this value. Must be >= 1 and <= max_size.
	32	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	33	+ full scale-down.
33	34	"""

Collapse file

‎src/gitpod/types/warm_pool_spec.py‎

Copy file name to clipboardExpand all lines: src/gitpod/types/warm_pool_spec.py

+2-1Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -35,7 +35,8 @@ class WarmPoolSpec(BaseModel):
35	35	min_size: Optional[int] = FieldInfo(alias="minSize", default=None)
36	36	"""
37	37	min_size is the minimum number of warm instances to maintain. The pool will
38		- never scale below this value. Must be >= 1 and <= max_size.
	38	+ never scale below this value. Must be >= 0 and <= max_size. Set to 0 to allow
	39	+ full scale-down.
39	40	"""
40	41
41	42	snapshot_id: Optional[str] = FieldInfo(alias="snapshotId", default=None)

Collapse file

‎tests/api_resources/test_prebuilds.py‎

Copy file name to clipboardExpand all lines: tests/api_resources/test_prebuilds.py

+4-4Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
@@ -280,7 +280,7 @@ def test_method_create_warm_pool_with_all_params(self, client: Gitpod) -> None:
280	280	project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
281	281	desired_size=2,
282	282	max_size=1,
283		- min_size=1,
	283	+ min_size=20,
284	284	)
285	285	assert_matches_type(PrebuildCreateWarmPoolResponse, prebuild, path=["response"])
286	286
@@ -440,7 +440,7 @@ def test_method_update_warm_pool_with_all_params(self, client: Gitpod) -> None:
440	440	warm_pool_id="a1b2c3d4-5678-9abc-def0-1234567890ab",
441	441	desired_size=5,
442	442	max_size=1,
443		- min_size=1,
	443	+ min_size=20,
444	444	)
445	445	assert_matches_type(PrebuildUpdateWarmPoolResponse, prebuild, path=["response"])
446	446
@@ -728,7 +728,7 @@ async def test_method_create_warm_pool_with_all_params(self, async_client: Async
728	728	project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
729	729	desired_size=2,
730	730	max_size=1,
731		- min_size=1,
	731	+ min_size=20,
732	732	)
733	733	assert_matches_type(PrebuildCreateWarmPoolResponse, prebuild, path=["response"])
734	734
@@ -888,7 +888,7 @@ async def test_method_update_warm_pool_with_all_params(self, async_client: Async
888	888	warm_pool_id="a1b2c3d4-5678-9abc-def0-1234567890ab",
889	889	desired_size=5,
890	890	max_size=1,
891		- min_size=1,
	891	+ min_size=20,
892	892	)
893	893	assert_matches_type(PrebuildUpdateWarmPoolResponse, prebuild, path=["response"])
894	894

0 commit comments

Comments

0 (0)