Http API Referene Docs (#945)

* remove old openapi.json spec

* add autogenerated file to gitignore

* script to generate openai.json spec

* add HTTP API sub section in reference section

.github/workflows/docs.yml

@@ -94,6 +94,11 @@ jobs:
         run: python -m development.docs.write_cli_docs
         working-directory: ./inference_repo
 
+      - name: Write OpenAPI spec
+        run: python -m development.docs.write_openapi_spec
+        working-directory: ./inference_repo
+
+
       - name: Deploy docs
         # Only deploy if release event OR if deploy input was set to true
         if: ${{ github.event_name == 'release' || github.event.inputs.deploy == 'true' }}

.gitignore

@@ -168,6 +168,7 @@ docs/workflows/blocks/*
 docs/workflows/kinds/*
 docs/workflows/gallery/*
 docs/inference_helpers/cli_commands/reference.md
+docs/openapi.json
 !tests/workflows/integration_tests/execution/assets/*.jpg
 !tests/workflows/integration_tests/execution/assets/rock_paper_scissors/*.jpg
 !tests/workflows/unit_tests/core_steps/models/third_party/assets/*.png

development/docs/write_openapi_spec.py

@@ -0,0 +1,61 @@
+
+
+
+from functools import partial
+from multiprocessing import Process
+
+from inference.core.cache import cache
+from inference.core.interfaces.http.http_api import HttpInterface
+from inference.core.interfaces.stream_manager.manager_app.app import start
+from inference.core.managers.active_learning import (
+    ActiveLearningManager,
+    BackgroundTaskActiveLearningManager,
+)
+from inference.core.managers.base import ModelManager
+from inference.core.managers.decorators.fixed_size_cache import WithFixedSizeCache
+from inference.core.registries.roboflow import (
+    RoboflowModelRegistry,
+)
+
+
+from inference.models.utils import ROBOFLOW_MODEL_TYPES
+
+
+
+model_registry = RoboflowModelRegistry(ROBOFLOW_MODEL_TYPES)
+
+
+model_manager = ModelManager(model_registry=model_registry)
+
+model_manager = WithFixedSizeCache(model_manager, max_size=1)
+model_manager.init_pingback()
+interface = HttpInterface(model_manager)
+app = interface.app
+
+
+
+
+from fastapi.openapi.utils import get_openapi
+import json
+import os
+
+DOCS_ROOT_DIR = os.path.abspath(
+    os.path.join(
+        os.path.dirname(__file__),
+        "..",
+        "..",
+        "docs",
+    )
+)
+
+filename = os.path.join(DOCS_ROOT_DIR, "openapi.json")
+
+with open(filename, 'w') as f:
+    json.dump(get_openapi(
+        title=app.title,
+        version=app.version,
+        openapi_version=app.openapi_version,
+        description=app.description,
+        routes=app.routes,
+
+    ), f)

docs/api.md

@@ -1,5 +1,5 @@
-The Roboflow Inference Server provides OpenAPI documentation at the `/docs` endpoint for use in development.
+When the Inference Server is running, it provides OpenAPI documentation at the `/docs` endpoint for use in development.
 
-Below is the OpenAPI specification for the Inference Server, rendered with Swagger.
+Below is the OpenAPI specification for the Inference Server for the current release version.
 
 <swagger-ui src="./openapi.json"/>

mkdocs.yml

@@ -103,6 +103,8 @@ nav:
           - Make Predictions: inference_helpers/cli_commands/infer.md
           - Deploy To Cloud: inference_helpers/cli_commands/cloud.md
           - Reference: inference_helpers/cli_commands/reference.md
+      - HTTP API:
+        - OpenAPI Spec: api.md
       - inference Python Package: reference/inference/
       - Active Learning:
           - Use Active Learning: enterprise/active-learning/active_learning.md