Skip to content

Commit b256c61

Browse files
chore(api): Improve type names for jig volumes and logs
1 parent 76a3c1a commit b256c61

File tree

13 files changed

+66
-213
lines changed

13 files changed

+66
-213
lines changed

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 71
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-cea384db9edf6057ebc5c198a155955b97771430e7afe3be910842c734bb9812.yml
33
openapi_spec_hash: 9c2c575baec9b59add4b2e91c14089ad
4-
config_hash: 9cbcab9760fa418ba5f417e113027027
4+
config_hash: 48eaad2cfc1d603d172f177ab7e6ecfa

api.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Types:
66

77
```python
8-
from together.types.beta import Deployment, JigListResponse, JigRetrieveLogsResponse
8+
from together.types.beta import Deployment, DeploymentLogs, JigListResponse
99
```
1010

1111
Methods:
@@ -15,26 +15,21 @@ Methods:
1515
- <code title="get /deployments">client.beta.jig.<a href="./src/together/resources/beta/jig/jig.py">list</a>() -> <a href="./src/together/types/beta/jig_list_response.py">JigListResponse</a></code>
1616
- <code title="post /deployments">client.beta.jig.<a href="./src/together/resources/beta/jig/jig.py">deploy</a>(\*\*<a href="src/together/types/beta/jig_deploy_params.py">params</a>) -> <a href="./src/together/types/beta/deployment.py">Deployment</a></code>
1717
- <code title="delete /deployments/{id}">client.beta.jig.<a href="./src/together/resources/beta/jig/jig.py">destroy</a>(id) -> object</code>
18-
- <code title="get /deployments/{id}/logs">client.beta.jig.<a href="./src/together/resources/beta/jig/jig.py">retrieve_logs</a>(id, \*\*<a href="src/together/types/beta/jig_retrieve_logs_params.py">params</a>) -> <a href="./src/together/types/beta/jig_retrieve_logs_response.py">JigRetrieveLogsResponse</a></code>
18+
- <code title="get /deployments/{id}/logs">client.beta.jig.<a href="./src/together/resources/beta/jig/jig.py">retrieve_logs</a>(id, \*\*<a href="src/together/types/beta/jig_retrieve_logs_params.py">params</a>) -> <a href="./src/together/types/beta/deployment_logs.py">DeploymentLogs</a></code>
1919

2020
### Volumes
2121

2222
Types:
2323

2424
```python
25-
from together.types.beta.jig import (
26-
VolumeCreateResponse,
27-
VolumeRetrieveResponse,
28-
VolumeUpdateResponse,
29-
VolumeListResponse,
30-
)
25+
from together.types.beta.jig import Volume, VolumeListResponse
3126
```
3227

3328
Methods:
3429

35-
- <code title="post /storage/volumes">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">create</a>(\*\*<a href="src/together/types/beta/jig/volume_create_params.py">params</a>) -> <a href="./src/together/types/beta/jig/volume_create_response.py">VolumeCreateResponse</a></code>
36-
- <code title="get /storage/volumes/{id}">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">retrieve</a>(id) -> <a href="./src/together/types/beta/jig/volume_retrieve_response.py">VolumeRetrieveResponse</a></code>
37-
- <code title="patch /storage/volumes/{id}">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">update</a>(id, \*\*<a href="src/together/types/beta/jig/volume_update_params.py">params</a>) -> <a href="./src/together/types/beta/jig/volume_update_response.py">VolumeUpdateResponse</a></code>
30+
- <code title="post /storage/volumes">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">create</a>(\*\*<a href="src/together/types/beta/jig/volume_create_params.py">params</a>) -> <a href="./src/together/types/beta/jig/volume.py">Volume</a></code>
31+
- <code title="get /storage/volumes/{id}">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">retrieve</a>(id) -> <a href="./src/together/types/beta/jig/volume.py">Volume</a></code>
32+
- <code title="patch /storage/volumes/{id}">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">update</a>(id, \*\*<a href="src/together/types/beta/jig/volume_update_params.py">params</a>) -> <a href="./src/together/types/beta/jig/volume.py">Volume</a></code>
3833
- <code title="get /storage/volumes">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">list</a>() -> <a href="./src/together/types/beta/jig/volume_list_response.py">VolumeListResponse</a></code>
3934
- <code title="delete /storage/volumes/{id}">client.beta.jig.volumes.<a href="./src/together/resources/beta/jig/volumes.py">delete</a>(id) -> object</code>
4035

