Skip to content

Commit c10fa2e

Browse files
chore(docs): add missing descriptions
1 parent a7a783a commit c10fa2e

File tree

4 files changed

+94
-0
lines changed

4 files changed

+94
-0
lines changed

src/gitpod/_client.py

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ def environments(self) -> EnvironmentsResource:
150150

151151
@cached_property
152152
def errors(self) -> ErrorsResource:
153+
"""
154+
ErrorsService provides endpoints for clients to report errors
155+
that will be sent to error reporting systems.
156+
"""
153157
from .resources.errors import ErrorsResource
154158

155159
return ErrorsResource(self)
@@ -186,6 +190,10 @@ def organizations(self) -> OrganizationsResource:
186190

187191
@cached_property
188192
def prebuilds(self) -> PrebuildsResource:
193+
"""
194+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
195+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
196+
"""
189197
from .resources.prebuilds import PrebuildsResource
190198

191199
return PrebuildsResource(self)
@@ -210,6 +218,9 @@ def secrets(self) -> SecretsResource:
210218

211219
@cached_property
212220
def usage(self) -> UsageResource:
221+
"""
222+
UsageService provides usage information about environments, users, and projects.
223+
"""
213224
from .resources.usage import UsageResource
214225

215226
return UsageResource(self)
@@ -414,6 +425,10 @@ def environments(self) -> AsyncEnvironmentsResource:
414425

415426
@cached_property
416427
def errors(self) -> AsyncErrorsResource:
428+
"""
429+
ErrorsService provides endpoints for clients to report errors
430+
that will be sent to error reporting systems.
431+
"""
417432
from .resources.errors import AsyncErrorsResource
418433

419434
return AsyncErrorsResource(self)
@@ -450,6 +465,10 @@ def organizations(self) -> AsyncOrganizationsResource:
450465

451466
@cached_property
452467
def prebuilds(self) -> AsyncPrebuildsResource:
468+
"""
469+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
470+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
471+
"""
453472
from .resources.prebuilds import AsyncPrebuildsResource
454473

455474
return AsyncPrebuildsResource(self)
@@ -474,6 +493,9 @@ def secrets(self) -> AsyncSecretsResource:
474493

475494
@cached_property
476495
def usage(self) -> AsyncUsageResource:
496+
"""
497+
UsageService provides usage information about environments, users, and projects.
498+
"""
477499
from .resources.usage import AsyncUsageResource
478500

479501
return AsyncUsageResource(self)
@@ -629,6 +651,10 @@ def environments(self) -> environments.EnvironmentsResourceWithRawResponse:
629651

630652
@cached_property
631653
def errors(self) -> errors.ErrorsResourceWithRawResponse:
654+
"""
655+
ErrorsService provides endpoints for clients to report errors
656+
that will be sent to error reporting systems.
657+
"""
632658
from .resources.errors import ErrorsResourceWithRawResponse
633659

634660
return ErrorsResourceWithRawResponse(self._client.errors)
@@ -665,6 +691,10 @@ def organizations(self) -> organizations.OrganizationsResourceWithRawResponse:
665691

666692
@cached_property
667693
def prebuilds(self) -> prebuilds.PrebuildsResourceWithRawResponse:
694+
"""
695+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
696+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
697+
"""
668698
from .resources.prebuilds import PrebuildsResourceWithRawResponse
669699

670700
return PrebuildsResourceWithRawResponse(self._client.prebuilds)
@@ -689,6 +719,9 @@ def secrets(self) -> secrets.SecretsResourceWithRawResponse:
689719

690720
@cached_property
691721
def usage(self) -> usage.UsageResourceWithRawResponse:
722+
"""
723+
UsageService provides usage information about environments, users, and projects.
724+
"""
692725
from .resources.usage import UsageResourceWithRawResponse
693726

694727
return UsageResourceWithRawResponse(self._client.usage)
@@ -732,6 +765,10 @@ def environments(self) -> environments.AsyncEnvironmentsResourceWithRawResponse:
732765

733766
@cached_property
734767
def errors(self) -> errors.AsyncErrorsResourceWithRawResponse:
768+
"""
769+
ErrorsService provides endpoints for clients to report errors
770+
that will be sent to error reporting systems.
771+
"""
735772
from .resources.errors import AsyncErrorsResourceWithRawResponse
736773

737774
return AsyncErrorsResourceWithRawResponse(self._client.errors)
@@ -768,6 +805,10 @@ def organizations(self) -> organizations.AsyncOrganizationsResourceWithRawRespon
768805

769806
@cached_property
770807
def prebuilds(self) -> prebuilds.AsyncPrebuildsResourceWithRawResponse:
808+
"""
809+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
810+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
811+
"""
771812
from .resources.prebuilds import AsyncPrebuildsResourceWithRawResponse
772813

773814
return AsyncPrebuildsResourceWithRawResponse(self._client.prebuilds)
@@ -792,6 +833,9 @@ def secrets(self) -> secrets.AsyncSecretsResourceWithRawResponse:
792833

793834
@cached_property
794835
def usage(self) -> usage.AsyncUsageResourceWithRawResponse:
836+
"""
837+
UsageService provides usage information about environments, users, and projects.
838+
"""
795839
from .resources.usage import AsyncUsageResourceWithRawResponse
796840

