From bd8628ffe7a27de92c9b81dc54ff2be591471967 Mon Sep 17 00:00:00 2001 From: Christopher Jr Riley Date: Sat, 21 Dec 2024 22:27:07 -0500 Subject: [PATCH] Fix broken links in DocC --- .../SessionManager/ATProtocolConfiguration.swift | 13 +++++++------ .../ATProtoKit.docc/Misc/0210AuthFlowChange.md | 6 +++--- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/Sources/ATProtoKit/APIReference/SessionManager/ATProtocolConfiguration.swift b/Sources/ATProtoKit/APIReference/SessionManager/ATProtocolConfiguration.swift index 81593a8e2f..de17886eee 100644 --- a/Sources/ATProtoKit/APIReference/SessionManager/ATProtocolConfiguration.swift +++ b/Sources/ATProtoKit/APIReference/SessionManager/ATProtocolConfiguration.swift @@ -101,9 +101,9 @@ public class ATProtocolConfiguration: SessionConfiguration { /// /// - Important: ``ATProtocolConfiguration/authenticate(authenticationFactorToken:)``, /// ``ATProtocolConfiguration/createAccount(email:handle:existingDID:inviteCode:verificationCode:verificationPhone:password:recoveryKey:plcOperation:)``, - /// ``ATProtocolConfiguration/deleteSession()``, - /// ``ATProtocolConfiguration/getSession(by:)``, and - /// ``ATProtocolConfiguration/deleteSession()`` will not work when initializing + /// ``ATProtocolConfiguration/getSession(by:authenticationFactorToken:)``, + /// ``ATProtocolConfiguration/refreshSession(by:authenticationFactorToken:)``and + /// ``ATProtocolConfiguration/deleteSession(with:)`` will not work when initializing /// ATProtocolConfiguration with this initializer. /// /// - Parameters: @@ -305,9 +305,10 @@ public class ATProtocolConfiguration: SessionConfiguration { /// If the access token is invalid, then a new one will be created, either by refeshing a /// session, or by re-authenticating. /// - /// - Parameter accessToken: The access token used for the session. Optional. - /// Defaults to `nil`. - /// + /// - Parameters: + /// - accessToken: The access token used for the session. Optional. + /// Defaults to `nil`. + /// - authenticationFactorToken: A token used for Two-Factor Authentication. Optional. /// - Returns: Information of the user account's current session straight from the service. /// - Throws: An ``ATProtoError``-conforming error type, depending on the issue. Go to /// ``ATAPIError`` and ``ATRequestPrepareError`` for more details. diff --git a/Sources/ATProtoKit/ATProtoKit.docc/Misc/0210AuthFlowChange.md b/Sources/ATProtoKit/ATProtoKit.docc/Misc/0210AuthFlowChange.md index 504d39a5af..c309688302 100644 --- a/Sources/ATProtoKit/ATProtoKit.docc/Misc/0210AuthFlowChange.md +++ b/Sources/ATProtoKit/ATProtoKit.docc/Misc/0210AuthFlowChange.md @@ -56,9 +56,9 @@ Here are the changes being made: `ATProtoKit` method|Proxy Method ---:|:--- ``ATProtoKit/ATProtoKit/createSession(with:and:authenticationFactorToken:pdsURL:)``|``ATProtocolConfiguration/authenticate(authenticationFactorToken:)`` -``ATProtoKit/ATProtoKit/getSession(by:pdsURL:)``|``ATProtocolConfiguration/getSession(by:)`` -``ATProtoKit/ATProtoKit/refreshSession(refreshToken:pdsURL:)``| ``ATProtocolConfiguration/refreshSession(by:)`` -``ATProtoKit/ATProtoKit/deleteSession(refreshToken:pdsURL:)``|``ATProtocolConfiguration/deleteSession()`` +``ATProtoKit/ATProtoKit/getSession(by:pdsURL:)``|``ATProtocolConfiguration/getSession(by:authenticationFactorToken:)`` +``ATProtoKit/ATProtoKit/refreshSession(refreshToken:pdsURL:)``| ``ATProtocolConfiguration/refreshSession(by:authenticationFactorToken:)`` +``ATProtoKit/ATProtoKit/deleteSession(refreshToken:pdsURL:)``|``ATProtocolConfiguration/deleteSession(with:)`` ``ATProtoKit/ATProtoKit/createAccount(email:handle:existingDID:inviteCode:verificationCode:verificationPhone:password:recoveryKey:plcOperation:pdsURL:)``| ``ATProtocolConfiguration/createAccount(email:handle:existingDID:inviteCode:verificationCode:verificationPhone:password:recoveryKey:plcOperation:)``