Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@jeff-matthews
Copy link
Contributor

@jeff-matthews jeff-matthews commented Oct 17, 2025

Purpose

This pull request (PR) enables Mintlify's REST API playground feature as a proof of concept.

Things to consider

There are a few issues with this approach that need more research/discussion:

  1. This requires minor modifications to the servers section of the OpenAPI spec that we fetch from the BloodHound codebase. If we decide to proceed, I recommend exploring the use of an overlay to extend the original spec instead of modifying it directly.
  2. The current authentication requires copying/pasting a JWT bearer token from your browser into the docs site. Mintilfy offers a personalization feature that might help, but I'm not sure if it's a viable option.
  3. It's unclear to me whether we can offer this playground experience for anything other than the SaaS Enterprise edition (at least regarding personalization).

@jeff-matthews jeff-matthews self-assigned this Oct 17, 2025
@jeff-matthews jeff-matthews added the enhancement New feature or request label Oct 17, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 17, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/poc-api-playground

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants