New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Core logic that ingests API spec + documentation and validates the tutorials #4

Open

sumanyu opened this issue Nov 16, 2023 · 0 comments

Member

sumanyu commented Nov 16, 2023

Inputs

API spec: Swagger [JSON structure that we ingest]
Maybe we accept both V1 and V2 (?)
Docs: URL that has docs or maybe the entire map for docs.somedomain.com

Output

Spit out sections in the doc that seem out of sync w/ the API spec listed
Parts of the APIs that are not being captured in tutorials

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment