feat(spec-doc-sync): add review-gated OpenAPI doc updates - #128
Open
ashish921998 wants to merge 2 commits into
Open
feat(spec-doc-sync): add review-gated OpenAPI doc updates#128ashish921998 wants to merge 2 commits into
ashish921998 wants to merge 2 commits into
Conversation
Provide conservative spec diffing, no-spend preview, exhaustive rename proof, byte-identity verification, SuperDocs async approval/export integration, fixtures, and offline tests.
Document and automate the reviewed SuperDocs round-trip without persisting or printing the API key.
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.
Description
Ashish Huddar built Spec Doc Sync for the SuperDocs hiring task. It compares two OpenAPI snapshots, conservatively classifies changes, searches every Markdown reference page, and creates item-level edit proposals. Approved intents can run through the documented SuperDocs async review and export flow; uncertain cases escalate instead of being guessed.
The committed fixture proves exhaustive rename updates, byte-identical untouched pages, a no-spend preview, and a stopping rule that prevents generated output from retriggering the loop.
Related Issue
No issue - SuperDocs hiring-round assigned build.
Potential Risk & Impact
use-cases/ashish921998/spec-doc-sync/.How Has This Been Tested?
make test- 6 offline behavioral tests passed.make demo- 4 changes, 5 proposals, 2/2 rename references updated, unrelated page byte-identical, second invocation stopped.customer_idrenamed toaccount_id, and a 36,683-byte DOCX exported and visually inspected.