Skip to content

Commit 3271584

Browse files
committed
Fix docs
1 parent 8bf647d commit 3271584

File tree

8 files changed

+11
-13
lines changed

8 files changed

+11
-13
lines changed

Diff for: Package.swift

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ let package = Package(
66
name: "swift-aws-lambda-runtime",
77
platforms: [.macOS(.v15)],
88
products: [
9-
// this library exports `AWSLambdaRuntimeCore` and adds Foundation convenience methods
109
.library(name: "AWSLambdaRuntime", targets: ["AWSLambdaRuntime"]),
1110
// plugin to package the lambda, creating an archive that can be uploaded to AWS
1211
// requires Linux or at least macOS v15

Diff for: [email protected]

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ let package = Package(
66
name: "swift-aws-lambda-runtime",
77
platforms: [.macOS(.v15)],
88
products: [
9-
// this library exports `AWSLambdaRuntimeCore` and adds Foundation convenience methods
109
.library(name: "AWSLambdaRuntime", targets: ["AWSLambdaRuntime"]),
1110
// plugin to package the lambda, creating an archive that can be uploaded to AWS
1211
// requires Linux or at least macOS v15

Diff for: Sources/AWSLambdaRuntime/Docs.docc/Documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ``AWSLambdaRuntimeCore``
1+
# ``AWSLambdaRuntime``
22

33
An AWS Lambda runtime for the Swift programming language
44

Diff for: Sources/AWSLambdaRuntime/Docs.docc/Proposals/0001-v2-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Server ecosystem is to shift to newer, more readable, Swift concurrency construc
4040
#### No ownership of the main() function
4141

4242
A Lambda function can currently be implemented through conformance to the various handler protocols defined in
43-
`AWSLambdaRuntimeCore/LambdaHandler`. Each of these protocols have an extension which implements a `static func main()`.
43+
``AWSLambdaRuntime/LambdaHandler``. Each of these protocols have an extension which implements a `static func main()`.
4444
This allows users to annotate their `LambdaHandler` conforming object with `@main`. The `static func main()` calls the
4545
internal `Lambda.run()` function, which starts the Lambda function. Since the `Lambda.run()` method is internal, users
4646
cannot override the default implementation. This has proven challenging for users who want to
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
2025-01-02T14:59:29+0100 info LocalLambdaServer : [AWSLambdaRuntimeCore]
1+
2025-01-02T14:59:29+0100 info LocalLambdaServer : [AWSLambdaRuntime]
22
LocalLambdaServer started and listening on 127.0.0.1:7000, receiving events on /invoke

Diff for: Sources/AWSLambdaRuntime/Docs.docc/Resources/code/03-04-07-terminal.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ swift run
33
Building for debugging...
44
[1/1] Write swift-version--58304C5D6DBC2206.txt
55
Build of product 'PalindromeLambda' complete! (0.11s)
6-
2025-01-02T15:12:49+0100 info LocalLambdaServer : [AWSLambdaRuntimeCore] LocalLambdaServer started and listening on 127.0.0.1:7000, receiving events on /invoke
6+
2025-01-02T15:12:49+0100 info LocalLambdaServer : [AWSLambdaRuntime] LocalLambdaServer started and listening on 127.0.0.1:7000, receiving events on /invoke

Diff for: Sources/AWSLambdaRuntime/Docs.docc/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,6 @@ Swift provides great Unicode support via [ICU](http://site.icu-project.org/home)
339339

340340
<!-- links -->
341341

342-
[lh]: ./AWSLambdaRuntimeCore/Protocols/LambdaHandler.html
343-
[ellh]: ./AWSLambdaRuntimeCore/Protocols/EventLoopLambdaHandler.html
344-
[bblh]: ./AWSLambdaRuntimeCore/Protocols/ByteBufferLambdaHandler.html
342+
[lh]: ./AWSLambdaRuntime/Protocols/LambdaHandler.html
343+
[ellh]: ./AWSLambdaRuntime/Protocols/EventLoopLambdaHandler.html
344+
[bblh]: ./AWSLambdaRuntime/Protocols/ByteBufferLambdaHandler.html

Diff for: readme.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Swift AWS Lambda Runtime was designed to make building Lambda functions in Swift
3939

4040
To get started, read [the Swift AWS Lambda runtime tutorial](https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime/main/tutorials/table-of-content). It provides developers with detailed step-by-step instructions to develop, build, and deploy a Lambda function.
4141

42-
We also wrote a comprehensive [deployment guide](https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime/main/documentation/awslambdaruntimecore/deployment).
42+
We also wrote a comprehensive [deployment guide](https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime/main/documentation/awslambdaruntime/deployment).
4343

4444
Or, if you're impatient to start with runtime v2, try these six steps:
4545

@@ -379,7 +379,7 @@ LOCAL_LAMBDA_SERVER_INVOCATION_ENDPOINT=/2015-03-31/functions/function/invocatio
379379

380380
## Deploying your Swift Lambda functions
381381

382-
There is a full deployment guide available in [the documentation](https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime/main/documentation/awslambdaruntimecore/deployment).
382+
There is a full deployment guide available in [the documentation](https://swiftpackageindex.com/swift-server/swift-aws-lambda-runtime/main/documentation/awslambdaruntime/deployment).
383383

384384
There are multiple ways to deploy your Swift code to AWS Lambda. The very first time, you'll probably use the AWS Console to create a new Lambda function and upload your code as a zip file. However, as you iterate on your code, you'll want to automate the deployment process.
385385

@@ -421,9 +421,9 @@ Please refer to the full deployment guide available in [the documentation](https
421421

422422
## Swift AWS Lambda Runtime - Design Principles
423423

424-
The [design document](Sources/AWSLambdaRuntimeCore/Documentation.docc/Proposals/0001-v2-api.md) details the v2 API proposal for the swift-aws-lambda-runtime library, which aims to enhance the developer experience for building serverless functions in Swift.
424+
The [design document](Sources/AWSLambdaRuntime/Documentation.docc/Proposals/0001-v2-api.md) details the v2 API proposal for the swift-aws-lambda-runtime library, which aims to enhance the developer experience for building serverless functions in Swift.
425425

426-
The proposal has been reviewed and [incorporated feedback from the community](https://forums.swift.org/t/aws-lambda-v2-api-proposal/73819). The full v2 API design document is available [in this repository](Sources/AWSLambdaRuntimeCore/Documentation.docc/Proposals/0001-v2-api.md).
426+
The proposal has been reviewed and [incorporated feedback from the community](https://forums.swift.org/t/aws-lambda-v2-api-proposal/73819). The full v2 API design document is available [in this repository](Sources/AWSLambdaRuntime/Documentation.docc/Proposals/0001-v2-api.md).
427427

428428
### Key Design Principles
429429

0 commit comments

Comments
 (0)