Skip to content

Commit aca41e7

Browse files
authored
Merge pull request #116 from inab/create-pull-request/patch-schema-docs
Updated schemas documentation (triggered by 53a8030)
2 parents 53a8030 + 6a2d29a commit aca41e7

File tree

2 files changed

+233
-9
lines changed

2 files changed

+233
-9
lines changed

development-docs/schemas/stage-definition_schema.html

Lines changed: 188 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4492,7 +4492,7 @@ <h4>Must <strong>not</strong> be:</h4>
44924492

44934493
<div class="enum-value">
44944494
<h4>The following properties are required:</h4>
4495-
<ul class="list-group"><li class="list-group-item required-property">tabular</li><li class="list-group-item required-property">url</li><li class="list-group-item required-property">secondary-urls</li><li class="list-group-item required-property">preferred-name</li><li class="list-group-item required-property">relative-dir</li><li class="list-group-item required-property">security-context</li><li class="list-group-item required-property">globExplode</li><li class="list-group-item required-property">autoFill</li><li class="list-group-item required-property">autoPrefix</li></ul>
4495+
<ul class="list-group"><li class="list-group-item required-property">tabular</li><li class="list-group-item required-property">url</li><li class="list-group-item required-property">secondary-urls</li><li class="list-group-item required-property">preferred-name</li><li class="list-group-item required-property">relative-dir</li><li class="list-group-item required-property">security-context</li><li class="list-group-item required-property">globExplode</li><li class="list-group-item required-property">autoFill</li><li class="list-group-item required-property">autoPrefix</li><li class="list-group-item required-property">cacheable</li><li class="list-group-item required-property">clonable</li></ul>
44964496
</div>
44974497

44984498

@@ -8434,6 +8434,192 @@ <h2 class="mb-0">
84348434
<p><span class="badge badge-light restriction min-length-restriction" id="params_pattern1_pattern1_i4_security-context_minLength">Must be at least <code>1</code> characters long</span></p>
84358435

84368436

8437+
</div>
8438+
</div>
8439+
</div>
8440+
</div>
8441+
<div class="accordion" id="accordionparams_pattern1_pattern1_i4_disclosable">
8442+
<div class="card">
8443+
<div class="card-header" id="headingparams_pattern1_pattern1_i4_disclosable">
8444+
<h2 class="mb-0">
8445+
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#params_pattern1_pattern1_i4_disclosable"
8446+
aria-expanded="" aria-controls="params_pattern1_pattern1_i4_disclosable" onclick="setAnchor('#params_pattern1_pattern1_i4_disclosable')"><span class="property-name">disclosable</span></button>
8447+
</h2>
8448+
</div>
8449+
8450+
<div id="params_pattern1_pattern1_i4_disclosable"
8451+
class="collapse property-definition-div" aria-labelledby="headingparams_pattern1_pattern1_i4_disclosable"
8452+
data-parent="#accordionparams_pattern1_pattern1_i4_disclosable">
8453+
<div class="card-body pl-5">
8454+
8455+
<div class="breadcrumbs">root
8456+
<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">
8457+
<path
8458+
fill-rule="evenodd"
8459+
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"
8460+
/>
8461+
</svg>
8462+
<a href="#params" onclick="anchorLink('params')">params</a>
8463+
<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">
8464+
<path
8465+
fill-rule="evenodd"
8466+
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"
8467+
/>
8468+
</svg>
8469+
<a href="#params_pattern1" onclick="anchorLink('params_pattern1')">^(?!c-l-a-s-s)[^:;]+$</a>
8470+
<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">
8471+
<path
8472+
fill-rule="evenodd"
8473+
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"
8474+
/>
8475+
</svg>
8476+
<a href="#params_pattern1_pattern1" onclick="anchorLink('params_pattern1_pattern1')">oneOf</a>
8477+
<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">
8478+
<path
8479+
fill-rule="evenodd"
8480+
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"
8481+
/>
8482+
</svg>
8483+
<a href="#params_pattern1_pattern1_i4" onclick="anchorLink('params_pattern1_pattern1_i4')">item 4</a>
8484+
<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">
8485+
<path
8486+
fill-rule="evenodd"
8487+
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"
8488+
/>
8489+
</svg>
8490+
<a href="#params_pattern1_pattern1_i4_disclosable" onclick="anchorLink('params_pattern1_pattern1_i4_disclosable')">disclosable</a></div><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
8491+
<span class="description"><p>Whether this input contents can be included in RO-Crates or exported</p>
8492+
</span>
8493+
8494+
8495+
8496+
8497+
8498+
8499+
</div>
8500+
</div>
8501+
</div>
8502+
</div>
8503+
<div class="accordion" id="accordionparams_pattern1_pattern1_i4_cacheable">
8504+
<div class="card">
8505+
<div class="card-header" id="headingparams_pattern1_pattern1_i4_cacheable">
8506+
<h2 class="mb-0">
8507+
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#params_pattern1_pattern1_i4_cacheable"
8508+
aria-expanded="" aria-controls="params_pattern1_pattern1_i4_cacheable" onclick="setAnchor('#params_pattern1_pattern1_i4_cacheable')"><span class="property-name">cacheable</span></button>
8509+
</h2>
8510+
</div>
8511+
8512+
<div id="params_pattern1_pattern1_i4_cacheable"
8513+
class="collapse property-definition-div" aria-labelledby="headingparams_pattern1_pattern1_i4_cacheable"
8514+
data-parent="#accordionparams_pattern1_pattern1_i4_cacheable">
8515+
<div class="card-body pl-5">
8516+
8517+
<div class="breadcrumbs">root
8518+
<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">
8519+
<path
8520+
fill-rule="evenodd"
8521+
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"
8522+
/>
8523+
</svg>
8524+
<a href="#params" onclick="anchorLink('params')">params</a>
8525+
<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">
8526+
<path
8527+
fill-rule="evenodd"
8528+
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"
8529+
/>
8530+
</svg>
8531+
<a href="#params_pattern1" onclick="anchorLink('params_pattern1')">^(?!c-l-a-s-s)[^:;]+$</a>
8532+
<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">
8533+
<path
8534+
fill-rule="evenodd"
8535+
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"
8536+
/>
8537+
</svg>
8538+
<a href="#params_pattern1_pattern1" onclick="anchorLink('params_pattern1_pattern1')">oneOf</a>
8539+
<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">
8540+
<path
8541+
fill-rule="evenodd"
8542+
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"
8543+
/>
8544+
</svg>
8545+
<a href="#params_pattern1_pattern1_i4" onclick="anchorLink('params_pattern1_pattern1_i4')">item 4</a>
8546+
<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">
8547+
<path
8548+
fill-rule="evenodd"
8549+
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"
8550+
/>
8551+
</svg>
8552+
<a href="#params_pattern1_pattern1_i4_cacheable" onclick="anchorLink('params_pattern1_pattern1_i4_cacheable')">cacheable</a></div><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
8553+
<span class="description"><p>Whether a copy of this input contents can be kept locally outside the working directory</p>
8554+
</span>
8555+
8556+
8557+
8558+
8559+
8560+
8561+
</div>
8562+
</div>
8563+
</div>
8564+
</div>
8565+
<div class="accordion" id="accordionparams_pattern1_pattern1_i4_clonable">
8566+
<div class="card">
8567+
<div class="card-header" id="headingparams_pattern1_pattern1_i4_clonable">
8568+
<h2 class="mb-0">
8569+
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#params_pattern1_pattern1_i4_clonable"
8570+
aria-expanded="" aria-controls="params_pattern1_pattern1_i4_clonable" onclick="setAnchor('#params_pattern1_pattern1_i4_clonable')"><span class="property-name">clonable</span></button>
8571+
</h2>
8572+
</div>
8573+
8574+
<div id="params_pattern1_pattern1_i4_clonable"
8575+
class="collapse property-definition-div" aria-labelledby="headingparams_pattern1_pattern1_i4_clonable"
8576+
data-parent="#accordionparams_pattern1_pattern1_i4_clonable">
8577+
<div class="card-body pl-5">
8578+
8579+
<div class="breadcrumbs">root
8580+
<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">
8581+
<path
8582+
fill-rule="evenodd"
8583+
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"
8584+
/>
8585+
</svg>
8586+
<a href="#params" onclick="anchorLink('params')">params</a>
8587+
<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">
8588+
<path
8589+
fill-rule="evenodd"
8590+
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"
8591+
/>
8592+
</svg>
8593+
<a href="#params_pattern1" onclick="anchorLink('params_pattern1')">^(?!c-l-a-s-s)[^:;]+$</a>
8594+
<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">
8595+
<path
8596+
fill-rule="evenodd"
8597+
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"
8598+
/>
8599+
</svg>
8600+
<a href="#params_pattern1_pattern1" onclick="anchorLink('params_pattern1_pattern1')">oneOf</a>
8601+
<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">
8602+
<path
8603+
fill-rule="evenodd"
8604+
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"
8605+
/>
8606+
</svg>
8607+
<a href="#params_pattern1_pattern1_i4" onclick="anchorLink('params_pattern1_pattern1_i4')">item 4</a>
8608+
<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">
8609+
<path
8610+
fill-rule="evenodd"
8611+
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"
8612+
/>
8613+
</svg>
8614+
<a href="#params_pattern1_pattern1_i4_clonable" onclick="anchorLink('params_pattern1_pattern1_i4_clonable')">clonable</a></div><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
8615+
<span class="description"><p>Whether a copy of this input contents can be kept locally inside the working directory</p>
8616+
</span>
8617+
8618+
8619+
8620+
8621+
8622+
84378623
</div>
84388624
</div>
84398625
</div>
@@ -9678,6 +9864,6 @@ <h2 class="mb-0">
96789864
</div>
96799865

96809866
<footer>
9681-
<p class="generated-by-footer">Generated using <a href="https://github.com/coveooss/json-schema-for-humans">json-schema-for-humans</a> on 2024-08-07 at 03:30:02 +0000</p>
9867+
<p class="generated-by-footer">Generated using <a href="https://github.com/coveooss/json-schema-for-humans">json-schema-for-humans</a> on 2024-09-17 at 12:33:28 +0000</p>
96829868
</footer></body>
96839869
</html>

0 commit comments

Comments
 (0)