build based on 3af5627

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-08-28T02:48:24","julia_version":"1.12.7"}}
+{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-08-28T02:49:24","julia_version":"1.12.7"}}

dev/api/index.html

@@ -118,4 +118,4 @@
 HTTP/1.1 200 OK
 Content-Type: application/json; charset=utf-8
 
-15.0&quot;&quot;&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../cron_scheduling/">« Cron Scheduling</a><a class="docs-footer-nextpage" href="../oauth2/">OAuth2 with Umbrella.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:48">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+15.0&quot;&quot;&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../cron_scheduling/">« Cron Scheduling</a><a class="docs-footer-nextpage" href="../oauth2/">OAuth2 with Umbrella.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:49">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

@@ -35,4 +35,4 @@
 
 @cron "0 0/30 8-10 * * *" function()
   println("runs at 8:00, 8:30, 9:00, 9:30, 10:00 and 10:30 every day")
-end</code></pre><h2 id="Starting-and-Stopping-Cron-Jobs"><a class="docs-heading-anchor" href="#Starting-and-Stopping-Cron-Jobs">Starting &amp; Stopping Cron Jobs</a><a id="Starting-and-Stopping-Cron-Jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Starting-and-Stopping-Cron-Jobs" title="Permalink"></a></h2><p>When you run <code>serve()</code> or <code>serveparallel()</code>, all registered cron jobs are automatically started. If the server is stopped or killed, all running jobs will also be terminated. You can stop the server and all repeat tasks and cron jobs by calling the <code>terminate()</code> function or manually killing the server with <code>ctrl+C</code>.</p><p>In addition, Oxygen provides utility functions to manually start and stop cron jobs: <code>startcronjobs()</code> and <code>stopcronjobs()</code>. These functions can be used outside of a web server as well.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../request_body/">« Request Body</a><a class="docs-footer-nextpage" href="../bigger_applications/">Bigger Applications - Multiple Files »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:48">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><h2 id="Starting-and-Stopping-Cron-Jobs"><a class="docs-heading-anchor" href="#Starting-and-Stopping-Cron-Jobs">Starting &amp; Stopping Cron Jobs</a><a id="Starting-and-Stopping-Cron-Jobs-1"></a><a class="docs-heading-anchor-permalink" href="#Starting-and-Stopping-Cron-Jobs" title="Permalink"></a></h2><p>When you run <code>serve()</code> or <code>serveparallel()</code>, all registered cron jobs are automatically started. If the server is stopped or killed, all running jobs will also be terminated. You can stop the server and all repeat tasks and cron jobs by calling the <code>terminate()</code> function or manually killing the server with <code>ctrl+C</code>.</p><p>In addition, Oxygen provides utility functions to manually start and stop cron jobs: <code>startcronjobs()</code> and <code>stopcronjobs()</code>. These functions can be used outside of a web server as well.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../request_body/">« Request Body</a><a class="docs-footer-nextpage" href="../bigger_applications/">Bigger Applications - Multiple Files »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:49">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/objects.inv

@@ -16,4 +16,4 @@
 end</code></pre><p>Start the webserver with:</p><pre><code class="language-julia hljs">include(&quot;src/main.jl&quot;)</code></pre><h2 id="Line-by-line"><a class="docs-heading-anchor" href="#Line-by-line">Line by line</a><a id="Line-by-line-1"></a><a class="docs-heading-anchor-permalink" href="#Line-by-line" title="Permalink"></a></h2><pre><code class="language-julia hljs">using Oxygen
 using HTTP</code></pre><p>Here we pull in the both libraries our api depends on. The <code>@get</code> macro and <code>serve()</code> function come from Oxygen and the <code>HTTP.Request</code> type comes from the HTTP library.</p><p>Next we move into the core snippet where we define a route for our api. This route is made up of several components.</p><ul><li>http method  =&gt; from <code>@get</code> macro (it&#39;s a GET request)</li><li>path =&gt; the endpoint that will get added to our api which is <code>&quot;/greet&quot;</code></li><li>request handler =&gt; The function that accepts a request and returns a response</li></ul><pre><code class="language-julia hljs">@get &quot;/greet&quot; function(req::HTTP.Request)
     return &quot;hello world!&quot;
-end</code></pre><p>Finally at the bottom of our <code>Main</code> module we have this function to start up our brand new webserver. This function can take a number of keyword arguments such as the <code>host</code> &amp; <code>port</code>, which can be helpful if you don&#39;t want to use the default values.</p><pre><code class="language-julia hljs">serve()</code></pre><p>For example, you can start your server on port <code>8000</code> instead of <code>8080</code> which is used by default</p><pre><code class="language-julia hljs">serve(port=8000)</code></pre><h2 id="Try-out-your-endpoints"><a class="docs-heading-anchor" href="#Try-out-your-endpoints">Try out your endpoints</a><a id="Try-out-your-endpoints-1"></a><a class="docs-heading-anchor-permalink" href="#Try-out-your-endpoints" title="Permalink"></a></h2><p>You should see the server starting up inside the console.  You should be able to hit <code>http://127.0.0.1:8080/greet</code> inside your browser and see the following:</p><pre><code class="nohighlight hljs">&quot;hello world!&quot;</code></pre><h2 id="Interactive-API-documenation"><a class="docs-heading-anchor" href="#Interactive-API-documenation">Interactive API documenation</a><a id="Interactive-API-documenation-1"></a><a class="docs-heading-anchor-permalink" href="#Interactive-API-documenation" title="Permalink"></a></h2><p>Open your browser to http://127.0.0.1:8080/docs Here you&#39;ll see the auto-generated documentation for your api.  This is done internally by generating a JSON object that conforms to the openapi format.  Once generated, you can feed this same schema to libraries like swagger which translate this  into an interactive api for you to explore.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/">« Api</a><a class="docs-footer-nextpage" href="../request_types/">Request Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:48">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>Finally at the bottom of our <code>Main</code> module we have this function to start up our brand new webserver. This function can take a number of keyword arguments such as the <code>host</code> &amp; <code>port</code>, which can be helpful if you don&#39;t want to use the default values.</p><pre><code class="language-julia hljs">serve()</code></pre><p>For example, you can start your server on port <code>8000</code> instead of <code>8080</code> which is used by default</p><pre><code class="language-julia hljs">serve(port=8000)</code></pre><h2 id="Try-out-your-endpoints"><a class="docs-heading-anchor" href="#Try-out-your-endpoints">Try out your endpoints</a><a id="Try-out-your-endpoints-1"></a><a class="docs-heading-anchor-permalink" href="#Try-out-your-endpoints" title="Permalink"></a></h2><p>You should see the server starting up inside the console.  You should be able to hit <code>http://127.0.0.1:8080/greet</code> inside your browser and see the following:</p><pre><code class="nohighlight hljs">&quot;hello world!&quot;</code></pre><h2 id="Interactive-API-documenation"><a class="docs-heading-anchor" href="#Interactive-API-documenation">Interactive API documenation</a><a id="Interactive-API-documenation-1"></a><a class="docs-heading-anchor-permalink" href="#Interactive-API-documenation" title="Permalink"></a></h2><p>Open your browser to http://127.0.0.1:8080/docs Here you&#39;ll see the auto-generated documentation for your api.  This is done internally by generating a JSON object that conforms to the openapi format.  Once generated, you can feed this same schema to libraries like swagger which translate this  into an interactive api for you to explore.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/">« Api</a><a class="docs-footer-nextpage" href="../request_types/">Request Types »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:49">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/tutorial/bigger_applications/index.html

@@ -67,4 +67,4 @@
 end
 
 # start the web server
-serve()</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bigger_applications/">« Bigger Applications - Multiple Files</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:48">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+serve()</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../bigger_applications/">« Bigger Applications - Multiple Files</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Friday 28 August 2026 02:49">Friday 28 August 2026</span>. Using Julia version 1.12.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>