src/together/resources/beta/jig/jig.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636
from ....types.beta import jig_deploy_params, jig_update_params, jig_retrieve_logs_params
3737
from ...._base_client import make_request_options
3838
from ....types.beta.deployment import Deployment
39+
from ....types.beta.deployment_logs import DeploymentLogs
3940
from ....types.beta.jig_list_response import JigListResponse
40-
from ....types.beta.jig_retrieve_logs_response import JigRetrieveLogsResponse
4141

4242
__all__ = ["JigResource", "AsyncJigResource"]
4343

@@ -413,7 +413,7 @@ def retrieve_logs(
413413
extra_query: Query | None = None,
414414
extra_body: Body | None = None,
415415
timeout: float | httpx.Timeout | None | NotGiven = not_given,
416-
) -> JigRetrieveLogsResponse:
416+
) -> DeploymentLogs:
417417
"""Retrieve logs from a deployment, optionally filtered by replica ID.
418418
419419
Use
@@ -449,7 +449,7 @@ def retrieve_logs(
449449
jig_retrieve_logs_params.JigRetrieveLogsParams,
450450
),
451451
),
452-
cast_to=JigRetrieveLogsResponse,
452+
cast_to=DeploymentLogs,
453453
)
454454

455455

@@ -824,7 +824,7 @@ async def retrieve_logs(
824824
extra_query: Query | None = None,
825825
extra_body: Body | None = None,
826826
timeout: float | httpx.Timeout | None | NotGiven = not_given,
827-
) -> JigRetrieveLogsResponse:
827+
) -> DeploymentLogs:
828828
"""Retrieve logs from a deployment, optionally filtered by replica ID.
829829
830830
Use
@@ -860,7 +860,7 @@ async def retrieve_logs(
860860
jig_retrieve_logs_params.JigRetrieveLogsParams,
861861
),
862862
),
863-
cast_to=JigRetrieveLogsResponse,
863+
cast_to=DeploymentLogs,
864864
)
865865

866866

src/together/resources/beta/jig/volumes.py

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@
1818
)
1919
from ...._base_client import make_request_options
2020
from ....types.beta.jig import volume_create_params, volume_update_params
21+
from ....types.beta.jig.volume import Volume
2122
from ....types.beta.jig.volume_list_response import VolumeListResponse
22-
from ....types.beta.jig.volume_create_response import VolumeCreateResponse
23-
from ....types.beta.jig.volume_update_response import VolumeUpdateResponse
24-
from ....types.beta.jig.volume_retrieve_response import VolumeRetrieveResponse
2523

2624
__all__ = ["VolumesResource", "AsyncVolumesResource"]
2725

@@ -58,7 +56,7 @@ def create(
5856
extra_query: Query | None = None,
5957
extra_body: Body | None = None,
6058
timeout: float | httpx.Timeout | None | NotGiven = not_given,
61-
) -> VolumeCreateResponse:
59+
) -> Volume:
6260
"""
6361
Create a new volume to preload files in deployments
6462
@@ -90,7 +88,7 @@ def create(
9088
options=make_request_options(
9189
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
9290
),
93-
cast_to=VolumeCreateResponse,
91+
cast_to=Volume,
9492
)
9593

9694
def retrieve(
@@ -103,7 +101,7 @@ def retrieve(
103101
extra_query: Query | None = None,
104102
extra_body: Body | None = None,
105103
timeout: float | httpx.Timeout | None | NotGiven = not_given,
106-
) -> VolumeRetrieveResponse:
104+
) -> Volume:
107105
"""
108106
Retrieve details of a specific volume by its ID or name
109107
@@ -123,7 +121,7 @@ def retrieve(
123121
options=make_request_options(
124122
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
125123
),
126-
cast_to=VolumeRetrieveResponse,
124+
cast_to=Volume,
127125
)
128126

