docs: 1.1.0 API reference + auth/core/events package pages#52
Merged
Conversation
intech
force-pushed
the
docs/api-and-pages-1.1.0
branch
from
61ac243 to
8e33f33
Compare
intech
force-pushed
the
docs/api-and-pages-1.1.0
branch
from
f32a092 to
71bd7d2
Compare
…rce links) TypeDoc against the current source. Adds the new 1.1.0 pages — createCatalogClient (+ CatalogClient / CreateCatalogClientOptions); createInternalAuthInterceptor, meshIdentityTrust, signedTokenTrust, sharedSecretTrust, getInternalMethods (+ their option/type pages); the @connectum/auth/testing RS256 helpers; and createBroadcastSubscribers (+ BroadcastReactor / BroadcastSubscribersOptions) — and updates EventBusOptions (now publishes + strictTopics). All source links are normalized to a stable /blob/main/... (connectum's docs:api post-process), so this is a one-time link stabilization with no spurious churn or file moves on future regens. Zero deletions (1.1.0 is additive). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
Mirror the package READMEs (verified against the real exports, each marked "since 1.1.0"): createCatalogClient (core); internal auth — createInternalAuthInterceptor + trust sources + getInternalMethods, links ADR-029, and the RS256 test helpers (auth); createBroadcastSubscribers + strictTopics (events). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
Add `internal` to the proto-authz guide alongside `public`: the service-level and method-level option tables, the authorization priority order (internal → reject if no identity / allow if no requires / else evaluate requires), and the merge-precedence table. Links ADR-029; marked "since 1.1.0". Verified against options.proto (optional bool internal on ServiceAuth + MethodAuth) and the createProtoAuthzInterceptor resolution order. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
… link Verified-accurate doc-currency fixes (surfaced by the doc-currency review, each checked against source before applying): - pnpm floor 10 → 11 in cli-commands / development-setup / quickstart — connectum's package.json `engines.pnpm` is ">=11" (packageManager pinned to pnpm@11.0.4); the prose had lagged. - createCatalogClient (1.1.0) cross-referenced where the catalog/resolver are documented: service-catalog (a no-Server usage example), resolvers (the third resolver consumer), protoc-gen-catalog (the catalog also types it). - cli page: note `connectum --version`. - kubernetes: the car-sharing/k8s pointer referenced a non-existent `secret-jwt.yaml`; reworded to the actual `configmap.yaml` + Istio-mTLS setup. The auth/core/events package pages from the same review were superseded by the fuller versions already in this PR. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
Example/demo code on the site (the homepage "See It in Action" snippet and the
auth / interceptors guide snippets) cited internal ADR numbers in code comments
("ADR-024 order", "(ADR-024)"). A reader copying the example has no context for
an ADR number — it is internal jargon in code that should be clean and
self-explanatory. Replaced with plain wording ("Fixed-order chain",
"Recommended order"); the architectural rationale still lives in the ADR pages
and prose, not in example code.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
…85/#186 fields The API reference on this branch was generated before externalContract (#185) and caller-set messageId/timestamp (#186) landed on connectum main, so three published 1.1.0 fields were missing. Regenerate against current main and document them on the narrative package pages. - en/api: TypeDoc regen — adds PublishOptions.messageId / timestamp and AmqpPublisherOptions.externalContract. Remaining churn is source-link updates (protobuf-es 2.12.0 → 2.12.1, shifted line numbers in events src). - en/packages/events.md: PublishOptions table gains messageId / timestamp. - en/packages/events-amqp.md: AmqpPublisherOptions table gains externalContract; the External AMQP Contract recipe now sets externalContract: true and the clean-wire note is corrected — correlationHeader: false alone leaves the envelope headers on the wire. VitePress build passes (no dead links). Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
intech
force-pushed
the
docs/api-and-pages-1.1.0
branch
from
71bd7d2 to
7beb5ca
Compare
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.
What
Bring the docs site current with the 1.1.0 APIs — the narrative package pages and the generated API reference.
docs(api)— regenerate the API reference (the "api generators"): TypeDoc against the current source. Adds the new 1.1.0 pages —createCatalogClient(+CatalogClient/CreateCatalogClientOptions),createInternalAuthInterceptor/meshIdentityTrust/signedTokenTrust/sharedSecretTrust/getInternalMethods, the@connectum/auth/testingRS256 helpers,createBroadcastSubscribers(+BroadcastReactor/BroadcastSubscribersOptions) — and updatesEventBusOptions(nowpublishes+strictTopics). Kept to the 24 new + 18 content-updated pages: the ~319 files whose only diff was the regeneration source-link revision were reverted, so this is the real API delta, not regen noise.docs(packages)— narrative pages forauth/core/events, mirroring the package READMEs. Every new API is adversarially verified against the real exports and marked "since 1.1.0"; the internal-auth section links ADR-029.Verification
Notes
🤖 Generated with Claude Code
https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3