brett/Zordon
1
0
Fork 0
mirror of https://github.com/blw1138/Zordon.git synced 2026-06-09 13:39:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

More jobs API cleanup

Browse Source
This commit is contained in:
Brett Williams
2026-06-06 08:09:45 -05:00
parent 5e154b6bab
commit 62e4a214e1
9 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/API.md
+6 -6
View File
@@ -45,7 +45,7 @@ Response:
Known callers:
- `RenderServerProxy.get_all_jobs()`
- `RenderServerProxy.get_jobs()`
- `src/ui/main_window.py`
### `GET /api/jobs/long_poll`
@@ -66,7 +66,7 @@ Responses:
Known callers:
- `RenderServerProxy.get_all_jobs()` through the background cache updater.
- `RenderServerProxy.get_jobs()` through the background cache updater.
### `GET /api/jobs/status/<status_val>`
@@ -92,7 +92,7 @@ Returns one job as JSON.
Known callers:
- `RenderServerProxy.get_job_info()`
- `RenderServerProxy.get_job()`
- `add_job.py`
- `src/ui/main_window.py`
- `src/distributed_job_manager.py`
@@ -112,7 +112,7 @@ Returns a list of output filenames for the job.
Known callers:
- `RenderServerProxy.get_job_files_list()`
- `RenderServerProxy.get_job_files()`
- `src/utilities/server_helper.py`
### `GET /api/jobs/<job_id>/download`
@@ -201,7 +201,7 @@ Responses:
Known callers:
- `RenderServerProxy.post_job_to_server()`
- `RenderServerProxy.create_job()`
- `add_job.py`
- `src/ui/add_job_window.py`
- `src/distributed_job_manager.py`
@@ -298,7 +298,7 @@ Returns a multi-server shaped status payload with the local server populated.
Known callers:
- `RenderServerProxy.get_data()`
- `RenderServerProxy.get_full_status()`
- `dashboard.py`
Review note: this currently reports only the local server. The response shape
docs/api.html
+5 -5
View File
@@ -282,7 +282,7 @@
}</code></pre>
<p>Known callers:</p>
<ul class="callers">
<li><code>RenderServerProxy.get_all_jobs()</code></li>
<li><code>RenderServerProxy.get_jobs()</code></li>
<li><code>src/ui/main_window.py</code></li>
</ul>
</article>
@@ -306,7 +306,7 @@
<article class="endpoint">
<div class="endpoint-header"><span class="method get">GET</span><span class="path">/api/jobs/&lt;job_id&gt;</span></div>
<p>Returns one job as JSON.</p>
<p>Known callers include <code>RenderServerProxy.get_job_info()</code>, <code>add_job.py</code>, <code>src/ui/main_window.py</code>, <code>src/distributed_job_manager.py</code>, and <code>tests/job_creation_tests.py</code>.</p>
<p>Known callers include <code>RenderServerProxy.get_job()</code>, <code>add_job.py</code>, <code>src/ui/main_window.py</code>, <code>src/distributed_job_manager.py</code>, and <code>tests/job_creation_tests.py</code>.</p>
</article>
<article class="endpoint">
@@ -317,7 +317,7 @@
<article class="endpoint">
<div class="endpoint-header"><span class="method get">GET</span><span class="path">/api/jobs/&lt;job_id&gt;/files</span></div>
<p>Returns a list of output filenames for the job.</p>
<p>Known callers: <code>RenderServerProxy.get_job_files_list()</code> and <code>src/utilities/server_helper.py</code>.</p>
<p>Known callers: <code>RenderServerProxy.get_job_files()</code> and <code>src/utilities/server_helper.py</code>.</p>
</article>
<article class="endpoint">
@@ -365,7 +365,7 @@
<tr><td><code>child_jobs</code></td><td>Optional subjob definitions.</td></tr>
<tr><td><code>local_path</code></td><td>Local file path used when posting to localhost.</td></tr>
</table>
<p>Known callers include <code>RenderServerProxy.post_job_to_server()</code>, <code>add_job.py</code>, <code>src/ui/add_job_window.py</code>, <code>src/distributed_job_manager.py</code>, and integration tests.</p>
<p>Known callers include <code>RenderServerProxy.create_job()</code>, <code>add_job.py</code>, <code>src/ui/add_job_window.py</code>, <code>src/distributed_job_manager.py</code>, and integration tests.</p>
</article>
<article class="endpoint">
@@ -414,7 +414,7 @@
<article class="endpoint">
<div class="endpoint-header"><span class="method get">GET</span><span class="path">/api/full_status</span></div>
<p>Returns a multi-server shaped status payload with the local server populated. Used by <code>RenderServerProxy.get_data()</code> and <code>dashboard.py</code>.</p>
<p>Returns a multi-server shaped status payload with the local server populated. Used by <code>RenderServerProxy.get_full_status()</code> and <code>dashboard.py</code>.</p>
<div class="note">The response shape suggests an intended future aggregation point, but it currently reports only the local server.</div>
</article>