fix: correct documentation inaccuracies for license.validator, platform.*, and observability.otel modules#109
Merged
intel352 merged 2 commits intodocs/document-undocumented-module-typesfrom Feb 23, 2026
Conversation
5 tasks
…rm.*, and observability.otel modules Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document 10+ undocumented module types
fix: correct documentation inaccuracies for license.validator, platform.*, and observability.otel modules
Feb 23, 2026
intel352
added a commit
that referenced
this pull request
Feb 23, 2026
* security: add algorithm pinning tests for JWT confusion attacks (closes #95) Verified that all JWT validation paths in JWTAuthModule already enforce HS256 via both type assertion (*jwt.SigningMethodHMAC) and explicit algorithm check (token.Method.Alg() != jwt.SigningMethodHS256.Alg()). Added tests to module/jwt_auth_test.go that explicitly confirm tokens signed with HS384 or HS512 are rejected by: - Authenticate() — the AuthProvider interface method - handleRefresh via Handle() — the /auth/refresh endpoint - extractUserFromRequest via Handle() — all protected endpoints The api package (middleware.go, auth_handler.go) already had equivalent algorithm rejection tests in auth_handler_test.go. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: document 10+ undocumented module types in DOCUMENTATION.md (closes #66) Adds detailed documentation for audit logging, license.validator, platform.provider/resource/context, observability.otel, step.jq, AI pipeline steps (ai_complete, ai_classify, ai_extract), CI/CD steps (docker_build, docker_push, docker_run, scan_sast, scan_container, scan_deps, artifact_push, artifact_pull), and the admincore plugin. Each entry includes config field tables with types and defaults, plus a minimal YAML example. Summary tables in the module type index are also updated with the new Infrastructure and CI/CD Step categories. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: correct documentation inaccuracies for license.validator, platform.*, and observability.otel modules (#109) * Initial plan * fix: correct documentation inaccuracies for license.validator, platform.*, and observability.otel modules Co-authored-by: intel352 <77607+intel352@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: intel352 <77607+intel352@users.noreply.github.com> * fix: add nil guard for cfg map in otelTracingFactory Prevents potential issues when a module omits the config: section in YAML, which passes a nil map to the factory function. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: intel352 <77607+intel352@users.noreply.github.com>
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.
Several module type docs introduced in #66 contained inaccuracies or omissions relative to actual schema definitions and factory implementations.
Documentation fixes
license.validator— Removed false claim thatlicense_keysupports$ENV_VARexpansion; describes the actual fallback: readsWORKFLOW_LICENSE_KEYenv var when config value is emptyplatform.provider— Added missingconfig(map) andtiers(JSON) fields fromschema/module_schema.goplatform.resource— Added missingname,tier,capabilities, andconstraintsfields; corrected description to match schema ("capability-based resource declaration")platform.context— Removed nonexistentpathfield; fixedtiertype fromnumber→stringselect (infrastructure|shared_primitive|application); markedorgandenvironmentas requiredCode fix
observability.otelfactory (plugins/observability/modules.go) — Factory was ignoring the config map entirely. Now readsendpointandserviceNameand applies them viaSetEndpoint()/SetServiceName(), making the documented config fields actually functional:💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.