refactor(cbc): rename config→configuration in public API; drop unused NNV

Address review feedback on PR #333:

- Rename the business-config vocabulary to match the CBC API's own
  `configuration` wording: ConfigObject→ConfigurationObject,
  ConfigData→ConfigurationData, ConfigEntity→ConfigurationEntity (and the
  internal ConfigurationObjectEntity/Entry/List), get_config_object→
  get_configuration_object, and the config_object_id / config_objects fields
  and parameters. Test identifiers renamed to match.
- CBCConfig and CBCConfigError keep the short form — they are SDK client
  configuration (create_client overrides / setup errors), not CBC's managed
  business configuration.
- Drop the NNV model and the ConsumptionVersion.ref_content field it backed:
  parsed from the API response but never read anywhere.

63 unit tests pass; integration tests verified against a live CBC tenant.

Author: soumyadey

src/sap_cloud_sdk/cbc/__init__.py

@@ -18,7 +18,7 @@
     config = cbc_client.get_configuration()
 
     # Access entity data
-    payment = config.get_config_object("payment-config")
+    payment = config.get_configuration_object("payment-config")
     if payment:
         for row in payment.get_entity_data("payment-mode").as_list():
             print(row)
@@ -47,13 +47,12 @@
 )
 from sap_cloud_sdk.cbc._models import (
     ApiError,
-    ConfigData,
-    ConfigEntity,
-    ConfigObject,
+    ConfigurationData,
+    ConfigurationEntity,
+    ConfigurationObject,
     ConsumptionVersion,
     ConsumptionVersions,
     EntityData,
-    NNV,
 )
 
 
@@ -75,13 +74,12 @@
     # models — consumption versions
     "ConsumptionVersion",
     "ConsumptionVersions",
-    "NNV",
     # models — entities
     "EntityData",
-    "ConfigEntity",
-    "ConfigObject",
+    "ConfigurationEntity",
+    "ConfigurationObject",
     # models — configuration
-    "ConfigData",
+    "ConfigurationData",
     # models — api error
     "ApiError",
 ]

src/sap_cloud_sdk/cbc/_models.py

@@ -24,31 +24,18 @@ class _FrozenModel(BaseModel):
 # ---------------------------------------------------------------------------
 
 
-class NNV(_FrozenModel):
-    """Namespace-Name-Version tuple identifying a reference content version."""
-
-    namespace: str
-    name: str
-    version: str
-
-    def __str__(self) -> str:
-        return f"{self.namespace}.{self.name}.{self.version}"
-
-
 class ConsumptionVersion(_FrozenModel):
     """A snapshot of the business configuration for an app tenant at a point in time.
 
     Attributes:
         version: Version identifier.
         created_date: Creation timestamp.
         modified_date: Last modification timestamp.
-        ref_content: Reference content NNV this version is based on, if applicable.
     """
 
     version: str
     created_date: datetime | None = Field(default=None, alias="createdDate")
     modified_date: datetime | None = Field(default=None, alias="modifiedDate")
-    ref_content: NNV | None = Field(default=None, alias="referenceContentDetails")
 
 
 class ConsumptionVersions(_FrozenModel):
@@ -85,7 +72,7 @@ def latest(self) -> ConsumptionVersion | None:
 # ---------------------------------------------------------------------------
 
 
-class ConfigObjectEntity(_FrozenModel):
+class ConfigurationObjectEntity(_FrozenModel):
     """One entity listed under a config object by the ``configurationObjects`` API.
 
     Attributes:
@@ -96,26 +83,26 @@ class ConfigObjectEntity(_FrozenModel):
     entity_id: str = Field(alias="entityId")
 
 
-class ConfigObjectEntry(_FrozenModel):
+class ConfigurationObjectEntry(_FrozenModel):
     """One config object and its entities as returned by the API.
 
     Attributes:
-        config_object_id: Authored config object identifier (e.g. ``"payment-config"``).
+        configuration_object_id: Authored config object identifier (e.g. ``"payment-config"``).
         entities: Entities belonging to this config object.
     """
 
-    config_object_id: str = Field(alias="configurationObjectId")
-    entities: list[ConfigObjectEntity]
+    configuration_object_id: str = Field(alias="configurationObjectId")
+    entities: list[ConfigurationObjectEntity]
 
 
-class ConfigObjectList(_FrozenModel):
+class ConfigurationObjectList(_FrozenModel):
     """Config objects for a consumption version, already grouped by the API.
 
     Attributes:
