Skip to content

Commit 2e46996

Browse files
committed
feat(api): add OCI external-storage provider support
Castiron-Internal-PR: openai/openai-python-internal#237 Castiron-Source-SHA: 3f7192fdd149a176d1412b7dfe6febbeb273bb3f Castiron-Public-Base-SHA: b570279
1 parent b570279 commit 2e46996

9 files changed

Lines changed: 192 additions & 14 deletions

‎.castiron.stats.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
schema_version: 1
2-
generation_id: 77e7bf2e-2222-4fa1-afde-04e9a475a2d0
3-
openapi_spec_hash: 556e1d261e2ef761c7236598cffc6a4b
4-
openapi_transformed_spec_hash: a5c09efaaff7b8e04e0a0dd5f4087246
5-
config_hash: 9f2131d7bd073baa8cb2730facaadf5a
6-
codegen_sha: 34af930ff9f3c6966a29960bf00baa8902974344
7-
codegen_hash: f5920470692de4e2e2b6c2c7ddc1288b169a4d7493e1a2ee73bff14056d6d30c
8-
public_codegen_sha: 4b480e5caf1d0025445164c4be5dd2d863859bc7
2+
generation_id: c318dee1-e92a-4e04-9998-0ee35c0a25ef
3+
openapi_spec_hash: 134c119262ce50017727a300b0106882
4+
openapi_transformed_spec_hash: b5602cf76f35aea5b689f2439368863b
5+
config_hash: adfe6b936328bd198d9442c21c42383b
6+
codegen_sha: 31c1e56b53ee76699d430b69a7b64f1ee4fd6e86
7+
codegen_hash: 15181a0a3c25ad88c8574f8671807274f5fc0d5fd06b7f844944a0c617182ea3
8+
public_codegen_sha: 66bc7260d20b924da975399a929978381379b561

