c5144416 by Kyle Greenwell

Updated based on call with Mike and Skip. Changes include:

* Filling out README.md with content.
* Moving xsd to schema.
* Moving Tensor xids together
1 parent cafe57eb
1 temp
...\ No newline at end of file ...\ No newline at end of file
1 This is a public repo containing published XID (Xtensible Interface Definition) specifications. Files on the master branch are published specs.
2
3 * Naming conventions
4
5 Besides XID specs written in XML, there is a new concept of Concrete Interface Definitions (CID). These are complete specifications (no imports) that will have their own schema. XID and CID files can be written in XML, JSON, or XMF (if you are really the hardcore type person), XID CG should be able to input or output in these formats. Given that, the filename convention will be :
6
7 [filename].[xid|cid].[xml|json|xmf]
8
9 Specifications stored in the published repo may have a packaging structure that is independent of namespace (not really recommended though), thus path reference to a definition would be :
10
11 {[dir1]{/[dir2]…{/dirN}}}/[version]/ [filename].[xid|cid].[xml|json|xmf]
12
13 XSD Schemas for the XID/CID should be stored separately and versioned consistently with the pattern :
14
15 /schema/[version]/[specification].xsd
16
17 * Process
18
19 Update access to the master branch will be limited. Updates and new XID specs must be added on branches and merged to master via pull requests. Updates to existing XID specification (other than typo and documentation updates), will require updating the version directory.
......
...@@ -9,16 +9,16 @@ ...@@ -9,16 +9,16 @@
9 Use is subject to license terms included in the distribution. 9 Use is subject to license terms included in the distribution.
10 --> 10 -->
11 11
12 <specification xmlns="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 12 <specification xmlns="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
13 xmlns:xid="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 13 xmlns:xid="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
15 xsi:schemaLocation="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd" 15 xsi:schemaLocation="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
16 identity="TensorCommmon.xid"> 16 identity="Commmon.xid.xml">
17 <title>Tensor Commmon Definitions</title> 17 <title>Tensor Commmon Definitions</title>
18 <comment></comment> 18 <comment></comment>
19 <artifact></artifact> 19 <artifact></artifact>
20 20
21 <import ref="TensorDefinitions/V1.0.0/TensorDefinitions.xid.xml" local="TensorDefinitions.xid.xml" /> 21 <import ref="Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
22 22
23 <namespace name="Tensor"> 23 <namespace name="Tensor">
24 <struct name="NameValue" > 24 <struct name="NameValue" >
......
...@@ -9,11 +9,11 @@ ...@@ -9,11 +9,11 @@
9 Use is subject to license terms included in the distribution. 9 Use is subject to license terms included in the distribution.
10 --> 10 -->
11 11
12 <specification xmlns="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 12 <specification xmlns="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
13 xmlns:xid="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 13 xmlns:xid="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
15 xsi:schemaLocation="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd" 15 xsi:schemaLocation="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
16 identity="TensorDefinitions.xid"> 16 identity="Definitions.xid.xml">
17 <title>Tensor Common Defitions</title> 17 <title>Tensor Common Defitions</title>
18 <comment> 18 <comment>
19 Defines fundamental types mappings. 19 Defines fundamental types mappings.
......
...@@ -9,11 +9,11 @@ ...@@ -9,11 +9,11 @@
9 Use is subject to license terms included in the distribution. 9 Use is subject to license terms included in the distribution.
10 --> 10 -->
11 11
12 <specification xmlns="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 12 <specification xmlns="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
13 xmlns:xid="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd" 13 xmlns:xid="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 14 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
15 xsi:schemaLocation="http://xid.location.studio/XID/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd" 15 xsi:schemaLocation="http://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
16 identity="Logging.xid"> 16 identity="Logging.xid.xml">
17 <title>Tensor Logging Messages</title> 17 <title>Tensor Logging Messages</title>
18 <comment> 18 <comment>
19 This file contains the base type definitions for logging messages and data. All ENT micro-service compliant systems shall support these datatypes 19 This file contains the base type definitions for logging messages and data. All ENT micro-service compliant systems shall support these datatypes
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
21 as needed to support various types of information. 21 as needed to support various types of information.
22 </comment> 22 </comment>
23 23
24 <import ref="TensorDefinitions/V1.0.0/TensorDefinitions.xid.xml" local="TensorDefinitions.xid.xml" /> 24 <import ref="Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
25 25
26 <namespace name="Logging"> 26 <namespace name="Logging">
27 <using namespace="Tensor"/> 27 <using namespace="Tensor"/>
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!