-        items: List of :class:`ConfigObjectEntry` objects.
+        items: List of :class:`ConfigurationObjectEntry` objects.
     """
 
-    items: list[ConfigObjectEntry]
+    items: list[ConfigurationObjectEntry]
 
 
 class EntityData:
@@ -172,7 +159,7 @@ def __repr__(self) -> str:
 
 
 @dataclass
-class ConfigEntity:
+class ConfigurationEntity:
     """A single entity within a config object.
 
     Attributes:
@@ -185,16 +172,16 @@ class ConfigEntity:
 
 
 @dataclass
-class ConfigObject:
+class ConfigurationObject:
     """A configuration object and its entities.
 
     Attributes:
-        config_object_id: Authored config object identifier (e.g. ``"payment-config"``).
+        configuration_object_id: Authored config object identifier (e.g. ``"payment-config"``).
         entities: Entity data for all entities in this config object.
     """
 
-    config_object_id: str
-    entities: list[ConfigEntity]
+    configuration_object_id: str
+    entities: list[ConfigurationEntity]
 
     def get_entity_data(self, entity_id: str) -> EntityData | None:
         """Return the data for the entity with the given ID.
@@ -210,50 +197,52 @@ def get_entity_data(self, entity_id: str) -> EntityData | None:
 
 
 @dataclass
-class ConfigData:
+class ConfigurationData:
     """Complete business configuration — all config objects for one consumption version.
 
     Attributes:
         consumption_version: Version this data was fetched from.
         app_tenant_id: Application tenant this data belongs to.
-        config_objects: Configuration objects and their entity data.
+        configuration_objects: Configuration objects and their entity data.
     """
 
     consumption_version: str
     app_tenant_id: str
-    config_objects: list[ConfigObject]
+    configuration_objects: list[ConfigurationObject]
 
-    def get_config_object(self, config_object_id: str) -> ConfigObject | None:
+    def get_configuration_object(
+        self, configuration_object_id: str
+    ) -> ConfigurationObject | None:
         """Return the config object with the given ID.
 
         Args:
-            config_object_id: Authored config object identifier.
+            configuration_object_id: Authored config object identifier.
 
         Returns:
-            Matching :class:`ConfigObject`, or ``None`` if not found.
+            Matching :class:`ConfigurationObject`, or ``None`` if not found.
         """
         return next(
             (
                 co
-                for co in self.config_objects
-                if co.config_object_id == config_object_id
+                for co in self.configuration_objects
+                if co.configuration_object_id == configuration_object_id
             ),
             None,
         )
 
     def get_entity_data(
-        self, config_object_id: str, entity_id: str
+        self, configuration_object_id: str, entity_id: str
     ) -> EntityData | None:
         """Return the data for the given config object and entity IDs.
 
         Args:
-            config_object_id: Authored config object identifier.
+            configuration_object_id: Authored config object identifier.
             entity_id: Authored entity identifier.
 
         Returns:
             :class:`EntityData` for the matching entity, or ``None`` if not found.
         """
-        co = self.get_config_object(config_object_id)
+        co = self.get_configuration_object(configuration_object_id)
         return co.get_entity_data(entity_id) if co is not None else None
 
 

src/sap_cloud_sdk/cbc/client.py

@@ -38,10 +38,10 @@
 
 from sap_cloud_sdk.cbc._models import (
     ApiError,
-    ConfigData,
-    ConfigEntity,
-    ConfigObject,
-    ConfigObjectList,
+    ConfigurationData,
+    ConfigurationEntity,
+    ConfigurationObject,
+    ConfigurationObjectList,
     ConsumptionVersions,
     EntityData,
 )
@@ -261,7 +261,7 @@ def _get_consumption_versions(
 
     def _get_configuration_objects(
         self, base_url: str, app_tenant_id: str, consumption_version: str
-    ) -> ConfigObjectList:
+    ) -> ConfigurationObjectList:
         """Return the config objects (with their entities) for the given version.
 
         The API returns config objects already grouped with their child entities,