‎api.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1568,6 +1568,7 @@ from openai.types.admin.organization import (
15681568
ExternalStorageConfiguration,
15691569
ExternalStorageDeleted,
15701570
GcpExternalStorageProvider,
1571+
OciExternalStorageProvider,
15711572
)
15721573
```
15731574

‎api_reference/openapi.transformed.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36730,6 +36730,46 @@ webhooks:
3673036730
status codes will be retried.
3673136731
components:
3673236732
schemas:
36733+
OciExternalStorageProviderParams:
36734+
properties:
36735+
type:
36736+
type: string
36737+
enum:
36738+
- oci
36739+
default: oci
36740+
x-stainless-const: true
36741+
tenancy_ocid:
36742+
type: string
36743+
region:
36744+
type: string
36745+
bucket:
36746+
type: string
36747+
type: object
36748+
required:
36749+
- type
36750+
- tenancy_ocid
36751+
- region
36752+
- bucket
36753+
OciExternalStorageProviderResponse:
36754+
properties:
36755+
type:
36756+
type: string
36757+
enum:
36758+
- oci
36759+
default: oci
36760+
x-stainless-const: true
36761+
tenancy_ocid:
36762+
type: string
36763+
region:
36764+
type: string
36765+
bucket:
36766+
type: string
36767+
type: object
36768+
required:
36769+
- type
36770+
- tenancy_ocid
36771+
- region
36772+
- bucket
3673336773
SessionSpendControlParam:
3673436774
type: object
3673536775
properties:
@@ -77771,6 +77811,7 @@ components:
7777177811
- $ref: '#/components/schemas/AwsExternalStorageProviderResponse'
7777277812
- $ref: '#/components/schemas/AzureExternalStorageProviderResponse'
7777377813
- $ref: '#/components/schemas/GcpExternalStorageProviderResponse'
77814+
- $ref: '#/components/schemas/OciExternalStorageProviderResponse'
7777477815
PublicProjectResidency:
7777577816
type: string
7777677817
enum:
@@ -78416,6 +78457,7 @@ components:
7841678457
- $ref: '#/components/schemas/AwsExternalStorageProviderResponse'
7841778458
- $ref: '#/components/schemas/AzureExternalStorageProviderResponse'
7841878459
- $ref: '#/components/schemas/GcpExternalStorageProviderResponse'
78460+
- $ref: '#/components/schemas/OciExternalStorageProviderResponse'
7841978461
geography:
7842078462
type: string
7842178463
status:
@@ -78539,6 +78581,7 @@ components:
7853978581
- $ref: '#/components/schemas/AwsExternalStorageProviderParams'
7854078582
- $ref: '#/components/schemas/AzureExternalStorageProviderParams'
7854178583
- $ref: '#/components/schemas/GcpExternalStorageProviderParams'
78584+
- $ref: '#/components/schemas/OciExternalStorageProviderParams'
7854278585
type: object
7854378586
required:
7854478587
- project_id

‎src/openai/types/admin/organization/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
from .certificate_activate_response import CertificateActivateResponse as CertificateActivateResponse
7070
from .certificate_deactivate_params import CertificateDeactivateParams as CertificateDeactivateParams
7171
from .gcp_external_storage_provider import GcpExternalStorageProvider as GcpExternalStorageProvider
72+
from .oci_external_storage_provider import OciExternalStorageProvider as OciExternalStorageProvider
7273
from .usage_audio_speeches_response import UsageAudioSpeechesResponse as UsageAudioSpeechesResponse
7374
from .usage_web_search_calls_params import UsageWebSearchCallsParams as UsageWebSearchCallsParams
7475
from .external_storage_configuration import ExternalStorageConfiguration as ExternalStorageConfiguration

‎src/openai/types/admin/organization/audit_log_list_response.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from ...._models import BaseModel
1010
from .aws_external_storage_provider import AwsExternalStorageProvider
1111
from .gcp_external_storage_provider import GcpExternalStorageProvider
12+
from .oci_external_storage_provider import OciExternalStorageProvider
1213
from .azure_external_storage_provider import AzureExternalStorageProvider
1314

1415
__all__ = [
@@ -314,7 +315,9 @@ class ExternalKeyRemoved(BaseModel):
314315

315316

316317
ExternalStorageRegisteredDataProvider: TypeAlias = Annotated[
317-
Union[AwsExternalStorageProvider, AzureExternalStorageProvider, GcpExternalStorageProvider],
318+
Union[
319+
AwsExternalStorageProvider, AzureExternalStorageProvider, GcpExternalStorageProvider, OciExternalStorageProvider
320+
],
318321
PropertyInfo(discriminator="type"),
319322
]
320323

‎src/openai/types/admin/organization/external_storage_configuration.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,15 @@
77
from ...._models import BaseModel
88
from .aws_external_storage_provider import AwsExternalStorageProvider
99
from .gcp_external_storage_provider import GcpExternalStorageProvider
10+
from .oci_external_storage_provider import OciExternalStorageProvider
1011
from .azure_external_storage_provider import AzureExternalStorageProvider
1112

1213
__all__ = ["ExternalStorageConfiguration", "Provider"]
1314

1415
Provider: TypeAlias = Annotated[
15-
Union[AwsExternalStorageProvider, AzureExternalStorageProvider, GcpExternalStorageProvider],
16+
Union[
17+
AwsExternalStorageProvider, AzureExternalStorageProvider, GcpExternalStorageProvider, OciExternalStorageProvider
18+
],
1619
PropertyInfo(discriminator="type"),
1720
]
1821

‎src/openai/types/admin/organization/external_storage_create_params.py‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from typing import Union
66
from typing_extensions import Literal, Required, TypeAlias, TypedDict
77

8-
__all__ = ["ExternalStorageCreateParams", "Provider", "ProviderAws", "ProviderAzure", "ProviderGcp"]
8+
__all__ = ["ExternalStorageCreateParams", "Provider", "ProviderAws", "ProviderAzure", "ProviderGcp", "ProviderOci"]
99

1010

1111
class ExternalStorageCreateParams(TypedDict, total=False):
@@ -48,4 +48,14 @@ class ProviderGcp(TypedDict, total=False):
4848
workload_identity_provider_id: Required[str]
4949

5050

51-
Provider: TypeAlias = Union[ProviderAws, ProviderAzure, ProviderGcp]
51+
class ProviderOci(TypedDict, total=False):
52+
bucket: Required[str]
53+
54+
region: Required[str]
55+
56+
tenancy_ocid: Required[str]
57+
58+
type: Required[Literal["oci"]]
59+
60+
61+
Provider: TypeAlias = Union[ProviderAws, ProviderAzure, ProviderGcp, ProviderOci]
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
2+
3+
from typing_extensions import Literal
4+
5+
from ...._models import BaseModel
6+
7+
__all__ = ["OciExternalStorageProvider"]
8+
9+
10+
class OciExternalStorageProvider(BaseModel):
11+
bucket: str
12+
13+
region: str
14+
15+
tenancy_ocid: str
16+
17+
type: Literal["oci"]

‎tests/test_external_storage.py‎

Lines changed: 103 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@
99
from openai import OpenAI, AsyncOpenAI
1010
from tests.respx2 import MockRouter
1111
from tests.respx2.models import Call
12-
from openai.types.admin.organization import GcpExternalStorageProvider, ExternalStorageConfiguration
12+
from openai.types.admin.organization import (
13+
AuditLogListResponse,
14+
GcpExternalStorageProvider,
15+
OciExternalStorageProvider,
16+
ExternalStorageConfiguration,
17+
)
1318
from openai.types.admin.organization.external_storage_create_params import Provider
1419

1520
BASE_URL = "https://example.com/v1"
@@ -65,6 +70,21 @@
6570
"future_provider_field": {"retained": True},
6671
},
6772
),
73+
(
74+
{
75+
"type": "oci",
76+
"tenancy_ocid": "ocid1.tenancy.synthetic",
77+
"region": "us-ashburn-1",
78+
"bucket": "test-oci-bucket",
79+
},
80+
{
81+
"type": "oci",
82+
"tenancy_ocid": "ocid1.tenancy.synthetic",
83+
"region": "us-ashburn-1",
84+
"bucket": "test-oci-bucket",
85+
"future_provider_field": {"retained": True},
86+
},
87+
),
6888
]
6989

7090

@@ -82,7 +102,7 @@ def configuration(provider: dict[str, object], storage_id: str = "extstorage_tes
82102

83103

84104
@pytest.mark.respx2(base_url=BASE_URL)
85-
@pytest.mark.parametrize("provider,response_provider", PROVIDERS, ids=["aws", "azure", "gcp"])
105+
@pytest.mark.parametrize("provider,response_provider", PROVIDERS, ids=["aws", "azure", "gcp", "oci"])
86106
def test_sync_external_storage_provider_and_admin_auth(
87107
provider: Provider, response_provider: dict[str, object], respx2_mock: MockRouter
88108
) -> None:
@@ -99,14 +119,19 @@ def test_sync_external_storage_provider_and_admin_auth(
99119
assert isinstance(result, ExternalStorageConfiguration)
100120
if provider["type"] == "gcp":
101121
assert isinstance(result.provider, GcpExternalStorageProvider)
122+
elif provider["type"] == "oci":
123+
assert isinstance(result.provider, OciExternalStorageProvider)
124+
assert result.provider.tenancy_ocid == provider["tenancy_ocid"]
125+
assert result.provider.region == provider["region"]
126+
assert result.provider.bucket == provider["bucket"]
102127
assert result.to_dict() == payload
103128
request = route.calls.last.request
104129
assert request.headers["Authorization"] == "Bearer test-admin-key"
105130
assert json.loads(request.content) == {"project_id": "proj_test", "provider": provider}
106131

107132

108133
@pytest.mark.respx2(base_url=BASE_URL)
109-
@pytest.mark.parametrize("provider,response_provider", PROVIDERS, ids=["aws", "azure", "gcp"])
134+
@pytest.mark.parametrize("provider,response_provider", PROVIDERS, ids=["aws", "azure", "gcp", "oci"])
110135
async def test_async_external_storage_provider_and_admin_auth(
111136
provider: Provider, response_provider: dict[str, object], respx2_mock: MockRouter
112137
) -> None:
@@ -123,6 +148,11 @@ async def test_async_external_storage_provider_and_admin_auth(
123148
assert isinstance(result, ExternalStorageConfiguration)
124149
if provider["type"] == "gcp":
125150
assert isinstance(result.provider, GcpExternalStorageProvider)
151+
elif provider["type"] == "oci":
152+
assert isinstance(result.provider, OciExternalStorageProvider)
153+
assert result.provider.tenancy_ocid == provider["tenancy_ocid"]
154+
assert result.provider.region == provider["region"]
155+
assert result.provider.bucket == provider["bucket"]
126156
assert result.to_dict() == payload
127157
request = route.calls.last.request
128158
assert request.headers["Authorization"] == "Bearer test-admin-key"
@@ -201,3 +231,73 @@ async def test_async_external_storage_never_falls_back_to_project_key(
201231
with pytest.raises(TypeError, match="Could not resolve authentication method"):
202232
await client.admin.organization.external_storage.retrieve("extstorage_test")
203233
assert len(respx2_mock.calls) == 0
234+
235+
236+
def mock_oci_audit_log(respx2_mock: MockRouter) -> tuple[dict[str, object], dict[str, object]]:
237+
provider: dict[str, object] = {
238+
"type": "oci",
239+
"tenancy_ocid": "ocid1.tenancy.synthetic",
240+
"region": "us-ashburn-1",
241+
"bucket": "test-oci-bucket",
242+
"future_provider_field": {"retained": True},
243+
}
244+
event: dict[str, object] = {
245+
"id": "audit_test",
246+
"effective_at": 123,
247+
"type": "external_storage.registered",
248+
"external_storage.registered": {"id": "extstorage_test", "data": {"provider": provider}},
249+
"future_audit_field": {"retained": True},
250+
}
251+
respx2_mock.get("/organization/audit_logs").mock(
252+
return_value=httpx2.Response(
253+
200,
254+
json={
255+
"object": "list",
256+
"data": [event],
257+
"first_id": "audit_test",
258+
"last_id": "audit_test",
259+
"has_more": False,
260+
},
261+
)
262+
)
263+
return event, provider
264+
265+
266+
def assert_oci_audit_log(result: AuditLogListResponse, event: dict[str, object], provider: dict[str, object]) -> None:
267+
assert result.external_storage_registered is not None
268+
assert result.external_storage_registered.data is not None
269+
parsed = result.external_storage_registered.data.provider
270+
assert isinstance(parsed, OciExternalStorageProvider)
271+
assert parsed.type == "oci"
272+
assert parsed.tenancy_ocid == provider["tenancy_ocid"]
273+
assert parsed.region == provider["region"]
274+
assert parsed.bucket == provider["bucket"]
275+
assert result.to_dict() == event
276+
277+
278+
@pytest.mark.respx2(base_url=BASE_URL)
279+
def test_sync_oci_audit_log_uses_shared_provider(respx2_mock: MockRouter) -> None:
280+
event, provider = mock_oci_audit_log(respx2_mock)
281+
with OpenAI(
282+
base_url=BASE_URL,
283+
api_key="test-project-key",
284+
admin_api_key="test-admin-key",
285+
_strict_response_validation=True,
286+
) as client:
287+
result = client.admin.organization.audit_logs.list().data[0]
288+
assert_oci_audit_log(result, event, provider)
289+
assert respx2_mock.calls.last.request.headers["Authorization"] == "Bearer test-admin-key"
290+
291+
292+
@pytest.mark.respx2(base_url=BASE_URL)
293+
async def test_async_oci_audit_log_uses_shared_provider(respx2_mock: MockRouter) -> None:
294+
event, provider = mock_oci_audit_log(respx2_mock)
295+
async with AsyncOpenAI(
296+
base_url=BASE_URL,
297+
api_key="test-project-key",
298+
admin_api_key="test-admin-key",
299+
_strict_response_validation=True,
300+
) as client:
301+
result = (await client.admin.organization.audit_logs.list()).data[0]
302+
assert_oci_audit_log(result, event, provider)
303+
assert respx2_mock.calls.last.request.headers["Authorization"] == "Bearer test-admin-key"

0 commit comments

Comments
 (0)