Deployed 02bd21d to 2.4.12 with MkDocs 1.6.0 and mike 2.0.0

2.4.12/404.html

@@ -1128,6 +1128,8 @@
 
 
 
+
+
 
 
 
@@ -1424,6 +1426,27 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="/2.4.12/development/ui/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    UI
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 

2.4.12/api_reference/reference/index.html

@@ -26,7 +26,7 @@
 
 
 
-        <title>Generation - Documentation</title>
+        <title>File organization and naming conventions - Documentation</title>
 
 
 
@@ -85,7 +85,7 @@
     <div data-md-component="skip">
 
 
-        <a href="#generation" class="md-skip">
+        <a href="#file-organization-and-naming-conventions" class="md-skip">
           Skip to content
         </a>
 
@@ -124,7 +124,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              Generation
+              File organization and naming conventions
 
           </span>
         </div>
@@ -1139,6 +1139,8 @@
 
 
 
+
+
 
 
 
@@ -1435,6 +1437,27 @@
 
 
 
+
+
+
+
+
+
+    <li class="md-nav__item">
+      <a href="../../development/ui/" class="md-nav__link">
+
+
+  <span class="md-ellipsis">
+    UI
+  </span>
+
+
+      </a>
+    </li>
+
+
+
+
           </ul>
         </nav>
 
@@ -1655,6 +1678,14 @@
 
 
 
+<h1 id="file-organization-and-naming-conventions">File organization and naming conventions</h1>
+<p>For a given version, the following directories may be present
+* parameters
+  * path: the name of the parameter is used as file name. To differentiate parameters with the same name but used in different context, the file name can be prefixed a portion of the path.
+  * query: the name of the parameter is used as file name.
+* resources: the name of the resource files follows the resource path (slashes are converted to underscores). The operationId should correspond to the name of the file to which with the http verb is added.
+* responses: in camel cases
+* schemas: in camel cases</p>
 <h1 id="generation">Generation</h1>
 <p>To generate the documentation:
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>npx @redocly/cli build-docs iris.v2.1.0.yaml
@@ -1664,6 +1695,16 @@ <h1 id="file-organisation">File organisation</h1>
 * resources are stored in <code>${VERSION}/schemas/${SCHEMA_NAME}.yaml</code>
 * schemas are stored in <code>${VERSION}/resources/${RESOURCE_NAME}.yaml</code></p>
 <p>When a new version is introduced, only the new fragments are updated and put in the new <code>${VERSION}</code> directory.</p>
+<h1 id="some-other-useful-commands">Some other useful commands</h1>
+<p>Preview:
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>npx @redocly/cli preview-docs iris.v2.1.0.yaml
+</code></pre></div></p>
+<p>Lint:
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>npx @redocly/cli lint iris.v2.1.0.yaml
+</code></pre></div></p>
+<p>Bundle:
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>npx @redocly/cli bundle iris.v2.1.0.yaml --output &lt;specification.yaml&gt;
+</code></pre></div></p>
 
 
 
@@ -1684,7 +1725,7 @@ <h1 id="file-organisation">File organisation</h1>
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg>
     </span>
-    2024-06-28
+    2024-09-20
   </span>