129127
def update(
@@ -139,7 +137,7 @@ def update(
139137
extra_query: Query | None = None,
140138
extra_body: Body | None = None,
141139
timeout: float | httpx.Timeout | None | NotGiven = not_given,
142-
) -> VolumeUpdateResponse:
140+
) -> Volume:
143141
"""
144142
Update an existing volume's configuration or contents
145143
@@ -173,7 +171,7 @@ def update(
173171
options=make_request_options(
174172
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
175173
),
176-
cast_to=VolumeUpdateResponse,
174+
cast_to=Volume,
177175
)
178176

179177
def list(
@@ -261,7 +259,7 @@ async def create(
261259
extra_query: Query | None = None,
262260
extra_body: Body | None = None,
263261
timeout: float | httpx.Timeout | None | NotGiven = not_given,
264-
) -> VolumeCreateResponse:
262+
) -> Volume:
265263
"""
266264
Create a new volume to preload files in deployments
267265
@@ -293,7 +291,7 @@ async def create(
293291
options=make_request_options(
294292
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
295293
),
296-
cast_to=VolumeCreateResponse,
294+
cast_to=Volume,
297295
)
298296

299297
async def retrieve(
@@ -306,7 +304,7 @@ async def retrieve(
306304
extra_query: Query | None = None,
307305
extra_body: Body | None = None,
308306
timeout: float | httpx.Timeout | None | NotGiven = not_given,
309-
) -> VolumeRetrieveResponse:
307+
) -> Volume:
310308
"""
311309
Retrieve details of a specific volume by its ID or name
312310
@@ -326,7 +324,7 @@ async def retrieve(
326324
options=make_request_options(
327325
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
328326
),
329-
cast_to=VolumeRetrieveResponse,
327+
cast_to=Volume,
330328
)
331329

332330
async def update(
@@ -342,7 +340,7 @@ async def update(
342340
extra_query: Query | None = None,
343341
extra_body: Body | None = None,
344342
timeout: float | httpx.Timeout | None | NotGiven = not_given,
345-
) -> VolumeUpdateResponse:
343+
) -> Volume:
346344
"""
347345
Update an existing volume's configuration or contents
348346
@@ -376,7 +374,7 @@ async def update(
376374
options=make_request_options(
377375
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
378376
),
379-
cast_to=VolumeUpdateResponse,
377+
cast_to=Volume,
380378
)
381379

