Skip to content

Swift: Update SDK reference links #5876

Open
@shepazon

Description

The Swift SDK's reference has finally been deployed in its new home, now built using DocC. Update all links to the reference to use the following formats:

Syntax

Linking to the latest version of the documentation is shown below. To link to a specific version's documentation, replace latest with the version number (such as 0.33.0). All letters are lower-case.

  • Link to the main page for a particular service:
    https://sdk.amazonaws.com/swift/api/[service-name]/latest/
  • Link to a specific class in a service:
    https://sdk.amazonaws.com/swift/api/[service-name]/latest/documentation/[service-name]/[class-name]
  • Link to a specific function in a class:
    https://sdk.amazonaws.com/swift/api/[service-name]/latest/documentation/[service-name]/[class-name]/[function-name](input:)

Examples

Links to version 0.33.0 of the AWS S3 framework's main page (these both go to the same place):

Link to the main page for the S3Client class in the AWSS3 framework:

Link to version 0.33.0 of the documentation for the S3Client function listPartsPaginated(input:):

Link to version 0.33.0 of the documentation of the ListPartsInput structure:

Metadata

Assignees

Labels

InternalTo help track internal tickets in a single location.SwiftThis issue relates to the AWS SDK for Swift

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions