Add initial docs for TypeScript SSDK #1119
Conversation
adamthom-amzn
force-pushed
the
ssdk-docs
branch
from
2042669 to
0ff15a6
Compare
adamthom-amzn
force-pushed
the
ssdk-docs
branch
from
0ff15a6 to
9a22b16
Compare
| @@ -0,0 +1,60 @@ | |||
| ########################################################## | |||
| Introduction to the Smithy Server Generator for TypeScript | |||
There was a problem hiding this comment.
Where should we talk about how to use this codegen, i.e., something like
"plugins": {
"typescript-ssdk-codegen": {
"package": "@aws-smithy/example",
"packageVersion": "1.0.0-alpha.1"
}
Currently this only comes up in validation section for how to disable, but seems like it should come up earlier. Some section on getting started?
There was a problem hiding this comment.
Instead of a quickstart section, I'd rather have an example repository we link to. I don't have that repository yet.
There was a problem hiding this comment.
Sure, example repo will be good
adamthom-amzn
force-pushed
the
ssdk-docs
branch
from
9a22b16 to
bb73813
Compare
Co-authored-by: Chase Coalwell <c.coalwell@gmail.com>
|
|
||
| *Synthetic errors* are errors that are not included in the Smithy model, but can still be thrown by the server SDK. In | ||
| general, these errors are not expected to have corresponding code generated types on the client side. These errors fall | ||
| into two categories: framework-level errors that are unavoidable, and errors that are associated with the low-level |
There was a problem hiding this comment.
The default errors from API Gateway should also have its own category as part of the Synthetic errors. With the difference that the service team will have no control over it (as explained briefly in this issue).
There was a problem hiding this comment.
I think those would need their own section once we come up with a more specific API Gateway solution.
There are always going to be intermediaries (CDNs, caches, reverse proxies, what-have-you) that can return error responses that the server has no control over. While we have some customization options for API Gateway, generated clients should be durable to these failures, and I don't think the proper experience is customers having a modeled type for things like 502 Bad Gateway.
Add initial docs for TypeScript SSDK
Intro
Handlers
Error Handling
Endpoints
Validation
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.