Merge pull request #104 from inab/create-pull-request/patch-schema-docs

Updated schemas documentation (triggered by b98cb02)
inab · Jun 29, 2024 · b04d7f9 · b04d7f9
2 parents b98cb02 + b4c42d0
commit b04d7f9
Show file tree

Hide file tree

Showing 2 changed files with 278 additions and 60 deletions.
diff --git a/development-docs/schemas/stage-definition_schema.html b/development-docs/schemas/stage-definition_schema.html
@@ -822,7 +822,7 @@ <h2 class="mb-0">
             />
         </svg>
     <a href="#workflow_config_nextflow_profile" onclick="anchorLink('workflow_config_nextflow_profile')">profile</a></div><br/>
-<span class="description"><p>If defined, the profile/s to enable</p>
+<span class="description"><p>(deprecated) If defined, the profile/s to enable</p>
 </span><div class="one-of-value" id="workflow_config_nextflow_profile_oneOf"><h2 class="handle">
   <label>One of</label>
 </h2><ul class="nav nav-tabs" id="tabsworkflow_config_nextflow_profile_oneOf_oneOf" role="tablist"><li class="nav-item">
@@ -8359,6 +8359,161 @@ <h2 class="mb-0">
         </div>
     </div>
 </div>
+            </div>
+        </div>
+    </div>
+</div>
+<div class="accordion" id="accordionprofile">
+    <div class="card">
+        <div class="card-header" id="headingprofile">
+            <h2 class="mb-0">
+                <button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#profile"
+                        aria-expanded="" aria-controls="profile" onclick="setAnchor('#profile')"><span class="property-name">profile</span></button>
+            </h2>
+        </div>
+
+        <div id="profile"
+             class="collapse property-definition-div" aria-labelledby="headingprofile"
+             data-parent="#accordionprofile">
+            <div class="card-body pl-5">
+
+    <div class="breadcrumbs">root
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile" onclick="anchorLink('profile')">profile</a></div><br/>
+<span class="description"><p>For engines which support profiles, like Nextflow or snakemake, if defined, the profile/s to enable</p>
+</span><div class="one-of-value" id="profile_oneOf"><h2 class="handle">
+  <label>One of</label>
+</h2><ul class="nav nav-tabs" id="tabsprofile_oneOf_oneOf" role="tablist"><li class="nav-item">
+            <a class="nav-link active oneOf-option"
+               id="profile_oneOf_i0" data-toggle="tab" href="#tab-pane_profile_oneOf_i0" role="tab"
+               onclick="setAnchor('#profile_oneOf_i0')"
+            >Option 1</a>
+        </li><li class="nav-item">
+            <a class="nav-link oneOf-option"
+               id="profile_oneOf_i1" data-toggle="tab" href="#tab-pane_profile_oneOf_i1" role="tab"
+               onclick="setAnchor('#profile_oneOf_i1')"
+            >Option 2</a>
+        </li></ul>
+<div class="tab-content card"><div class="tab-pane fade card-body active show"
+             id="tab-pane_profile_oneOf_i0" role="tabpanel">
+
+
+    <div class="breadcrumbs">root
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile" onclick="anchorLink('profile')">profile</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf" onclick="anchorLink('profile_oneOf')">oneOf</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf_i0" onclick="anchorLink('profile_oneOf_i0')">item 0</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
+<span class="pattern-value" id="profile_oneOf_i0_pattern">Must match regular expression: <code>^[^, 	]+[ 	]*(,[ 	]*[^, 	]+[ 	]*)*$</code></span>
+
+
+
+        <p><span class="badge badge-light restriction min-length-restriction" id="profile_oneOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
+
+
+        </div><div class="tab-pane fade card-body "
+             id="tab-pane_profile_oneOf_i1" role="tabpanel">
+
+
+    <div class="breadcrumbs">root
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile" onclick="anchorLink('profile')">profile</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf" onclick="anchorLink('profile_oneOf')">oneOf</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf_i1" onclick="anchorLink('profile_oneOf_i1')">item 1</a></div><span class="badge badge-dark value-type">Type: array of string</span><br/>
+
+
+
+
+
+
+        <p><span class="badge badge-light restriction min-items-restriction" id="profile_oneOf_i1_minItems">Must contain a minimum of <code>1</code> items</span></p> <span class="badge badge-info no-additional">No Additional Items</span><h4>Each item of this array must be:</h4>
+    <div class="card">
+        <div class="card-body items-definition" id="profile_oneOf_i1_items">
+
+
+    <div class="breadcrumbs">root
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile" onclick="anchorLink('profile')">profile</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf" onclick="anchorLink('profile_oneOf')">oneOf</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf_i1" onclick="anchorLink('profile_oneOf_i1')">item 1</a>
+        <svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
+            <path
+                fill-rule="evenodd"
+                d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
+            />
+        </svg>
+    <a href="#profile_oneOf_i1_items" onclick="anchorLink('profile_oneOf_i1_items')">item 1 items</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
+<span class="pattern-value" id="profile_oneOf_i1_items_pattern">Must match regular expression: <code>^[^,]+$</code></span>
+
+
+
+        <p><span class="badge badge-light restriction min-length-restriction" id="profile_oneOf_i1_items_minLength">Must be at least <code>1</code> characters long</span></p>
+
+
+        </div>
+    </div>
+        </div></div></div>
+
+
+
+
+
+
             </div>
         </div>
     </div>
@@ -9213,6 +9368,6 @@ <h2 class="mb-0">
 </div>
 
     <footer>
-        <p class="generated-by-footer">Generated using <a href="https://github.com/coveooss/json-schema-for-humans">json-schema-for-humans</a> on 2024-05-30 at 12:20:23 +0000</p>
+        <p class="generated-by-footer">Generated using <a href="https://github.com/coveooss/json-schema-for-humans">json-schema-for-humans</a> on 2024-06-29 at 01:45:57 +0000</p>
     </footer></body>
 </html>