smithy-lang / smithy-kotlin

Smithy code generator for Kotlin (in development)
Apache License 2.0
76 stars 26 forks source link

feat: generate operation samples #1007

Closed aajtodd closed 7 months ago

aajtodd commented 7 months ago

Issue \

https://github.com/awslabs/aws-sdk-kotlin/issues/239

downstream: https://github.com/awslabs/aws-sdk-kotlin/pull/1143

Description of changes

Notes

  1. Code is output to src/samples directory. Samples are not automatically included by dokka, you have to update the configuration to get them included.
  2. We decided to omit doing anything with the output of the examples trait and to omit error examples. It isn't clear what customer benefit there is to including them and instead decided to focus samples on making a request for the given operation.
  3. This renders using the playground by default which won't actually work, see https://github.com/Kotlin/dokka/issues/3041. We will likely hold off merging this until that is disabled.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

sonarcloud[bot] commented 7 months ago

Quality Gate Passed Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

4 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud