From 69a803b7e16b1b56328be5a907271c19542ad3b1 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 17 Oct 2025 14:47:08 -0500 Subject: [PATCH 1/3] wip: enable API playgroundproof of concept --- docs/docs.json | 2 +- docs/openapi.json | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/docs.json b/docs/docs.json index f16b0a95..7b4781ad 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -927,7 +927,7 @@ }, "api": { "playground": { - "display": "simple" + "display": "interactive" } }, "appearance": { diff --git a/docs/openapi.json b/docs/openapi.json index 3e1353bd..42c230ac 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -16,8 +16,18 @@ }, "servers": [ { - "url": "/", - "description": "This is the base path for all endpoints, relative to the domain where the API is being hosted." + "url": "https://{tenant}.{basePath}/", + "description": "URL structure for BloodHound deployments", + "variables": { + "tenant": { + "description": "Tenant subdomain for BloodHound Enterprise deployments (editable)", + "default": "example" + }, + "basePath": { + "description": "Domain for BloodHound Enterprise deployments (editable)", + "default": "bloodhoundenterprise.io" + } + } } ], "security": [ From 23ed8c97fa5951288647c55bb2538af13c36eb6f Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 17 Oct 2025 16:23:17 -0500 Subject: [PATCH 2/3] wip: disable proxy server --- docs/docs.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs.json b/docs/docs.json index 7b4781ad..471979f4 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -927,7 +927,8 @@ }, "api": { "playground": { - "display": "interactive" + "display": "interactive", + "proxy": false } }, "appearance": { From 803092cfdcaf292912987db7a3cc6d9b3745bfc1 Mon Sep 17 00:00:00 2001 From: Jeff Matthews Date: Fri, 17 Oct 2025 17:19:23 -0500 Subject: [PATCH 3/3] wip: simplify server vars; add protocol --- docs/openapi.json | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index 42c230ac..abaa7d90 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -16,16 +16,20 @@ }, "servers": [ { - "url": "https://{tenant}.{basePath}/", + "url": "{protocol}://{ApiServer}/", "description": "URL structure for BloodHound deployments", "variables": { - "tenant": { - "description": "Tenant subdomain for BloodHound Enterprise deployments (editable)", - "default": "example" + "ApiServer": { + "description": "This is just a default value. Replace it with your BloodHound server.", + "default": "tenant.bloodhoundenterprise.io" }, - "basePath": { - "description": "Domain for BloodHound Enterprise deployments (editable)", - "default": "bloodhoundenterprise.io" + "protocol": { + "description": "The protocol used to access the BloodHound API.", + "default": "https", + "enum": [ + "https", + "http" + ] } } }