Postman collection builder #582
Open
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
Documentation Preview LinksPreview for commit: 086346c |
…collection-builder [BOT] PR to postman-collection-builder. Lints file structure, file contents, gets author data, Updates Komodo DeFi Framework Methods Table, adds/updates preview images
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a Postman collection builder that generates API method collections from JSON component sources (request examples and table JSON bodies). It also includes infrastructure updates, documentation improvements, and several bug fixes across the codebase.
Key Changes
- Added Postman collection generation infrastructure with Docker support for KDF and response processing
- Migrated multiple API documentation pages to use JSON-based request/response sources instead of hardcoded examples
- Updated Python utilities for better slug handling and API method table generation
- Enhanced JSON schema to support substructure references and context tags
Reviewed Changes
Copilot reviewed 77 out of 101 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| utils/py/batch_update_nodes.py | Changed logging level from DEBUG to INFO for verbose mode |
| utils/py/README_update_nodes.md | Removed entire node update script documentation |
| utils/js/cleanup_bad_sidebar_wallet_links.js | Added script to remove malformed wallet links from sidebar |
| utils/js/auto_add_missing_sidebar_wallet_links.js | Added script to auto-populate missing wallet links in sidebar |
| utils/gen_api_methods_table.py | Enhanced slug generation with fallback computation and persistence |
| utils/docker/Dockerfile.processor | Added Docker image for response processing |
| utils/docker/Dockerfile.kdf_native | Added multi-stage Docker build for KDF |
| utils/_changeLogVersions.json | Updated KDF version to v2.5.2-beta |
| src/pages/komodo-defi-framework/changelog/index.mdx | Added changelog entry for v2.5.2-beta release |
| src/pages/komodo-defi-framework/api/v20/wallet/* | Migrated multiple wallet API pages to JSON-based sources |
| src/pages/komodo-defi-framework/api/legacy/* | Migrated legacy API pages to CompactTable/KdfResponses components |
| src/data/tables/v2/wallet.json | Added comprehensive wallet API table definitions |
| src/data/tables/v2/utils.json | Reorganized utility API table definitions |
| src/data/tables/v2/streaming.json | Reorganized streaming API table definitions with substructure references |
| src/data/tables/legacy/utils.json | Added legacy utility API table definitions |
| src/data/schemas/compact-table.schema.json | Extended schema to support substructure and context fields |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/pages/komodo-defi-framework/api/v20/wallet/consolidate_utxos/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/komodo-defi-framework/api/v20/wallet/consolidate_utxos/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/komodo-defi-framework/api/v20/wallet/fetch_utxos/index.mdx
Outdated
Show resolved
Hide resolved
src/pages/komodo-defi-framework/api/v20/coin_activation/task_managed/enable_eth/index.mdx
Outdated
Show resolved
Hide resolved
…os/index.mdx Co-authored-by: Copilot <[email protected]>
…ex.mdx Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Componentize legacy KDF methods; split reports; SIA activation
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.
Generates a postman collection from json component sources from method request examples and table json bodies.
Outputs reports to indicate where components are missing to help with backfill.
This PR contains only a limited set of examples for "proof of concept". Coverage will be expanded once the foundations are merged into dev branch, to avoid excessively large PRs weighing down the concrete while it's still wet.
Part B to this PR (will be handled in a separate branch) is response retrieval / validation.
Example output in Postman: