feat(api): Updated python-sdk to adopt Code Engine API specification changes

Author: codeengine-ui-team

Makefile

@@ -27,7 +27,7 @@ test-unit:
 
 test-int:
 	./test/integration/prepare-integration-tests.sh
-	python3 -m pytest --ignore test/integration/test_code_engine_v2.py test/integration
+	python3 -m pytest -v --ignore test/integration/test_code_engine_v2.py test/integration
 
 test-examples:
 	python3 -m pytest example

README.md

@@ -1,7 +1,7 @@
 <!-- 
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 -->
-# Python SDK for IBM Cloud Code Engine 4.22.0
+# Python SDK for IBM Cloud Code Engine 5.0.0
 
 Python client library to interact with the [IBM Cloud Code Engine API](https://cloud.ibm.com/apidocs/codeengine).
 
@@ -21,6 +21,7 @@ Python client library to interact with the [IBM Cloud Code Engine API](https://c
 
 - [Overview](#overview)
 - [Prerequisites](#prerequisites)
+- [Breaking Changes (March 2026)](#breaking-changes-march-2026)
 - [Installation](#installation)
 - [Using the SDK](#using-the-sdk)
 - [Questions](#questions)
@@ -38,8 +39,8 @@ IBM Cloud services:
 
 Service Name | Imported Class Name
 --- | ---
-[IBM Cloud Code Engine V2](https://cloud.ibm.com/apidocs/codeengine/codeengine-v4.22.0) | CodeEngineV2
-[IBM Cloud Code Engine V1](https://cloud.ibm.com/apidocs/codeengine/codeengine-v4.22.0) | IbmCloudCodeEngineV1
+[IBM Cloud Code Engine V2](https://cloud.ibm.com/apidocs/codeengine/codeengine-v5.0.0) | CodeEngineV2
+[IBM Cloud Code Engine V1](https://cloud.ibm.com/apidocs/codeengine/codeengine-v5.0.0) | IbmCloudCodeEngineV1
 
 ## Prerequisites
 
@@ -49,18 +50,204 @@ Service Name | Imported Class Name
 * An IAM API key to allow the SDK to access your account. Create one [here](https://cloud.ibm.com/iam/apikeys).
 * Python 3.9 or above.
 
+## Breaking Changes (March 2026)
+
+- **Service method renames (pluralization)**
+    Update list methods and their `operation_id`s accordingly:
+
+    ```python
+    # before
+    ce.list_allowed_outbound_destination(project_id, limit=100, start=token)
+
+    # after
+    ce.list_allowed_outbound_destinations(project_id, limit=100, start=token)
+    ```
+
+    ```python
+    # before
+    ce.list_persistent_data_store(project_id, limit=100, start=token)
+
+    # after
+    ce.list_persistent_data_stores(project_id, limit=100, start=token)
+    ```
+
+- **Pager class renames**
+    Use the new pluralized pager classes and doc tag strings:
+
+    ```python
+    # before
+    pager = ibm_code_engine_sdk.code_engine_v2.AllowedOutboundDestinationPager(ce, project_id, limit=100)
+
+    # after
+    pager = ibm_code_engine_sdk.code_engine_v2.AllowedOutboundDestinationsPager(ce, project_id, limit=100)
+    ```
+
+    ```python
+    # before
+    pager = ibm_code_engine_sdk.code_engine_v2.PersistentDataStorePager(ce, project_id, limit=100)
+
+    # after
+    pager = ibm_code_engine_sdk.code_engine_v2.PersistentDataStoresPager(ce, project_id, limit=100)
+    ```
+
+- **Allowed outbound destinations: new type & fields; constructor shape changes**
+  - New type supported: `"private_path_service_gateway"` (in addition to `"cidr_block"`). Update any branching/validation on `type`.
+  - New optional fields on `AllowedOutboundDestination` and subclasses:
+    - `name`, `status`, `status_details`
+    - Private Path specific: `private_path_service_gateway_crn`, `isolation_policy`
+  - Base classes `AllowedOutboundDestination`, `AllowedOutboundDestinationPatch`, `AllowedOutboundDestinationPrototype`, `AllowedOutboundStatusDetails` are now **abstract** with expanded subclass sets. Instantiate the specific subclass instead, as before, but note the extended list.
+
+- **Creation prototypes changed**
+  - `AllowedOutboundDestinationPrototype` now **requires** `name`.
+  - **CIDR prototype constructor order changed**:
+
+      ```python
+      from ibm_code_engine_sdk.code_engine_v2 import AllowedOutboundDestinationPrototypeCidrBlockDataPrototype
+      # before: (type, cidr_block, name)
+      # after:  (type, name, cidr_block)
+      cidr_proto = AllowedOutboundDestinationPrototypeCidrBlockDataPrototype(
+          type="cidr_block",
+          name="allow-egress",
+          cidr_block="10.0.0.0/24",
+      )
+      ```
+  - **New prototype for Private Path service**:
+
+      ```python
+      from ibm_code_engine_sdk.code_engine_v2 import (
+          AllowedOutboundDestinationPrototypePrivatePathServiceGatewayDataPrototype as PPSGProto
+      )
+      ppsg_proto = PPSGProto(
+          type="private_path_service_gateway",
+          name="pps-to-service-x",
+          private_path_service_gateway_crn="<pps_gateway_crn>",
+          isolation_policy="shared",  # optional: "shared" | "dedicated"
+      )
+      ```
+
+- **Patch models changed (do not send `type`)**
+  - Remove `type` from CIDR patch payloads; field and serialization removed:
+
+    ```python
+    from ibm_code_engine_sdk.code_engine_v2 import AllowedOutboundDestinationPatchCidrBlockDataPatch
+
+    patch = AllowedOutboundDestinationPatchCidrBlockDataPatch(cidr_block="10.0.1.0/24")
+    ```
+
+  - New patch model for Private Path destinations:
+
+    ```python
+    from ibm_code_engine_sdk.code_engine_v2 import AllowedOutboundDestinationPatchPrivatePathServiceGatewayDataPatch
+
+    pp_patch = AllowedOutboundDestinationPatchPrivatePathServiceGatewayDataPatch(
+        isolation_policy="dedicated"  # "shared" | "dedicated"
+    )
+    ```
+
+- **Probe model: `type` is now required**
+  When constructing `Probe`, set the protocol explicitly:
+
+  ```python
+  from ibm_code_engine_sdk.code_engine_v2 import Probe
+
+  # before (omitted `type`)
+  # after (required)
+  probe = Probe(
+      type="http",  # "http" or "tcp"
+      initial_delay=5,
+      timeout=2,
+  )
+  ```
+
+- **Secret model: `format` is now required**
+  If you build `Secret` instances (e.g., in replace flows), you must set `format`:
+
+  ```python
+  from ibm_code_engine_sdk.code_engine_v2 import Secret
+
+  secret = Secret(
+      entity_tag=etag,
+      format="generic",  # set the appropriate format value
+      name="my-secret",
+      data={"key": "value"},
+  )
+  ```
+
+- **Previously-optional fields are now required in several response models (affects re-use of response as request)**
+  These fields are validated as required in model deserialization; if you reuse response objects to send updates, you must provide them:
+
+  - `App`: `computed_env_variables`, `run_service_account`, `run_volume_mounts`
+  - `AppRevision`: `computed_env_variables`, `run_service_account`, `run_volume_mounts`
+  - `Build`: `run_build_params`
+  - `BuildRun`: `run_build_params`, `service_account`, `source_type`, `strategy_size`, `strategy_type`
+  - `Function`: `computed_env_variables`
+  - `FunctionRuntimeList`: `function_runtimes`
+  - `Job`: `computed_env_variables`, `run_service_account`, `run_volume_mounts`
+  - `JobRun`: `computed_env_variables`
+
+  **Example (BuildRun)**
+
+  ```python
+  from ibm_code_engine_sdk.code_engine_v2 import BuildRun, BuildParam
+
+  build_run = BuildRun(
+      build_name="my-build",
+      name="run-1",
+      run_build_params=[BuildParam(name="ARG1", value="v")],
+      service_account="default",
+      source_type="git",
+      strategy_size="small",
+      strategy_type="buildpacks",
+      source_url="https://github.com/org/repo",
+  )
+  ```
+
+- **Allowed outbound destination CIDR model loosened & enriched**
+  - `entity_tag` and `name` are no longer required at construction time; they may be absent in incoming JSON.
+  - New status fields added (`status`, `status_details`). Update your parsing/logic if you inspect readiness.
+
+- **New status details and helper models (if you consume detailed status)**
+  - `AllowedOutboundStatusDetails` base plus:
+    - `AllowedOutboundStatusDetailsPrivatePathServiceGatewayStatusDetails`
+  - Helper models:
+    - `EndpointGatewayDetails`
+    - `PrivatePathServiceGatewayDetails`
+      If you serialize/deserialize status detail trees, include these types.
+
+- **Volume mount doc clarifications (no code changes)**
+  - `read_only` description now explicitly applies to mounts of type `'persistent_data_store'`.
+  - Name generation references `reference` (was `ref` in docstring).
+
+- **Storage data enum expansion & doc update**
+  - `StorageData`/`StorageDataObjectStorageData` now enumerate more `bucket_location` values (regional/zone shorthands). If you validate these values client-side, include the new options.
+  - `StorageDataObjectStorageData` doc now specifies key/value constraints.
+
+> **Migration checklist**
+>
+> - [ ] Rename `list_allowed_outbound_destination` → `list_allowed_outbound_destinations`.
+> - [ ] Rename `list_persistent_data_store` → `list_persistent_data_stores`.
+> - [ ] Switch pagers to pluralized classes.
+> - [ ] Update API `version` upper bound if you set it.
+> - [ ] For outbound destination **create**:
+>   - [ ] Provide `name` in prototypes.
+>   - [ ] For CIDR prototype, adjust constructor order to `(type, name, cidr_block)`.
+>   - [ ] Use new Private Path prototype when needed.
+> - [ ] For outbound destination **patch**: remove `type`; use CIDR/Private Path specific patch models.
+> - [ ] Set required fields now enforced in models (`Probe.type`, `Secret.format`, and the required lists/fields in `App`, `Build`, `BuildRun`, `Function`, `Job`, `JobRun`, etc.).
+> - [ ] Include handling for new enum values: `private_path_service_gateway`, `status` values (`ready|failed|deploying`), and `isolation_policy` (`shared|dedicated`).
+
 ## Installation
 
 To install, use `pip` or `easy_install`:
 
 ```bash
-pip install --upgrade "ibm_code_engine_sdk>=4.22.0"
+pip install --upgrade "ibm_code_engine_sdk>=5.0.0"
 ```
 
 or
 
 ```bash
-easy_install --upgrade "ibm_code_engine_sdk>=4.22.0"
+easy_install --upgrade "ibm_code_engine_sdk>=5.0.0"
 ```
 
 ## Using the SDK

examples/test_code_engine_v2_examples.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (C) Copyright IBM Corp. 2025.
+# (C) Copyright IBM Corp. 2026.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,7 +22,7 @@
 import pytest
 from ibm_code_engine_sdk.code_engine_v2 import *
 
-version = '2025-08-27'
+version = '2026-02-23'
 
 #
 # This file provides an example of how to use the Code Engine service.
@@ -147,17 +147,17 @@ def test_get_project_example(self):
             pytest.fail(str(e))
 
     @needscredentials
-    def test_list_allowed_outbound_destination_example(self):
+    def test_list_allowed_outbound_destinations_example(self):
         """
-        list_allowed_outbound_destination request example
+        list_allowed_outbound_destinations request example
         """
         try:
-            print('\nlist_allowed_outbound_destination() result:')
+            print('\nlist_allowed_outbound_destinations() result:')
 
-            # begin-list_allowed_outbound_destination
+            # begin-list_allowed_outbound_destinations
 
             all_results = []
-            pager = AllowedOutboundDestinationPager(
+            pager = AllowedOutboundDestinationsPager(
                 client=code_engine_service,
                 project_id='15314cc3-85b4-4338-903f-c28cdee6d005',
                 limit=100,
@@ -169,7 +169,7 @@ def test_list_allowed_outbound_destination_example(self):
 
             print(json.dumps(all_results, indent=2))
 
-            # end-list_allowed_outbound_destination
+            # end-list_allowed_outbound_destinations
         except ApiException as e:
             pytest.fail(str(e))
 
@@ -185,8 +185,8 @@ def test_create_allowed_outbound_destination_example(self):
 
             allowed_outbound_destination_prototype_model = {
                 'type': 'cidr_block',
+                'name': 'allow-all',
                 'cidr_block': 'testString',
-                'name': 'testString',
             }
 
             response = code_engine_service.create_allowed_outbound_destination(
@@ -1334,17 +1334,17 @@ def test_replace_secret_example(self):
             pytest.fail(str(e))
 
     @needscredentials
-    def test_list_persistent_data_store_example(self):
+    def test_list_persistent_data_stores_example(self):
         """
-        list_persistent_data_store request example
+        list_persistent_data_stores request example
         """
         try:
-            print('\nlist_persistent_data_store() result:')
+            print('\nlist_persistent_data_stores() result:')
 
-            # begin-list_persistent_data_store
+            # begin-list_persistent_data_stores
 
             all_results = []
-            pager = PersistentDataStorePager(
+            pager = PersistentDataStoresPager(
                 client=code_engine_service,
                 project_id='15314cc3-85b4-4338-903f-c28cdee6d005',
                 limit=100,
@@ -1356,7 +1356,7 @@ def test_list_persistent_data_store_example(self):
 
             print(json.dumps(all_results, indent=2))
 
-            # end-list_persistent_data_store
+            # end-list_persistent_data_stores
         except ApiException as e:
             pytest.fail(str(e))