docs(configuration): add Configuration section to reference.md (#351) - #847
Open
oaksprout wants to merge 1 commit into
Open
docs(configuration): add Configuration section to reference.md (#351)#847oaksprout wants to merge 1 commit into
oaksprout wants to merge 1 commit into
Conversation
Add a Configuration section to documentation/reference.md documenting client.configuration.get() and the subscribe/subscribeWithKeys/ subscribeWithMetadata methods, matching the style of the existing Service Invocation section. Notes that the Configuration API is gRPC-only (the HTTP client throws HTTPNotSupportedError), matching src/implementation/Client/HTTPClient/configuration.ts. Closes dapr#351 Signed-off-by: Oaksprout <oaksproutthetan@gmail.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.
You set the work. #351: the Configuration building block (
subscribeConfigurationet al.) shipped long ago, butdocumentation/reference.mdhas no Configuration section.It's done. A
## Configurationsection documentingget,subscribe(plain, with-keys, with-metadata), and unsubscription viastream.stop()— mirroring the structure of the one section that has real content (Service Invocation). Every snippet is based on the workingexamples/configuration/code and was compile-checked against the real exports (tsc --noEmit, strict, zero errors). One caveat surfaced and documented: the Configuration API is gRPC-only — the HTTP client throwsHTTPNotSupportedErrorfor all four methods, which is broader than the issue implied.Here's the evidence.
f7800662, patch applied,npm install && npm run build, then the network was disconnected.node:22-bookwormcontainer: all 10 suite groups pass.Audit trail — an independently checkable record that these checks ran, in this order, before this PR existed
f78006628ea259d16173a78184b929292f1d612fnode:22-bookworm@sha256:5647be70…(linux/arm64), network off during testsWhat this proves: the checks ran, in that order, on exactly this patch, before this PR was opened — none of it can be backdated or swapped afterwards. What it doesn't prove: that the docs are right in every nuance. The two signing keys are distinct but run by the same project, and the record lives on a test network. Correctness is your judgement, which is the point.
Written by an AI agent; reviewed and sent by a human who answers the review, signed off per the DCO. We're testing whether work checked this way is useful to maintainers — blunt feedback welcome, including "don't".
Everything below is written by Claude
Closes #351.
One file changed:
documentation/reference.md, +30 lines. Structure mirrors Service Invocation (one-line description + link to the matching Dapr API doc, then###subsections with short TypeScript snippets); the other section headers (State Management, Pub/Sub, Bindings, Actors, Secrets) are empty stubs since 2021 and were left untouched.Notes for the reviewer
examples/configuration/, the Redis metadata caveat from the e2e comments), happy to extend.documentation/examples.mdalso lacks a Configuration entry — a second, separate gap left alone here; can follow up.