docs: comprehensive documentation refresh with overlay --dry-run flag #274
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
- Implement --dry-run/-n flag for overlay apply CLI command, calling existing DryRunWithOptions() library API with formatted output - Fix whitepaper accuracy: version bump to v1.46.2, ParseResult struct (methods not fields), add golang.org/x/text dependency, add OperationContext field to ValidationError, new v1.46.x feature sections - Enhance walker/doc.go with Built-in Collectors section (CollectSchemas, CollectOperations) - Enhance httpvalidator/doc.go with Path Matching and Response Validation sections - Add converter example tests: Example_convertParsed, Example_upgradeOAS3 - Complete generator Example_withParsedDocument with real parse→generate workflow - Add httpvalidator examples: ExampleParamDeserializer, ExampleValidator_ValidateRequest_strictMode - Fix cli-reference.md overlay section: correct syntax (positional arg), add -n short flag, update output format to match implementation - Add copy_if_exists guard to prepare-docs.sh, add GitHub link transforms - Add edit_uri: "" to mkdocs.yml to disable broken edit links - Add CLI dry-run note to overlay deep_dive best practices Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #274 +/- ##
==========================================
+ Coverage 84.83% 84.91% +0.07%
==========================================
Files 156 156
Lines 24574 24574
==========================================
+ Hits 20848 20866 +18
+ Misses 2524 2509 -15
+ Partials 1202 1199 -3 🚀 New features to boost your workflow:
|
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
Comprehensive documentation refresh addressing issues identified across the entire docs surface area — whitepaper, godoc, example tests, CLI reference, published docs, and build pipeline.
New Feature
overlay apply --dry-run/-nCLI flag — Preview overlay changes without modifying files, calling existingoverlay.DryRunWithOptions()library APIDocumentation Fixes
docs/whitepaper.md): Version bump to v1.46.2, fixedParseResultstruct documentation (methods not fields), addedgolang.org/x/textdependency, addedOperationContextfield toValidationError, new sections for v1.46.x features (operation context,FixTypeStubMissingRefs, empty schema preservation)walker/doc.go: Added Built-in Collectors section documentingSchemaCollector,OperationCollector,CollectSchemas(),CollectOperations()with correct field names (ByName,All,PathTemplate,Operation.OperationID)httpvalidator/doc.go: Added Path Matching section with correct API signatures (NewPathMatcherSet([]string)→(template, params, found)), Response Validation sectionvalidator/doc.go: Enhanced Operation Context section with code exampleREADME.md: Fixed overlay apply flag ordering (flags before positional arg), added--dry-runexampleNew Example Tests
converter/example_test.go:Example_convertParsed(pre-parsed workflow),Example_upgradeOAS3(3.0→3.1)generator/example_test.go:Example_withParsedDocument(completed placeholder with real parse→generate)httpvalidator/example_test.go:ExampleParamDeserializer(matrix/pipe/header styles),ExampleValidator_ValidateRequest_strictModeCLI & Published Docs
docs/cli-reference.md: Fixed overlay section — removed ghost--overlayflag, added-nshort flag, updated usage/output formatoverlay/deep_dive.md: Added CLI dry-run to best practices sectionBuild Pipeline
scripts/prepare-docs.sh: Addedcopy_if_exists()helper, guardedfix_example_links/fix_subdir_linkswith[ -f ] || return 0, added GitHub absolute link transforms for docs sitemkdocs.yml: Addededit_uri: ""to prevent broken "Edit this page" linksBug Fixes
handleOverlayDryRunnow respects--quietflag (was unconditionally writing diagnostics)flagpackage behaviorTest plan
go test -run Example ./...— all example tests passgo_diagnosticson all modified Go files — no diagnosticsmake check— 7912 tests pass, 0 failures./scripts/prepare-docs.sh— builds without warningsgo run ./cmd/oastools/ overlay apply --dry-run -s testdata/overlay/fixtures/petstore-base.yaml testdata/overlay/fixtures/petstore-overlay.yaml— produces expected output--quietsuppresses dry-run output🤖 Generated with Claude Code