docs: update help text and docs for all gateway target types#524
Merged
Conversation
64fd4df to
433daef
Compare
tejaskash
requested changes
Mar 9, 2026
- Fix --type help to list all 5 types: mcp-server, api-gateway, open-api-schema, smithy-model, lambda-function-arn - Update commands.md: add examples and flags for all target types - Update gateway.md: add subsections for each target type with auth notes
433daef to
5f5b340
Compare
tejaskash
approved these changes
Mar 9, 2026
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
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
Update CLI help text and documentation to cover all 5 gateway target types that are now supported:
mcp-server— external MCP server endpointsapi-gateway— existing Amazon API Gateway REST APIsopen-api-schema— auto-derive tools from OpenAPI JSON specssmithy-model— auto-derive tools from Smithy JSON modelslambda-function-arn— connect to existing Lambda functions by ARNChanges:
--typehelp text inGatewayTargetPrimitive.tsto list all 5 types (was missingopen-api-schemaandsmithy-model)docs/commands.md: add CLI examples for all target types, complete flags table (22 flags) with per-type applicability notes, auth compatibility notedocs/gateway.md: add subsections for each target type with CLI examples, auth support notes, and path resolution details. Update outbound auth table with "Supported Target Types" column including IAM role row.Related Issue
Type of Change
Testing
How have you tested the change?
npm run test:unitandnpm run test:integnpm run typechecknpm run lintsrc/assets/, I rannpm run test:update-snapshotsand committed the updated snapshotsChecklist