docs(api): document BanManager v8 public API surface#504
Open
confuser wants to merge 3 commits into
Open
Conversation
Rewrite the BanManager API docs for the v8 BanManagerAPI artifact: the service interfaces (players, bans, mutes, events, database, migrations, scheduler), DTOs and request types, the DataSource privilege boundary, MigrationService semantics with prefix uniqueness, the EventBus threading contract, and the per-platform scheduler table. Update lib/mdx.js to render the new sections.
Default Array.sort() coerces to strings and SonarCloud flags it (S2871); localeCompare keeps the intended alphabetical order and clears the reliability issue failing the quality gate.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
content/docs/banmanager/api.mdx) to cover the v8 public API: theBanManagerServicefacade, per-domain services, DTOs, request builders, async vs. sync usage, and the event bus — replacing the legacy per-platform event documentation.lib/mdx.jstweak to support the updated doc rendering.Test plan
npm run devand visually review the BanManager API pageDocuments the API shipped in BanManagement/BanManager#1075.