docs(api): generate HTML documentation from OpenAPI spec

xability · Aug 22, 2024 · 2ba5969 · 2ba5969
1 parent 41c32e5
commit 2ba5969
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/docs/index.html b/docs/index.html
@@ -3,7 +3,7 @@
 
 <head>
   <meta charset="utf8" />
-  <title>Multi Panel Schema API</title>
+  <title>MAIDR Schema API</title>
   <!-- needed for adaptive design -->
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <style>
@@ -279,11 +279,11 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">Multi Panel Schema API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-summary" html="" class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="" class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div></div></div></div><div id="/paths/~1maidr-metadata/get" data-section-id="/paths/~1maidr-metadata/get" class="sc-dsLQwm kcRA-dj"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt"><h2 class="sc-knesRu cbpGTP"><a class="sc-jCbFiK hSvuOo" href="#/paths/~1maidr-metadata/get" aria-label="/paths/~1maidr-metadata/get"></a>Get multi-panel schema<!-- --> </h2><div><h3 class="sc-eiLgtK dbBFCU">Responses</h3><div><button class="sc-giOWAb gcYfHW"><svg class="sc-cBYhjr fqtTpb" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-catHVh gXPvFO">200<!-- --> </strong><div html="&lt;p&gt;Successful response&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">MAIDR Schema API<!-- --> <span>(<!-- -->1.0.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-summary" html="" class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="" class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"></div></div></div></div><div id="/paths/~1maidr-metadata/get" data-section-id="/paths/~1maidr-metadata/get" class="sc-dsLQwm kcRA-dj"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt"><h2 class="sc-knesRu cbpGTP"><a class="sc-jCbFiK hSvuOo" href="#/paths/~1maidr-metadata/get" aria-label="/paths/~1maidr-metadata/get"></a>Get multi-panel schema<!-- --> </h2><div><h3 class="sc-eiLgtK dbBFCU">Responses</h3><div><button class="sc-giOWAb gcYfHW"><svg class="sc-cBYhjr fqtTpb" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-catHVh gXPvFO">200<!-- --> </strong><div html="&lt;p&gt;Successful response&lt;/p&gt;
 " class="sc-euGpHm sc-exayXG fwfkcU kqJXdD sc-dHrNzZ dRdjww"><p>Successful response</p>
 </div></button></div></div></div><div class="sc-iKTcqh sc-gnpbhQ fTxZsC drGLlX"><div class="sc-dKsqdn dCbPd"><button class="sc-iAlELC gsBSOU"><span type="get" class="sc-oeqTF ffmPnn http-verb get">get</span><span class="sc-eowDPD jcAXWA">/maidr-metadata</span><svg class="sc-cBYhjr iMxoRf" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ezTrPE bFiOkX"><div class="sc-drnuxz hdRKqQ"><div html="" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"></div><div tabindex="0" role="button"><div class="sc-hDcvty jpmGrk"><span></span>/maidr-metadata</div></div></div></div></div><div><h3 class="sc-kkmypM jKNCPF"> <!-- -->Response samples<!-- --> </h3><div class="sc-bSlUec jxQggo" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R9pq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R9pq:0" tabindex="0" data-rttab="true">200</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R9pq:0" aria-labelledby="tab:R9pq:0"><div><div class="sc-WChnI iLXIA-d"><span class="sc-foMnoT dmNpjh">Content type</span><div class="sc-ZubPq KmnOC">application/json</div></div><div class="sc-AmOMz gDrQpr"><div class="sc-eTdEpr dgzSkD"><div class="sc-pFPEP bMXXJy"><button><div class="sc-eHujzY ecCAmX">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-euGpHm fwfkcU sc-fTgapq bDqsIm"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"id"</span>: <span class="token string">&quot;container-figure-id&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"selector"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"layout"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"rows"</span>: <span class="token number">3</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"columns"</span>: <span class="token number">2</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"title"</span>: <span class="token string">&quot;Penguin Bill Dimensions by Species and Sex&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"axes"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"x"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;Bill Length (mm)&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"y"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;Bill Depth (mm)&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable "><span class="property token string">"panels"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">&quot;panel-01&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"selector"</span>: <span class="token string">&quot;&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"type"</span>: <span class="token string">&quot;point&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"title"</span>: <span class="token string">&quot;Adelie - Female&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"axes"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"x"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;Bill Length (mm)&quot;</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"y"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"label"</span>: <span class="token string">&quot;Bill Depth (mm)&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"data"</span>: <button class="collapser" aria-label="expand"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"x"</span>: <span class="token number">39.5</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"y"</span>: <span class="token number">17.4</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-epzHnm bWkBKa"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"Multi Panel Schema API","version":"1.0.0"},"paths":{"/maidr-metadata":{"get":{"summary":"Get multi-panel schema","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaidrSchema"}}}}}}}},"components":{"schemas":{"MaidrSchema":{"type":"object","properties":{"id":{"type":"string","example":"container-figure-id"},"selector":{"type":"string","example":""},"layout":{"type":"object","properties":{"rows":{"type":"integer","example":3},"columns":{"type":"integer","example":2}}},"title":{"type":"string","example":"Penguin Bill Dimensions by Species and Sex"},"axes":{"type":"object","properties":{"x":{"type":"object","properties":{"label":{"type":"string","example":"Bill Length (mm)"}}},"y":{"type":"object","properties":{"label":{"type":"string","example":"Bill Depth (mm)"}}}}},"panels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"panel-01"},"selector":{"type":"string","example":""},"type":{"type":"string","description":"Specifies the type of the item, e.g., 'point', 'bar', or 'line'.","enum":["bar","hist","heat","box","point","line","stacked","dodged"],"example":"point"},"title":{"type":"string","example":"Adelie - Female"},"axes":{"type":"object","properties":{"x":{"type":"object","properties":{"label":{"type":"string","example":"Bill Length (mm)"}}},"y":{"type":"object","properties":{"label":{"type":"string","example":"Bill Depth (mm)"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","example":39.5},"y":{"type":"number","example":17.4}}}}}}}}}}}}},"searchIndex":{"store":["/paths/~1maidr-metadata/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.288,1,0.288]],["description/0",[2,0.288]]],"invertedIndex":[["maidr-metadata",{"_index":2,"title":{},"description":{"0":{}}}],["multi-panel",{"_index":0,"title":{"0":{}},"description":{}}],["schema",{"_index":1,"title":{"0":{}},"description":{}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"title":"MAIDR Schema API","version":"1.0.0"},"paths":{"/maidr-metadata":{"get":{"summary":"Get multi-panel schema","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaidrSchema"}}}}}}}},"components":{"schemas":{"MaidrSchema":{"type":"object","properties":{"id":{"type":"string","example":"container-figure-id"},"selector":{"type":"string","example":""},"layout":{"type":"object","properties":{"rows":{"type":"integer","example":3},"columns":{"type":"integer","example":2}}},"title":{"type":"string","example":"Penguin Bill Dimensions by Species and Sex"},"axes":{"type":"object","properties":{"x":{"type":"object","properties":{"label":{"type":"string","example":"Bill Length (mm)"}}},"y":{"type":"object","properties":{"label":{"type":"string","example":"Bill Depth (mm)"}}}}},"panels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"panel-01"},"selector":{"type":"string","example":""},"type":{"type":"string","description":"Specifies the type of the item, e.g., 'point', 'bar', or 'line'.","enum":["bar","hist","heat","box","point","line","stacked","dodged"],"example":"point"},"title":{"type":"string","example":"Adelie - Female"},"axes":{"type":"object","properties":{"x":{"type":"object","properties":{"label":{"type":"string","example":"Bill Length (mm)"}}},"y":{"type":"object","properties":{"label":{"type":"string","example":"Bill Depth (mm)"}}}}},"data":{"type":"array","items":{"type":"object","properties":{"x":{"type":"number","example":39.5},"y":{"type":"number","example":17.4}}}}}}}}}}}}},"searchIndex":{"store":["/paths/~1maidr-metadata/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.288,1,0.288]],["description/0",[2,0.288]]],"invertedIndex":[["maidr-metadata",{"_index":2,"title":{},"description":{"0":{}}}],["multi-panel",{"_index":0,"title":{"0":{}},"description":{}}],["schema",{"_index":1,"title":{"0":{}},"description":{}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);