Skip to content

docs: update help text and docs for all gateway target types#524

Merged
tejaskash merged 1 commit into
aws:mainfrom
aidandaly24:feat/gateway-docs
Mar 9, 2026
Merged

docs: update help text and docs for all gateway target types#524
tejaskash merged 1 commit into
aws:mainfrom
aidandaly24:feat/gateway-docs

Conversation

@aidandaly24

Copy link
Copy Markdown
Contributor

Description

Update CLI help text and documentation to cover all 5 gateway target types that are now supported:

  • mcp-server — external MCP server endpoints
  • api-gateway — existing Amazon API Gateway REST APIs
  • open-api-schema — auto-derive tools from OpenAPI JSON specs
  • smithy-model — auto-derive tools from Smithy JSON models
  • lambda-function-arn — connect to existing Lambda functions by ARN

Changes:

  • Fix --type help text in GatewayTargetPrimitive.ts to list all 5 types (was missing open-api-schema and smithy-model)
  • Update docs/commands.md: add CLI examples for all target types, complete flags table (22 flags) with per-type applicability notes, auth compatibility note
  • Update docs/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

  • Documentation update

Testing

How have you tested the change?

  • I ran npm run test:unit and npm run test:integ
  • I ran npm run typecheck
  • I ran npm run lint
  • If I modified src/assets/, I ran npm run test:update-snapshots and committed the updated snapshots

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

@aidandaly24 aidandaly24 requested a review from a team March 9, 2026 20:45
@github-actions github-actions Bot added the size/m PR size: M label Mar 9, 2026
@github-actions github-actions Bot added size/m PR size: M and removed size/m PR size: M labels Mar 9, 2026

@tejaskash tejaskash left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes

Comment thread docs/gateway.md Outdated
Comment thread docs/commands.md Outdated
Comment thread docs/commands.md Outdated
- 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
@github-actions github-actions Bot added size/m PR size: M and removed size/m PR size: M labels Mar 9, 2026
@tejaskash tejaskash merged commit a282d65 into aws:main Mar 9, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants