define data structure for an Interface

architecture/3-DataStructures/6-Interface.yaml

@@ -0,0 +1,42 @@
+name: Interface
+purpose: Identifies a shared boundary for connecting subcomponents
+template: |
+  id: {{id}}
+  description: {{description}}
+  endpoints: {{endpoints}}
+  interfaceBus: {{interfaceBus}}
+  dataType: {{dataType}}
+  protocol: {{protocol}}
+elements:
+  - key: id
+    type: string
+    itemType: ''
+    description: Interface's ID.
+    derivedFrom: []
+  - key: description
+    type: string
+    itemType: ''
+    description: Human readable description of the interface (e.g., "USB", "Ethernet", "Bluetooth").
+    derivedFrom: []
+  - key: endpoints
+    type: dictionary
+    itemType: 3-DataStructures/2-ComponentListItem.yaml
+    description: Listing of subcomponents connected via this interface (e.g., "Arduino board", "keyboard").  key = part id.  value = part's key data
+    derivedFrom: []
+  - key: interfaceBus
+    type: dictionary
+    itemType: 3-DataStructures/2-ComponentListItem.yaml
+    description: Listing of subcomponents allocated as the interface bus (e.g., "Ethernet hub").  key = part id.  value = part's key data
+    derivedFrom: []
+  - key: dataType
+    type: string
+    itemType: ''
+    description: Data type to be transferred across this interface (e.g., "TCP/IP packet")
+    derivedFrom: []
+  - key: protocol
+    type: string
+    itemType: ''
+    description: Protocol used to transfer data across this interface (e.g., "TCP/IP")
+    derivedFrom: []
+derivedFrom: 
+  - "0-References/4-TheSubjectOfTheInterface.yaml"