aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

Swift: Update SDK reference links

Open shepazon opened this issue 1 year ago • 0 comments

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):

  • https://sdk.amazonaws.com/swift/api/awss3/0.33.0
  • https://sdk.amazonaws.com/swift/api/awss3/0.33.0/documentation/awss3

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

  • https://sdk.amazonaws.com/swift/api/awss3/latest/documentation/awss3/s3client

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

  • https://sdk.amazonaws.com/swift/api/awss3/0.33.0/documentation/awss3/s3client/listpartspaginated(input:)

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

  • https://sdk.amazonaws.com/swift/api/awss3/0.33.0/documentation/awss3/listpartsinput

shepazon avatar Jan 05 '24 17:01 shepazon