@@ -273,7 +273,7 @@ def _get_configuration_objects(
             consumption_version: Consumption version ID.
 
         Returns:
-            :class:`ConfigObjectList` containing config objects and their entities.
+            :class:`ConfigurationObjectList` containing config objects and their entities.
 
         Raises:
             CBCClientError: On 4xx responses.
@@ -285,13 +285,13 @@ def _get_configuration_objects(
             f"/consumptionVersions/{consumption_version}/configurationObjects"
             f"?appTenantId={app_tenant_id}",
         )
-        return ConfigObjectList.model_validate(self._request("GET", url).json())
+        return ConfigurationObjectList.model_validate(self._request("GET", url).json())
 
     @record_metrics(Module.CBC, Operation.CBC_GET_CONFIGURATION)
     def get_configuration(
         self,
         consumption_version: str | None = None,
-    ) -> ConfigData:
+    ) -> ConfigurationData:
         """Return the full business configuration for the configured tenant.
 
         Fetches the config objects and the data for every entity they contain, for
@@ -304,7 +304,7 @@ def get_configuration(
                 latest version is resolved via :meth:`get_consumption_versions`.
 
         Returns:
-            :class:`ConfigData` containing all entity data for the version.
+            :class:`ConfigurationData` containing all entity data for the version.
 
         Raises:
             CBCClientError: On 4xx responses, or when no consumption version exists
@@ -326,32 +326,32 @@ def get_configuration(
         co_list = self._get_configuration_objects(
             base_url, app_tenant_id, consumption_version
         )
-        config_objects = [
-            ConfigObject(
-                config_object_id=entry.config_object_id,
+        configuration_objects = [
+            ConfigurationObject(
+                configuration_object_id=entry.configuration_object_id,
                 entities=[
                     self._fetch_entity_data(
                         base_url,
                         app_tenant_id,
                         consumption_version,
-                        entry.config_object_id,
+                        entry.configuration_object_id,
                         entity.entity_id,
                     )
                     for entity in entry.entities
                 ],
             )
             for entry in co_list.items
         ]
-        return ConfigData(
+        return ConfigurationData(
             consumption_version=consumption_version,
             app_tenant_id=app_tenant_id,
-            config_objects=config_objects,
+            configuration_objects=configuration_objects,
         )
 
     @record_metrics(Module.CBC, Operation.CBC_GET_ENTITY_DATA)
     def get_entity_data(
         self,
-        config_object_id: str,
+        configuration_object_id: str,
         entity_id: str,
         consumption_version: str | None = None,
     ) -> EntityData:
@@ -362,7 +362,7 @@ def get_entity_data(
         config object.
 
         Args:
-            config_object_id: Authored config object identifier (e.g. ``"payment-config"``).
+            configuration_object_id: Authored config object identifier (e.g. ``"payment-config"``).
             entity_id: Authored entity identifier (e.g. ``"payment-mode"``).
             consumption_version: Consumption version ID. When ``None``, the
                 latest version is resolved via :meth:`get_consumption_versions`.
@@ -387,21 +387,25 @@ def get_entity_data(
                 )
             consumption_version = latest.version
         return self._fetch_entity_data(
-            base_url, app_tenant_id, consumption_version, config_object_id, entity_id
+            base_url,
+            app_tenant_id,
+            consumption_version,
+            configuration_object_id,
+            entity_id,
         ).data
 
     def _fetch_entity_data(
         self,
         base_url: str,
         app_tenant_id: str,
         consumption_version: str,
-        config_object_id: str,
+        configuration_object_id: str,
         entity_id: str,
-    ) -> ConfigEntity:
+    ) -> ConfigurationEntity:
         url = self._configurations_url(
             base_url,
             f"/consumptionVersions/{consumption_version}/configurationObjects"
-            f"/{config_object_id}/entities/{entity_id}/data"
+            f"/{configuration_object_id}/entities/{entity_id}/data"
             f"?appTenantId={app_tenant_id}",
         )
         body = self._request("GET", url).json()
@@ -414,7 +418,7 @@ def _fetch_entity_data(
             # ARRAY / UNSPECIFIED / absent — items may be absent or empty.
             raw_data = content.get("items", [])
 
-        return ConfigEntity(entity_id=entity_id, data=EntityData(raw_data))
+        return ConfigurationEntity(entity_id=entity_id, data=EntityData(raw_data))
 
     def _configurations_url(self, base_url: str, path: str = "") -> str:
         base = base_url.rstrip("/")