797841
return AsyncUsageResourceWithRawResponse(self._client.usage)
@@ -835,6 +879,10 @@ def environments(self) -> environments.EnvironmentsResourceWithStreamingResponse
835879

836880
@cached_property
837881
def errors(self) -> errors.ErrorsResourceWithStreamingResponse:
882+
"""
883+
ErrorsService provides endpoints for clients to report errors
884+
that will be sent to error reporting systems.
885+
"""
838886
from .resources.errors import ErrorsResourceWithStreamingResponse
839887

840888
return ErrorsResourceWithStreamingResponse(self._client.errors)
@@ -871,6 +919,10 @@ def organizations(self) -> organizations.OrganizationsResourceWithStreamingRespo
871919

872920
@cached_property
873921
def prebuilds(self) -> prebuilds.PrebuildsResourceWithStreamingResponse:
922+
"""
923+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
924+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
925+
"""
874926
from .resources.prebuilds import PrebuildsResourceWithStreamingResponse
875927

876928
return PrebuildsResourceWithStreamingResponse(self._client.prebuilds)
@@ -895,6 +947,9 @@ def secrets(self) -> secrets.SecretsResourceWithStreamingResponse:
895947

896948
@cached_property
897949
def usage(self) -> usage.UsageResourceWithStreamingResponse:
950+
"""
951+
UsageService provides usage information about environments, users, and projects.
952+
"""
898953
from .resources.usage import UsageResourceWithStreamingResponse
899954

900955
return UsageResourceWithStreamingResponse(self._client.usage)
@@ -938,6 +993,10 @@ def environments(self) -> environments.AsyncEnvironmentsResourceWithStreamingRes
938993

939994
@cached_property
940995
def errors(self) -> errors.AsyncErrorsResourceWithStreamingResponse:
996+
"""
997+
ErrorsService provides endpoints for clients to report errors
998+
that will be sent to error reporting systems.
999+
"""
9411000
from .resources.errors import AsyncErrorsResourceWithStreamingResponse
9421001

9431002
return AsyncErrorsResourceWithStreamingResponse(self._client.errors)
@@ -974,6 +1033,10 @@ def organizations(self) -> organizations.AsyncOrganizationsResourceWithStreaming
9741033

9751034
@cached_property
9761035
def prebuilds(self) -> prebuilds.AsyncPrebuildsResourceWithStreamingResponse:
1036+
"""
1037+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
1038+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
1039+
"""
9771040
from .resources.prebuilds import AsyncPrebuildsResourceWithStreamingResponse
9781041

9791042
return AsyncPrebuildsResourceWithStreamingResponse(self._client.prebuilds)
@@ -998,6 +1061,9 @@ def secrets(self) -> secrets.AsyncSecretsResourceWithStreamingResponse:
9981061

9991062
@cached_property
10001063
def usage(self) -> usage.AsyncUsageResourceWithStreamingResponse:
1064+
"""
1065+
UsageService provides usage information about environments, users, and projects.
1066+
"""
10011067
from .resources.usage import AsyncUsageResourceWithStreamingResponse
10021068

10031069
return AsyncUsageResourceWithStreamingResponse(self._client.usage)

src/gitpod/resources/errors.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@
2424

2525

2626
class ErrorsResource(SyncAPIResource):
27+
"""
28+
ErrorsService provides endpoints for clients to report errors
29+
that will be sent to error reporting systems.
30+
"""
31+
2732
@cached_property
2833
def with_raw_response(self) -> ErrorsResourceWithRawResponse:
2934
"""
@@ -94,6 +99,11 @@ def report_errors(
9499

95100

96101
class AsyncErrorsResource(AsyncAPIResource):
102+
"""
103+
ErrorsService provides endpoints for clients to report errors
104+
that will be sent to error reporting systems.
105+
"""
106+
97107
@cached_property
98108
def with_raw_response(self) -> AsyncErrorsResourceWithRawResponse:
99109
"""

src/gitpod/resources/prebuilds.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@
3737

3838

3939
class PrebuildsResource(SyncAPIResource):
40+
"""
41+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
42+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
43+
"""
44+
4045
@cached_property
4146
def with_raw_response(self) -> PrebuildsResourceWithRawResponse:
4247
"""
@@ -400,6 +405,11 @@ def create_logs_token(
400405

401406

402407
class AsyncPrebuildsResource(AsyncAPIResource):
408+
"""
409+
PrebuildService manages prebuilds for projects to enable faster environment startup times.
410+
Prebuilds create snapshots of environments that can be used to provision new environments quickly.
411+
"""
412+
403413
@cached_property
404414
def with_raw_response(self) -> AsyncPrebuildsResourceWithRawResponse:
405415
"""

src/gitpod/resources/usage.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323

2424

2525
class UsageResource(SyncAPIResource):
26+
"""
27+
UsageService provides usage information about environments, users, and projects.
28+
"""
29+
2630
@cached_property
2731
def with_raw_response(self) -> UsageResourceWithRawResponse:
2832
"""
@@ -123,6 +127,10 @@ def list_environment_runtime_records(
123127

124128

125129
class AsyncUsageResource(AsyncAPIResource):
130+
"""
131+
UsageService provides usage information about environments, users, and projects.
132+
"""
133+
126134
@cached_property
127135
def with_raw_response(self) -> AsyncUsageResourceWithRawResponse:
128136
"""

0 commit comments

Comments
 (0)