Skip to content

Commit

Permalink
temp: update readme except client plugin output and config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Steven Yuan committed Nov 2, 2023
1 parent 6a41e77 commit 0086542
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,17 +195,17 @@ TODO How to package the resulting client in a way that is useful for downstream

|Setting|Required|Description|
|---|---|---|
|package|Yes|TODO|
|packageVersion|Yes|TODO|
|packageDescription|No|TODO|
|packageJson|No|TODO|
|packageManager|No|TODO|
|service|No|TODO The Shape ID of the service to generate a client for. If not provided, the code generator will attempt to infer the service Shape ID. If there is exactly 1 service found in the model, then the service is used as the inferred Shape ID. If no services are found, then code generation fails. If more than 1 service is found, then code generation fails.|
|protocol|No|TODO|
|private|No|TODO|
|requiredMemberMode|No|TODO|
|createDefaultReadme|No|TODO|
|experimentalIdentityAndAuth|No|TODO|
|`package`|Yes|Name of the package in `package.json`.|
|`packageVersion`|Yes|Version of the package in `package.json`.|
|`packageDescription`|No|Description of the package in `package.json`. The default value is `${package} client`|
|`packageJson`|No|Custom `package.json` properties that will be merged with the base `package.json`. The default value is an empty object.|
|`packageManager`|No|Configured package manager for the package. The default value is `yarn`.|
|`service`|No|The Shape ID of the service to generate a client for. If not provided, the code generator will attempt to infer the service Shape ID. If there is exactly 1 service found in the model, then the service is used as the inferred Shape ID. If no services are found, then code generation fails. If more than 1 service is found, then code generation fails.|
|`protocol`|No|TODO|
|`private`|No|TODO|
|`requiredMemberMode`|No|TODO|
|`createDefaultReadme`|No|TODO|
|`experimentalIdentityAndAuth`|No|TODO|

### Server SDK code generation: `typescript-server-codegen` plugin

Expand All @@ -217,17 +217,17 @@ For documentation of `typescript-server-codegen` artifacts and implementation, s

|Setting|Required|Description|
|---|---|---|
|package|Yes|TODO|
|packageVersion|Yes|TODO|
|packageDescription|No|TODO|
|packageJson|No|TODO|
|packageManager|No|TODO|
|service|No|TODO The Shape ID of the service to generate a client for. If not provided, the code generator will attempt to infer the service Shape ID. If there is exactly 1 service found in the model, then the service is used as the inferred Shape ID. If no services are found, then code generation fails. If more than 1 service is found, then code generation fails.|
|protocol|No|TODO|
|private|No|TODO|
|requiredMemberMode|No|TODO|
|disableDefaultValidation|No|TODO|
|createDefaultReadme|No|TODO|
|`package`|Yes|Name of the package in `package.json`.|
|`packageVersion`|Yes|Version of the package in `package.json`.|
|`packageDescription`|No|Description of the package in `package.json`. The default value is `${package} server`.|
|`packageJson`|No|Custom `package.json`properties that will be merged with the base `package.json`. The default value is an empty object.|
|`packageManager`|No|Configured package manager for the package. The default value is `yarn`.|
|`service`|No|The Shape ID of the service to generate a client for. If not provided, the code generator will attempt to infer the service Shape ID. If there is exactly 1 service found in the model, then the service is used as the inferred Shape ID. If no services are found, then code generation fails. If more than 1 service is found, then code generation fails.|
|`protocol`|No|TODO|
|`private`|No|TODO|
|`requiredMemberMode`|No|TODO|
|`disableDefaultValidation`|No|TODO|
|`createDefaultReadme`|No|TODO|

### Adding customizations to Smithy TypeScript

Expand Down

0 comments on commit 0086542

Please sign in to comment.