Skip to content

Enable API playground (proof of concept) #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jeff-matthews wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Enable API playground (proof of concept) #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
69a803b
wip: enable API playgroundproof of concept
jeff-matthews Oct 17, 2025
23ed8c9
wip: disable proxy server
jeff-matthews Oct 17, 2025
803092c
wip: simplify server vars; add protocol
jeff-matthews Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,8 @@
},
"api": {
"playground": {
"display": "simple"
"display": "interactive",
"proxy": false
}
},
"appearance": {
Expand Down
18 changes: 16 additions & 2 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,22 @@
},
"servers": [
{
"url": "/",
"description": "This is the base path for all endpoints, relative to the domain where the API is being hosted."
"url": "{protocol}://{ApiServer}/",
"description": "URL structure for BloodHound deployments",
"variables": {
"ApiServer": {
"description": "This is just a default value. Replace it with your BloodHound server.",
"default": "tenant.bloodhoundenterprise.io"
},
"protocol": {
"description": "The protocol used to access the BloodHound API.",
"default": "https",
"enum": [
"https",
"http"
]
}
}
}
],
"security": [
Expand Down