docs: complete the API-summary table (verificationTimeMs, NtsClient, full enums)#157
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the public-facing README API summary to document the optional verificationTimeMs parameter for ntsQuery and ntsWarmCookies, aligning the README with the actual Dart wrapper signatures in lib/src/api/nts.dart.
Changes:
- Added
verificationTimeMsto the README “API summary” table rows forntsQueryandntsWarmCookieswith a brief description of its clock-skew-rescue behavior. - Updated the README paragraph that lists optional parameters to include
verificationTimeMs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nick-llewellyn
changed the title
3 tasks
The optional verificationTimeMs parameter was present in both ntsQuery and ntsWarmCookies since it was introduced but was missing from the API-summary table in README.md (and the descriptive paragraph listing which parameters can be omitted). Add it to both rows with a one-line description of its clock-skew-rescue semantics, and update the paragraph to name all three optional parameters.
…Backend/NtsTrustStatus) Audit of the API-summary table against lib/src/api/ found four under-described symbols: - NtsClient was absent from the table entirely (documented only in prose); add a row covering the constructor, query/warmCookies, invalidate/clear, and the trustMode getter. - TrustMode listed only platformWithFallback and platformOnly; add bundledOnly and custom. - TrustBackend listed only platform/platformWithHybridFallback/ webpkiRoots; add custom. - NtsTrustStatus listed only 3 of its 7 fields; add the four defaultBackend*Count cumulative counters.
nick-llewellyn
force-pushed
the
docs/NTS-37-readme-verificationtimems
branch
from
e5a1b3e to
cc70ace
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
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
A documentation audit of the public API surface against
lib/src/api/found the README "API summary" table was missing or under-describing
several public symbols. This PR brings the table back in line with the
source.
Changes
verificationTimeMsadded to thentsQuery/ntsWarmCookiesrows (the parameter exists on both but was absent from the table),
plus the paragraph listing omittable optional parameters.
NtsClientadded as its own row — it was documented only in proseand had no table entry. Covers the constructor,
query/warmCookies,invalidate/clear, and thetrustModegetter.TrustModerow completed:bundledOnlyandcustomwere missing(only
platformWithFallback/platformOnlywere listed).TrustBackendrow completed:customwas missing.NtsTrustStatusrow completed: the fourdefaultBackend*Countcumulative counters were missing (only 3 of 7 fields were listed).
Scope
Documentation only — no code changes, no signature changes. The dartdoc
already documents all of the above; this only fixes the README summary
table. (A separate PR fixes one source-dartdoc count bug in
ntsTrustStatus()that affects the generated DartDocs.)Checklist
lib/src/api/nts.dartandlib/src/api/models.dart