Skip to content

Commit 54fd758

Browse files
sichanyooSichan Yoo
andauthored
Fix service name rendered on API reference docs. (#889)
Co-authored-by: Sichan Yoo <[email protected]>
1 parent 402f091 commit 54fd758

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/ServiceGenerator.kt

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ class ServiceGenerator() {
2424
* Renders the definition of operation, followed by no CR
2525
*/
2626
fun renderOperationDefinition(
27+
serviceName: String,
2728
model: Model,
2829
service: ServiceShape,
2930
symbolProvider: SymbolProvider,
@@ -42,7 +43,7 @@ class ServiceGenerator() {
4243
val outputShape = opIndex.getOutput(op).get()
4344
val outputShapeName = symbolProvider.toSymbol(outputShape).name
4445

45-
renderOperationDoc(model, service, op, writer)
46+
renderOperationDoc(serviceName, model, service, op, writer)
4647

4748
val accessSpecifier = if (insideProtocol) "" else "public "
4849

@@ -58,8 +59,14 @@ class ServiceGenerator() {
5859
/**
5960
* Helper method for generating in-line documentation for operation
6061
*/
61-
private fun renderOperationDoc(model: Model, service: ServiceShape, op: OperationShape, writer: SwiftWriter) {
62-
writer.writeDocs("Performs the \\`${op.id.name}\\` operation on the \\`${service.id.name}\\` service.")
62+
private fun renderOperationDoc(
63+
serviceName: String,
64+
model: Model,
65+
service: ServiceShape,
66+
op: OperationShape,
67+
writer: SwiftWriter
68+
) {
69+
writer.writeDocs("Performs the \\`${op.id.name}\\` operation on the \\`${serviceName}\\` service.")
6370
writer.writeDocs("")
6471
writer.writeShapeDocs(op)
6572
writer.writeAvailableAttribute(model, op)

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolClientGenerator.kt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import software.amazon.smithy.swift.codegen.middleware.MiddlewareExecutionGenera
1414
import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
1515
import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
1616
import software.amazon.smithy.swift.codegen.swiftmodules.SmithyTypes
17+
import software.amazon.smithy.swift.codegen.utils.toUpperCamelCase
1718

1819
/**
1920
* Renders an implementation of a service interface for HTTP protocol
@@ -46,7 +47,8 @@ open class HttpProtocolClientGenerator(
4647

4748
writer.openBlock("extension \$L {", "}", serviceSymbol.name) {
4849
operations.forEach {
49-
ServiceGenerator.renderOperationDefinition(model, serviceShape, symbolProvider, writer, operationsIndex, it)
50+
val serviceName = ctx.settings.sdkId.toUpperCamelCase()
51+
ServiceGenerator.renderOperationDefinition(serviceName, model, serviceShape, symbolProvider, writer, operationsIndex, it)
5052
writer.openBlock(" {", "}") {
5153
val operationStackName = "operation"
5254
val generator = MiddlewareExecutionGenerator(ctx, writer, httpBindingResolver, httpProtocolCustomizable, operationMiddleware, operationStackName)

0 commit comments

Comments
 (0)