Address maintenance issues and documentation inconsistencies in the O…#688
Open
sethoshi18 wants to merge 2 commits into
Open
Address maintenance issues and documentation inconsistencies in the O…#688sethoshi18 wants to merge 2 commits into
sethoshi18 wants to merge 2 commits into
Conversation
…penAPI generator and SDK docs. Summary of changes: - Removed stray debug console logs from `scripts/openapi-gen/utils/parser.ts`. - Improved error handling in `scripts/openapi-gen/openapi-gen.ts` to ensure non-zero exit codes on failures. - Fixed an incorrect package manager command in `sdks/advanced/api-key-stamper.mdx`. - Improved documentation and generalized hardcoded overrides in `scripts/openapi-gen/utils/mdx-generator/generator.ts`. - Added a note with links to standard error documentation in generated activity reference MDX files. - Regenerated all API reference documentation to reflect these improvements. - Verified that no accidental log files (like `mintlify.log`) are included in the PR.
… test coverage. This comprehensive update addresses multiple high-impact improvements: - established unit test coverage for core generator logic (string-utils and version matching). - Improved build reliability by ensuring the OpenAPI generator exits with a non-zero code on failures. - Cleaned up generator code by removing stray debug logs and documenting internal overrides. - Fixed documentation inconsistencies, specifically correcting package manager command labels. - Enhanced generated API reference by adding automated links to standard error documentation for all activity endpoints. - Regenerated API reference documentation to reflect these improvements.
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.
…penAPI generator and SDK docs.
Summary of changes:
scripts/openapi-gen/utils/parser.ts.scripts/openapi-gen/openapi-gen.tsto ensure non-zero exit codes on failures.sdks/advanced/api-key-stamper.mdx.scripts/openapi-gen/utils/mdx-generator/generator.ts.mintlify.log) are included in the PR.