Merge pull request #19172 from bernt-matthias/doc/resource

[24.2] Add requirement/resource to schema docs
galaxyproject · Nov 20, 2024 · b02d829 · b02d829
2 parents 0390a8b + ea724bf
commit b02d829
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/doc/schema_template.md b/doc/schema_template.md
@@ -31,6 +31,7 @@ $tag:tool|creator|organization://complexType[@name='Organization']
 $tag:tool|requirements://complexType[@name='Requirements']
 $tag:tool|requirements|requirement://complexType[@name='Requirement']
 $tag:tool|requirements|container://complexType[@name='Container']
+$tag:tool|requirements|resource://complexType[@name='Resource']
 $tag:tool|required_files://complexType[@name='RequiredFiles']
 $tag:tool|required_files|include://complexType[@name='RequiredFileInclude']
 $tag:tool|required_files|exclude://complexType[@name='RequiredFileExclude']

diff --git a/lib/galaxy/tool_util/xsd/galaxy.xsd b/lib/galaxy/tool_util/xsd/galaxy.xsd
@@ -675,6 +675,12 @@ resolver.
     </xs:simpleContent>
   </xs:complexType>
   <xs:complexType name="Resource">
+    <xs:annotation>
+      <xs:documentation xml:lang="en"><![CDATA[
+Allows to describe a resource requirement of a tool. At the moment this tag is mostly descriptive,
+It can be used by dynamic job rules and serves to guide Galaxy admins.
+]]></xs:documentation>
+    </xs:annotation>
     <xs:simpleContent>
       <xs:extension base="xs:string">
         <xs:attribute name="type" type="ResourceType" use="required">