docs(core): clarify super endpoint metadata contract#56
Merged
Conversation
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
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.
Intent
Validate committed Connect-Java docs-only correction at 7e123f1. Scope is strictly README.md plus core/src/main/resources/config.yml and proxy-config.yml. Remove unsupported public API and endpoint-control promises while preserving super-endpoints as WatchService parent metadata. Do not add API/runtime/release/production changes, do not touch the separate connect website repository, and do not use --yes.
What Changed
super-endpointsas optional WatchService parent metadata sent throughConnect-Endpoint-Parentsin both configuration templates andConnectConfigJavadoc.Risk Assessment
✅ Low: The docs-only change is tightly scoped, accurately matches the implementation, and the previously conflicting Javadoc is now aligned with the config templates.
Testing
Scoped to test/evidence only: inspected the exact diff, exercised config-to-WatchService behavior end-to-end, ran targeted config tests, built and inspected all release JARs, compared runtime semantics, rendered the corrected JavaDoc, and cleaned the worktree; all change-specific checks passed, with one unrelated pre-existing
:core:javadocfailure noted.Evidence: WatchService parent-header handshake
Evidence: Packaged documentation audit
Evidence: Rendered ConnectConfig JavaDoc
Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
🔧 **Review** - 1 issue found → auto-fixed ✅
core/src/main/resources/config.yml:11- This correction leaves the opposite contract inConnectConfigJavadoc (lines 63–66), which still claims super endpoints authorize player-control operations. Update that documentation too, or explicitly accept the conflicting public source documentation to preserve the three-file scope.🔧 Fix: Align super-endpoint Javadoc with parent metadata contract
✅ Re-checked - no issues remain.
core/src/main/java/com/minekube/connect/util/ReflectionUtils.java:286- The repository-wide:core:javadoctask fails on unchanged pre-existing documentation errors: malformed<T>tags in ReflectionUtils and an unresolved Velocity Property link in Utils. Neither file differs from the base commit, and targeted ConnectConfig JavaDoc rendering succeeds, so this does not invalidate the tested change.git diff --name-status a5297786e557d1adde5d73025b31304c4d688142 341da45479f0a0c7d75c2d704c7eba649c44ff21and full relevant-file diff inspectionCONNECT_WATCH_URL=ws://127.0.0.1:38137 CONNECT_EVIDENCE_PORT=38137 CONNECT_EVIDENCE_TEST_SRC=/var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD948G20CX9105PP9EARM52/test-src CONNECT_EVIDENCE_FILE=/var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD948G20CX9105PP9EARM52/watch-parent-headers.txt ./gradlew --no-daemon -I /var/folders/1y/cjgf53nj31n_dxsspqnjfjvc0000gn/T/no-mistakes-evidence/01KXD948G20CX9105PP9EARM52/external-test.init.gradle :core:test --tests com.minekube.connect.watch.SuperEndpointParentMetadataEvidenceTest --rerun-tasks./gradlew --no-daemon :core:test --tests com.minekube.connect.config.ConfigLoaderTest :spigot:shadowJar :velocity:shadowJar :bungee:shadowJar --rerun-tasksByte-for-bytecmpofconfig.ymlandproxy-config.ymlagainst copies embedded in all three built plugin JARs, plusrgaudit for removed unsupported claimsComment-stripped base/targetdiffcomparisons for both YAML templates andConnectConfig.javajavadoc -quiet -private -d <evidence>/connect-config-javadoc -classpath core/build/classes/java/main:api/build/classes/java/main core/build/generated/sources/delombok/java/main/com/minekube/connect/config/ConnectConfig.java./gradlew --no-daemon :core:javadoc --rerun-tasksvia the combined verification command; failed only on unchanged pre-existing JavaDoc errors./gradlew --no-daemon cleanand finalgit status --porcelain=v1 --untracked-files=all✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.