Skip to content

fix: Fix service name rendered on API reference docs #889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sichanyoo merged 1 commit into from
Jan 6, 2025
Merged

fix: Fix service name rendered on API reference docs #889

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions ...hy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/ServiceGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ class ServiceGenerator() {
* Renders the definition of operation, followed by no CR
*/
fun renderOperationDefinition(
serviceName: String,
model: Model,
service: ServiceShape,
symbolProvider: SymbolProvider,
Expand All @@ -42,7 +43,7 @@ class ServiceGenerator() {
val outputShape = opIndex.getOutput(op).get()
val outputShapeName = symbolProvider.toSymbol(outputShape).name

renderOperationDoc(model, service, op, writer)
renderOperationDoc(serviceName, model, service, op, writer)

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

Expand All @@ -58,8 +59,14 @@ class ServiceGenerator() {
/**
* Helper method for generating in-line documentation for operation
*/
private fun renderOperationDoc(model: Model, service: ServiceShape, op: OperationShape, writer: SwiftWriter) {
writer.writeDocs("Performs the \\`${op.id.name}\\` operation on the \\`${service.id.name}\\` service.")
private fun renderOperationDoc(
serviceName: String,
model: Model,
service: ServiceShape,
op: OperationShape,
writer: SwiftWriter
) {
writer.writeDocs("Performs the \\`${op.id.name}\\` operation on the \\`${serviceName}\\` service.")
writer.writeDocs("")
writer.writeShapeDocs(op)
writer.writeAvailableAttribute(model, op)
Expand Down
4 changes: 3 additions & 1 deletion ...in/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolClientGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import software.amazon.smithy.swift.codegen.middleware.MiddlewareExecutionGenera
import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
import software.amazon.smithy.swift.codegen.swiftmodules.SmithyTypes
import software.amazon.smithy.swift.codegen.utils.toUpperCamelCase

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

writer.openBlock("extension \$L {", "}", serviceSymbol.name) {
operations.forEach {
ServiceGenerator.renderOperationDefinition(model, serviceShape, symbolProvider, writer, operationsIndex, it)
val serviceName = ctx.settings.sdkId.toUpperCamelCase()
ServiceGenerator.renderOperationDefinition(serviceName, model, serviceShape, symbolProvider, writer, operationsIndex, it)
writer.openBlock(" {", "}") {
val operationStackName = "operation"
val generator = MiddlewareExecutionGenerator(ctx, writer, httpBindingResolver, httpProtocolCustomizable, operationMiddleware, operationStackName)
Expand Down
Loading