change to api in tests, docs, and examples

Author: purplenicole730

docs/examples/module_step2.py

@@ -35,7 +35,7 @@ async def close(self):
 
 
 async def main():
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
 
 
 if __name__ == "__main__":

docs/examples/module_step2_optional.py

@@ -57,7 +57,7 @@ async def close(self):
 
 
 async def main():
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
 
 
 if __name__ == "__main__":

docs/examples/module_step3.py

@@ -40,7 +40,7 @@ async def main():
     This function creates and starts a new module, after adding all desired resource model.
     Resource creators must be registered to the resource registry before the module adds the resource model.
     """
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new))
 
     module = Module.from_args()
     module.add_model_from_registry(Sensor.API, MySensor.MODEL)

examples/complex_module/src/arm/my_arm.py

@@ -115,4 +115,4 @@ async def close(self):
         LOGGER.info(f"{self.name} is closed.")
 
 
-Registry.register_resource_creator(Arm.SUBTYPE, MyArm.MODEL, ResourceCreatorRegistration(MyArm.new))
+Registry.register_resource_creator(Arm.API, MyArm.MODEL, ResourceCreatorRegistration(MyArm.new))

examples/complex_module/src/base/my_base.py

@@ -147,4 +147,4 @@ async def get_geometries(self) -> List[Geometry]:
         raise NotImplementedError()
 
 
-Registry.register_resource_creator(Base.SUBTYPE, MyBase.MODEL, ResourceCreatorRegistration(MyBase.new, MyBase.validate_config))
+Registry.register_resource_creator(Base.API, MyBase.MODEL, ResourceCreatorRegistration(MyBase.new, MyBase.validate_config))

examples/complex_module/src/gizmo/my_gizmo.py

@@ -79,4 +79,4 @@ async def close(self):
         LOGGER.info(f"{self.name} is closed.")
 
 
-Registry.register_resource_creator(Gizmo.SUBTYPE, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))
+Registry.register_resource_creator(Gizmo.API, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))

examples/complex_module/src/summation/my_summation.py

@@ -45,4 +45,4 @@ def reconfigure(self, config: ComponentConfig, dependencies: Mapping[ResourceNam
         self.subtract = config.attributes.fields["subtract"].bool_value or False
 
 
-Registry.register_resource_creator(SummationService.SUBTYPE, MySummationService.MODEL, ResourceCreatorRegistration(MySummationService.new))
+Registry.register_resource_creator(SummationService.API, MySummationService.MODEL, ResourceCreatorRegistration(MySummationService.new))

examples/simple_module/src/main.py

@@ -63,7 +63,7 @@ async def main():
     """This function creates and starts a new module, after adding all desired resource models.
     Resource creators must be registered to the resource registry before the module adds the resource model.
     """
-    Registry.register_resource_creator(Sensor.SUBTYPE, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
+    Registry.register_resource_creator(Sensor.API, MySensor.MODEL, ResourceCreatorRegistration(MySensor.new, MySensor.validate_config))
 
     module = Module.from_args()
     module.add_model_from_registry(Sensor.API, MySensor.MODEL)

src/viam/resource/registry.py

@@ -95,19 +95,19 @@ def register_api(cls, registration: ResourceRegistration[Resource]):
                 raise ValidationError("Passed resource registration does not have correct parameters")
 
     @classmethod
-    def register_resource_creator(cls, subtype: "API", model: "Model", registration: ResourceCreatorRegistration):
+    def register_resource_creator(cls, api: "API", model: "Model", registration: ResourceCreatorRegistration):
         """Register a specific ``Model`` and validator function for the specific resource ``Subtype`` with the Registry
 
         Args:
-            subtype (Subtype): The Subtype of the resource
+            api (API): The API of the resource
             model (Model): The Model of the resource
             registration (ResourceCreatorRegistration): The registration functions of the model
 
         Raises:
-            DuplicateResourceError: Raised if the Subtype and Model pairing is already registered
+            DuplicateResourceError: Raised if the API and Model pairing is already registered
             ValidationError: Raised if registration does not have creator
         """
-        key = f"{subtype}/{model}"
+        key = f"{api}/{model}"
         with cls._lock:
             if key in cls._RESOURCES:
                 raise DuplicateResourceError(key)

tests/mocks/module/gizmo/__init__.py

@@ -6,4 +6,4 @@
 
 Registry.register_api(ResourceRegistration(Gizmo, GizmoService, lambda name, channel: GizmoClient(name, channel)))
 
-Registry.register_resource_creator(Gizmo.SUBTYPE, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))
+Registry.register_resource_creator(Gizmo.API, MyGizmo.MODEL, ResourceCreatorRegistration(MyGizmo.new, MyGizmo.validate_config))