382380
async def list(

src/together/types/beta/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
from .cluster import Cluster as Cluster
66
from .deployment import Deployment as Deployment
7+
from .deployment_logs import DeploymentLogs as DeploymentLogs
78
from .jig_deploy_params import JigDeployParams as JigDeployParams
89
from .jig_list_response import JigListResponse as JigListResponse
910
from .jig_update_params import JigUpdateParams as JigUpdateParams
@@ -12,5 +13,4 @@
1213
from .cluster_update_params import ClusterUpdateParams as ClusterUpdateParams
1314
from .cluster_delete_response import ClusterDeleteResponse as ClusterDeleteResponse
1415
from .jig_retrieve_logs_params import JigRetrieveLogsParams as JigRetrieveLogsParams
15-
from .jig_retrieve_logs_response import JigRetrieveLogsResponse as JigRetrieveLogsResponse
1616
from .cluster_list_regions_response import ClusterListRegionsResponse as ClusterListRegionsResponse

src/together/types/beta/jig_retrieve_logs_response.py renamed to src/together/types/beta/deployment_logs.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
from ..._models import BaseModel
66

7-
__all__ = ["JigRetrieveLogsResponse"]
7+
__all__ = ["DeploymentLogs"]
88

99

10-
class JigRetrieveLogsResponse(BaseModel):
10+
class DeploymentLogs(BaseModel):
1111
lines: Optional[List[str]] = None

src/together/types/beta/jig/__init__.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,10 @@
33
from __future__ import annotations
44

55
from .secret import Secret as Secret
6+
from .volume import Volume as Volume
67
from .secret_create_params import SecretCreateParams as SecretCreateParams
78
from .secret_list_response import SecretListResponse as SecretListResponse
89
from .secret_update_params import SecretUpdateParams as SecretUpdateParams
910
from .volume_create_params import VolumeCreateParams as VolumeCreateParams
1011
from .volume_list_response import VolumeListResponse as VolumeListResponse
1112
from .volume_update_params import VolumeUpdateParams as VolumeUpdateParams
12-
from .volume_create_response import VolumeCreateResponse as VolumeCreateResponse
13-
from .volume_update_response import VolumeUpdateResponse as VolumeUpdateResponse
14-
from .volume_retrieve_response import VolumeRetrieveResponse as VolumeRetrieveResponse

src/together/types/beta/jig/volume_create_response.py renamed to src/together/types/beta/jig/volume.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
from ...._models import BaseModel
77

8-
__all__ = ["VolumeCreateResponse", "Content"]
8+
__all__ = ["Volume", "Content"]
99

1010

1111
class Content(BaseModel):
@@ -24,7 +24,7 @@ class Content(BaseModel):
2424
"""
2525

2626

27-
class VolumeCreateResponse(BaseModel):
27+
class Volume(BaseModel):
2828
id: Optional[str] = None
2929
"""ID is the unique identifier for this volume"""
3030

src/together/types/beta/jig/volume_list_response.py

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,15 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
from typing import List, Optional
4-
from typing_extensions import Literal
54

5+
from .volume import Volume
66
from ...._models import BaseModel
77

8-
__all__ = ["VolumeListResponse", "Data", "DataContent"]
9-
10-
11-
class DataContent(BaseModel):
12-
"""Content specifies the content that will be preloaded to this volume"""
13-
14-
source_prefix: Optional[str] = None
15-
"""
16-
SourcePrefix is the file path prefix for the content to be preloaded into the
17-
volume
18-
"""
19-
20-
type: Optional[Literal["files"]] = None
21-
"""
22-
Type is the content type (currently only "files" is supported which allows
23-
preloading files uploaded via Files API into the volume)
24-
"""
25-
26-
27-
class Data(BaseModel):
28-
id: Optional[str] = None
29-
"""ID is the unique identifier for this volume"""
30-
31-
content: Optional[DataContent] = None
32-
"""Content specifies the content that will be preloaded to this volume"""
33-
34-
created_at: Optional[str] = None
35-
"""CreatedAt is the ISO8601 timestamp when this volume was created"""
36-
37-
name: Optional[str] = None
38-
"""Name is the name of the volume"""
39-
40-
object: Optional[str] = None
41-
"""Object is the type identifier for this response (always "volume")"""
42-
43-
type: Optional[Literal["readOnly"]] = None
44-
"""Type is the volume type (e.g., "readOnly")"""
45-
46-
updated_at: Optional[str] = None
47-
"""UpdatedAt is the ISO8601 timestamp when this volume was last updated"""
8+
__all__ = ["VolumeListResponse"]
489

4910

5011
class VolumeListResponse(BaseModel):
51-
data: Optional[List[Data]] = None
12+
data: Optional[List[Volume]] = None
5213
"""Data is the array of volume items"""
5314

5415
object: Optional[str] = None

src/together/types/beta/jig/volume_retrieve_response.py

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)