webapi.xsd 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. /**
  4. * Structure description for webapi.xml configuration files.
  5. *
  6. * Copyright © Magento, Inc. All rights reserved.
  7. * See COPYING.txt for license details.
  8. */
  9. -->
  10. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  11. <xs:element name="routes" type="routesType"/>
  12. <xs:complexType name="routesType">
  13. <xs:sequence>
  14. <xs:element name="route" type="routeType" minOccurs="0" maxOccurs="unbounded"/>
  15. </xs:sequence>
  16. </xs:complexType>
  17. <xs:complexType name="routeType">
  18. <xs:sequence>
  19. <xs:element name="service" type="serviceType"/>
  20. <xs:element name="resources" type="resourcesType"/>
  21. <xs:element name="data" type="dataType" minOccurs="0"/>
  22. </xs:sequence>
  23. <xs:attribute name="method" use="required">
  24. <xs:simpleType>
  25. <xs:restriction base="xs:string">
  26. <xs:enumeration value="GET"/>
  27. <xs:enumeration value="PUT"/>
  28. <xs:enumeration value="POST"/>
  29. <xs:enumeration value="DELETE"/>
  30. </xs:restriction>
  31. </xs:simpleType>
  32. </xs:attribute>
  33. <xs:attribute name="url" type="xs:string" use="required"/>
  34. <xs:attribute name="secure" type="xs:boolean"/>
  35. </xs:complexType>
  36. <xs:complexType name="serviceType">
  37. <xs:attribute name="class" type="xs:string" use="required"/>
  38. <xs:attribute name="method" type="xs:string" use="required"/>
  39. </xs:complexType>
  40. <xs:complexType name="resourcesType" >
  41. <xs:sequence>
  42. <xs:element name="resource" type="resourceType" maxOccurs="unbounded"/>
  43. </xs:sequence>
  44. </xs:complexType>
  45. <xs:complexType name="resourceType">
  46. <xs:attribute name="ref" use="required">
  47. <xs:simpleType>
  48. <xs:restriction base="xs:string">
  49. <xs:pattern value=".+(, ?.+)*"/>
  50. </xs:restriction>
  51. </xs:simpleType>
  52. </xs:attribute>
  53. </xs:complexType>
  54. <xs:complexType name="dataType" >
  55. <xs:sequence>
  56. <xs:element name="parameter" type="parameterType" maxOccurs="unbounded"/>
  57. </xs:sequence>
  58. </xs:complexType>
  59. <xs:complexType name="parameterType">
  60. <xs:simpleContent>
  61. <xs:extension base="xs:string">
  62. <xs:attribute name="name" type="xs:string" use="required"/>
  63. <xs:attribute name="force" type="xs:boolean"/>
  64. </xs:extension>
  65. </xs:simpleContent>
  66. </xs:complexType>
  67. </xs:schema>