Merge pull request #24 from epics-containers/object-id

Changes to ObjectArg and added IdArg

.vscode/settings.json

@@ -12,13 +12,5 @@
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
         "source.organizeImports": true
-    },
-    "yaml.schemas": {
-        "tests/samples/schemas/ibek.schema.json": [
-            "*.ibek.yaml"
-        ],
-        "tests/samples/schemas/pmac.schema.json": [
-            "*.pmac.yaml"
-        ]
-    },
+    }
 }

docs/conf.py

@@ -50,6 +50,8 @@
     ("py:class", "'float'"),
     ("py:class", "'int'"),
     ("py:class", "'bool'"),
+    ("py:class", "'object'"),
+    ("py:class", "'id'"),
     ("py:class", "apischema.utils.UndefinedType"),
     ("py:class", "typing_extensions.Literal"),
 ]

docs/explanations/entities.rst

@@ -40,7 +40,7 @@ Definition
 ----------
 
 Each support module has its own **support module definition file** . This
-is a YAML file whose name is by convention ``<support_module>.ibek.yaml``
+is a YAML file whose name is by convention ``<support_module>.ibek.defs.yaml``
 
 These will all reside in a folder called /ibek in the container
 image.
@@ -49,7 +49,7 @@ The **support module definition file** contains **Definitions** which
 determine what **Entities** an IOC instance may instantiate.
 
 For example the pmac support module declares the following **Definitions**
-in ``pmac.ibek.yaml``
+in ``pmac.ibek.defs.yaml``
 (currently this is limited to 3 - the full implementation would have more):
 
   - Geobrick
@@ -76,9 +76,9 @@ Expand below for the example pmac **support module definition file**:
     .. raw:: html
 
         <details>
-        <summary><a>pmac.ibek.yaml</a></summary>
+        <summary><a>pmac.ibek.defs.yaml</a></summary>
 
-    .. include:: ../../tests/samples/yaml/pmac.ibek.yaml
+    .. include:: ../../tests/samples/yaml/pmac.ibek.defs.yaml
         :literal:
 
     .. raw:: html
@@ -147,9 +147,9 @@ Click the arrows to reveal the files.
     .. raw:: html
 
         <details>
-        <summary><a>bl45p-mo-ioc-02.pmac.yaml</a></summary>
+        <summary><a>bl45p-mo-ioc-02.ibek.entities.yaml</a></summary>
 
-    .. include:: ../../tests/samples/yaml/bl45p-mo-ioc-02.pmac.yaml
+    .. include:: ../../tests/samples/yaml/bl45p-mo-ioc-02.ibek.entities.yaml
         :literal:
 
     .. raw:: html
@@ -189,16 +189,16 @@ Thus, the sequence of files is as follows:
         - Name
         - Description
     *   - 1
-        - ibek.schema.json
+        - ibek.defs.schema.json
         - Global Schema for **2**
     *   - 2
-        - <support>.ibek.yaml
+        - <support>.ibek.defs.yaml
         - Definition file for a support module. Generates part of **3**
     *   - 3
-        - <container>.schema.json
+        - <container>.entities.schema.json
         - Schema for **4**. Generated by combining all of **2** from a container
     *   - 4
-        - <ioc>.<container>.yaml
+        - <ioc>.ibek.entities.yaml
         - Description of Entities for an IOC instance.
     *   - 5
         - Helm Chart files
@@ -214,7 +214,7 @@ The Global Schema and example IOC instance schema are below:
         <details>
         <summary><a>ibek.schema.json</a></summary>
 
-    .. include:: ../../tests/samples/schemas/ibek.schema.json
+    .. include:: ../../tests/samples/schemas/ibek.defs.schema.json
         :literal:
 
     .. raw:: html
@@ -223,7 +223,7 @@ The Global Schema and example IOC instance schema are below:
         <details>
         <summary><a>ibek.pmac.json</a></summary>
 
-    .. include:: ../../tests/samples/schemas/pmac.schema.json
+    .. include:: ../../tests/samples/schemas/pmac.ibek.entities.schema.json
         :literal:
 
     .. raw:: html
@@ -244,28 +244,28 @@ The ibek commands to progress through the file sequence above are as follows
         - Name
         - Command
     *   - 1
-        - ``ibek.schema.json``
+        - ``ibek.defs.schema.json``
         - ``ibek ibek-schema``
     *   - 2
-        - ``<support>.ibek.yaml``
+        - ``<support>.ibek.defs.yaml``
         - Hand crafted by the container developer. Held in the container.
     *   - 3
-        - ``<container>.schema.json``
+        - ``<container>.ibek.entities.schema.json``
         - ``ibek ioc-schema ...`` run at container build time. ``...``
-          == all ``<support>.ibek.yaml`` within the container.
+          == all ``<support>.ibek.defs.yaml`` within the container.
     *   - 4
-        - ``<ioc>.<container>.yaml``
+        - ``<ioc>.ibek.entities.yaml``
         - Hand crafted at IOC instance design time
     *   - 5
         - Helm Chart files
-        - ``ibek build-helm <ioc>.<container>.yaml``
+        - ``ibek build-helm <ioc>.ibek.entities.yaml``
           run at IOC helm chart generation time. This generates a helm chart
-          with ``<ioc>.<container>.yaml`` in its config folder and validates it
+          with ``<ioc>.ibek.entities.yaml`` in its config folder and validates it
           against the schema defined at the top of the YAML file.
     *   - 6
         - IOC startup script
-        - ``ibek build-startup <ioc>.<container>.yaml ...``. Run at IOC startup time in the
-          container. ``...`` == all ``<support>.ibek.yaml`` within the container.
+        - ``ibek build-startup <ioc>.ibek.entities.yaml ...``. Run at IOC startup time in the
+          container. ``...`` == all ``<support>.ibek.defs.yaml`` within the container.
 
 
 

src/ibek/__main__.py

@@ -44,7 +44,7 @@ def main(
 def ibek_schema(
     output: Path = typer.Argument(..., help="The filename to write the schema to")
 ):
-    """Produce the JSON global schema for all <support_module>.ibek.yaml files"""
+    """Produce the JSON global schema for all <support_module>.ibek.defs.yaml files"""
     schema = json.dumps(make_schema(Support), indent=2)
     output.write_text(schema)
 
@@ -58,7 +58,7 @@ def ioc_schema(
     no_schema: bool = typer.Option(False, help="disable schema checking"),
 ):
     """
-    Create a json schema from a <support_module>.ibek.yaml file
+    Create a json schema from a <support_module>.ibek.defs.yaml file
     """
 
     # first check the definition file with jsonschema since it has more