data_source.xsd 6.96 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="config">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="dataSource" minOccurs="1" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <!-- -->
    <xs:element name="dataSource">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="fields" minOccurs="0" maxOccurs="1"/>
                <xs:element ref="references" minOccurs="0" maxOccurs="1"/>
            </xs:sequence>
            <xs:attribute type="referenceAttributeType" name="name" use="required"/>
            <xs:attribute type="textAttributeType" name="label" use="required"/>
            <xs:attribute type="xs:string" name="dataSet" use="required"/>
        </xs:complexType>
    </xs:element>
    <!-- -->
    <xs:element name="fields">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="field" maxOccurs="unbounded" minOccurs="0"/>
            </xs:sequence>
            <xs:attribute type="referenceAttributeType" name="entityType" use="optional"/>
        </xs:complexType>
    </xs:element>
    <!-- -->
    <xs:element name="field">
        <xs:complexType>
            <xs:choice maxOccurs="unbounded">
                <xs:element type="fieldReferenceType" name="reference" maxOccurs="1" minOccurs="0"/>
                <xs:element type="fieldConstraintsType" name="constraints" maxOccurs="unbounded" minOccurs="0"/>
                <xs:element type="fieldTooltipType" name="tooltip" maxOccurs="unbounded" minOccurs="0"/>
            </xs:choice>
            <xs:attribute type="referenceAttributeType" name="name" use="required"/>
            <xs:attribute type="textAttributeType" name="dataType" use="optional"/>
            <xs:attribute type="textAttributeType" name="formElement" use="optional"/>
            <xs:attribute type="textAttributeType" name="componentType" use="optional"/>
            <xs:attribute type="textAttributeType" name="displayArea" use="optional"/>
            <xs:attribute type="textAttributeType" name="fieldGroup" use="optional"/>
            <xs:attribute type="textAttributeType" name="source" use="optional"/>
            <xs:attribute type="textAttributeType" name="optionProvider" use="optional"/>
            <xs:attribute type="textAttributeType" name="default_value" use="optional"/>
            <xs:attribute type="textAttributeType" name="label" use="optional"/>
            <xs:attribute type="textAttributeType" name="description" use="optional"/>
            <xs:attribute type="textAttributeType" name="uniqueNs" use="optional"/>
            <xs:attribute type="textAttributeType" name="uniqueProp" use="optional"/>
            <xs:attribute type="xs:integer" name="size" use="optional"/>
            <xs:attribute type="xs:string" name="customEntry" use="optional"/>
            <xs:attribute type="xs:boolean" name="visible" use="optional"/>
        </xs:complexType>
    </xs:element>
    <!-- -->
    <xs:element name="references">
        <xs:complexType>
            <xs:sequence>
                <xs:element type="reference" name="reference" maxOccurs="unbounded" minOccurs="1"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <!-- -->
    <xs:complexType name="reference">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute type="referenceAttributeType" name="target" use="required"/>
                <xs:attribute type="referenceAttributeType" name="referencedField" use="required"/>
                <xs:attribute type="referenceAttributeType" name="targetField" use="required"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <!-- -->
    <xs:complexType name="fieldReferenceType">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute type="referenceAttributeType" name="target" use="required"/>
                <xs:attribute type="referenceAttributeType" name="referencedField" use="required"/>
                <xs:attribute type="referenceAttributeType" name="targetField" use="required"/>
                <xs:attribute type="referenceAttributeType" name="neededField" use="required"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <!-- -->
    <xs:complexType name="fieldConstraintsType">
        <xs:choice maxOccurs="unbounded">
            <xs:element type="constraintValidateType" name="validate" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element type="constraintFilterType" name="filter" maxOccurs="unbounded" minOccurs="0"/>
            <xs:element type="constraintReadonlyType" name="readonly" maxOccurs="unbounded" minOccurs="0"/>
        </xs:choice>
    </xs:complexType>
    <xs:complexType name="constraintValidateType">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute type="xs:string" name="name" use="required"/>
                <xs:attribute type="xs:string" name="value" use="optional"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <xs:complexType name="constraintFilterType">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute type="xs:string" name="on" use="required"/>
                <xs:attribute type="xs:string" name="by" use="required"/>
                <xs:attribute type="xs:string" name="value" use="optional"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <xs:complexType name="constraintReadonlyType">
        <xs:simpleContent>
            <xs:extension base="xs:string">
                <xs:attribute type="xs:string" name="on" use="required"/>
                <xs:attribute type="xs:string" name="value" use="optional"/>
            </xs:extension>
        </xs:simpleContent>
    </xs:complexType>
    <!-- -->
    <xs:complexType name="fieldTooltipType">
        <xs:sequence>
            <xs:element type="xs:string" name="link" maxOccurs="1" minOccurs="1"/>
            <xs:element type="xs:string" name="description" maxOccurs="1" minOccurs="1"/>
        </xs:sequence>
    </xs:complexType>
    <!-- -->
    <xs:simpleType name="textAttributeType">
        <xs:annotation>
            <xs:documentation>Any text value</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:pattern value="[A-Za-z0-9,_.\\: -]+" />
        </xs:restriction>
    </xs:simpleType>
    <!-- -->
    <xs:simpleType name="referenceAttributeType">
        <xs:annotation>
            <xs:documentation>The value should only be {[a-z_-]+} since it is used as a reference to a database field.</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:pattern value="[a-z_-]+" />
        </xs:restriction>
    </xs:simpleType>
</xs:schema>