[doc] Schema to document the eXist-db REST API Exception document format

Author: adamretter

schema/exist-rest-api-exception.xsd

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    Elemental
+    Copyright (C) 2024, Evolved Binary Ltd
+
+    [email protected]
+    https://www.evolvedbinary.com | https://www.elemental.xyz
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; version 2.1.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+-->
+<xs:schema
+  xmlns:xs="http://www.w3.org/2001/XMLSchema"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" vc:minVersion="1.1"
+  xmlns:dcterms="http://purl.org/dc/terms/"
+  elementFormDefault="qualified"
+  attributeFormDefault="unqualified"
+  version="1.0.0">
+  
+  <!-- 
+    Schema for Elemental's eXist-db REST API Exceptions
+  -->
+  <xs:annotation>
+    <xs:documentation>Schema for Exceptions raised by Elemental's eXist-db REST API</xs:documentation>
+    <xs:appinfo>
+      <dcterms:title>Schema for Exceptions raised by Elemental's eXist-db REST API</dcterms:title>
+      <dcterms:created xsi:type="dcterms:W3CDTF">2025-10-26T14:59:17.419+02:00</dcterms:created>
+      <dcterms:creator>Adam Retter</dcterms:creator>
+    </xs:appinfo>
+  </xs:annotation>
+  
+  <xs:element name="exception">
+    <xs:annotation>
+      <xs:documentation>REST API Exception.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="path" type="xs:string">
+          <xs:annotation>
+            <xs:documentation>The REST API path that raised the exception.</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+        <xs:element name="message" type="xs:string">
+          <xs:annotation>
+            <xs:documentation>The message of the exception.</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+        <xs:element name="query" type="xs:string" minOccurs="0">
+          <xs:annotation>
+            <xs:documentation>The XPath/XQuery that raised the exception.</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+
+</xs:schema>

schema/exist-rest-api.xsd

@@ -34,6 +34,7 @@
   version="1.0.0">
 
   <xs:import schemaLocation="exist-serialized-types.xsd" namespace="http://exist-db.org/xquery/types/serialized"/>
+  <xs:import schemaLocation="exist-rest-api-exception.xsd"/>
 
 
   <!-- 
@@ -49,6 +50,9 @@
   </xs:annotation>
 
   <xs:element name="query">
+    <xs:annotation>
+      <xs:documentation>REST API XPath/XQuery.</xs:documentation>
+    </xs:annotation>
     <xs:complexType>
       <xs:sequence>
         <xs:element name="properties" minOccurs="0">