docs(jobs): generate combined json schema for render

also split the openapi/json schema links between different resources types

docs/schemas/index.rst

@@ -14,5 +14,5 @@ executor.
 
    plugins
    recipes
-   repository
    jobs
+   repository

docs/schemas/jobs.rst

@@ -26,7 +26,7 @@ Schema
       NProgress.start();
     </script>
     <script>
-      jsonSchemaViewer(window, '../_static/schemas/job-schema.json')
+      jsonSchemaViewer(window, '../_static/schemas/job-schemas-combined.json')
     </script>
     <script>
       NProgress.done();
@@ -40,15 +40,23 @@ Schema
 
 OpenAPI Docs 
 -------------
-You can find the Open API Docs formatted by redoc `here <../_static/redoc-job.html#tag/job_model>`_.
+You can find the Open API Docs formatted by redoc: 
+
+- `Job Schema <../_static/redoc-job.html#tag/job_model>`_.
+- `Job Status Schema <../_static/redoc-job.html#tag/jobstatus_model>`_.
+- `Run Status Schema <../_static/redoc-job.html#tag/runstatus_model>`_.
 
 OpenAPI Definition 
 -------------------
 You can find the OpenAPI JSON definition `here <../_static/schemas/job-openapi.json>`_.
 
 JSON Schema Definition 
 -----------------------
-You can find the JSON Schema definition `here <../_static/schemas/job-schema.json>`_.
+You can find the JSON Schema definitions:
+
+- `Job Schema <../_static/schemas/job-schema.json>`_.
+- `Job Status Schema <../_static/schemas/job-status-schema.json>`_.
+- `Run Status Schema <../_static/schemas/run-status-schema.json>`_.
 
 
 Examples

gen_schemas.py

@@ -10,7 +10,7 @@
 from pydantic_openapi_helper.inheritance import class_mapper
 
 from queenbee.repository import RepositoryIndex
-from queenbee.job import Job, JobStatus
+from queenbee.job import Job, JobStatus, RunStatus
 from queenbee.recipe import Recipe, RecipeInterface
 from queenbee.plugin import Plugin
 
@@ -52,7 +52,7 @@
 with open(os.path.join(folder, 'job-openapi.json'), 'w') as out_file:
     json.dump(
         get_openapi(
-            base_object=[Job], title='Queenbee Job Schema',
+            base_object=[Job, JobStatus, RunStatus], title='Queenbee Job Schema',
             description='Schema documentation for Queenbee Jobs',
             version=VERSION
         ),
@@ -93,9 +93,29 @@
         indent=2
     )
 
+
+with open(os.path.join(folder, 'job-schemas-combined.json'), 'w') as out_file:
+    from pydantic import BaseModel
+    from queenbee.io.inputs.step import StepInputs
+    from queenbee.io.outputs.step import StepOutputs
+    from typing import List, Union
+    class JobSchemas(BaseModel):
+        job: Job
+        job_status: JobStatus
+        run_status: RunStatus
+        results: List[Union[StepInputs, StepOutputs]]
+
+    out_file.write(JobSchemas.schema_json())
+
 with open(os.path.join(folder, 'job-schema.json'), 'w') as out_file:
     out_file.write(Job.schema_json())
 
+with open(os.path.join(folder, 'job-status-schema.json'), 'w') as out_file:
+    out_file.write(JobStatus.schema_json())
+
+with open(os.path.join(folder, 'run-status-schema.json'), 'w') as out_file:
+    out_file.write(RunStatus.schema_json())
+
 with open(os.path.join(folder, 'plugin-schema.json'), 'w') as out_file:
     out_file.write(Plugin.schema_json())