From 16ba32c2b18ee3e22ceffcada3357a463d53645e Mon Sep 17 00:00:00 2001 From: Christopher Jr Riley Date: Thu, 25 Apr 2024 18:25:52 -0400 Subject: [PATCH] Update documentation formatting --- .../com.atproto/Admin/AtprotoAdminDefs.swift | 3 +++ .../Moderation/AtprotoModerationCreateReport.swift | 2 ++ .../Moderation/AtprotoModerationDefs.swift | 1 + .../Server/AtprotoServerCheckAccountStatus.swift | 4 ++++ .../Server/AtprotoServerCreateInviteCode.swift | 1 + .../Server/AtprotoServerCreateInviteCodes.swift | 2 ++ .../Server/AtprotoServerDeleteAccount.swift | 1 + .../tools.ozone/Moderation/OzoneModerationDefs.swift | 12 ++++++++++++ 8 files changed, 26 insertions(+) diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Admin/AtprotoAdminDefs.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Admin/AtprotoAdminDefs.swift index 2eec6dde67..2ee2b4961a 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Admin/AtprotoAdminDefs.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Admin/AtprotoAdminDefs.swift @@ -109,6 +109,7 @@ public struct AdminReportViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let subject: RepositoryViewUnion /// The status for the subject of the report. Optional. @@ -116,6 +117,7 @@ public struct AdminReportViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public var subjectStatus: OzoneSubjectStatusView? = nil /// The user who created the report. @@ -192,6 +194,7 @@ public struct AdminAccountView: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public var relatedRecords: [UnknownType]? = nil /// The date and time the user was last indexed. diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationCreateReport.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationCreateReport.swift index 0bb1674479..096804aec0 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationCreateReport.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationCreateReport.swift @@ -28,6 +28,7 @@ public struct ModerationCreateReport: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let subject: RepositoryReferencesUnion } @@ -49,6 +50,7 @@ public struct ModerationCreateReportOutput: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let subject: RepositoryReferencesUnion /// The decentralized identifier (DID) of the user who created the report. diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationDefs.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationDefs.swift index 08b3b789b5..46fac657ec 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationDefs.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Moderation/AtprotoModerationDefs.swift @@ -14,6 +14,7 @@ import Foundation /// - Important: The item associated with this enum is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ +/// \ /// Clarifications from Bluesky are needed in order to fully understand this item. /// /// [github]: https://github.com/bluesky-social/atproto/blob/main/lexicons/com/atproto/moderation/defs.json diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCheckAccountStatus.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCheckAccountStatus.swift index 4708155836..b230f08087 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCheckAccountStatus.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCheckAccountStatus.swift @@ -23,16 +23,19 @@ public struct ServerCheckAccountStatusOutput: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let repositoryCommit: String /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let repositoryRev: String /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let repositoryBlocks: Int /// The number of indexed records in the user's account. @@ -40,6 +43,7 @@ public struct ServerCheckAccountStatusOutput: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let privateStateValues: Int /// The expected number of blobs in the user's account. diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCode.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCode.swift index 167adb6dbf..2f71167631 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCode.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCode.swift @@ -22,6 +22,7 @@ public struct ServerCreateInviteCode: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let forAccount: [String]? } diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCodes.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCodes.swift index 9b1355e1ab..804b8b7073 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCodes.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerCreateInviteCodes.swift @@ -24,6 +24,7 @@ public struct ServerCreateInviteCodes: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let forAccounts: [String]? } @@ -49,6 +50,7 @@ public struct ServerAccountCodes: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let account: String /// An array of invite codes. diff --git a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerDeleteAccount.swift b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerDeleteAccount.swift index c342903bb1..2a7f1ea016 100644 --- a/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerDeleteAccount.swift +++ b/Sources/ATProtoKit/Models/Lexicons/com.atproto/Server/AtprotoServerDeleteAccount.swift @@ -24,6 +24,7 @@ public struct ServerDeleteAccount: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let token: String } diff --git a/Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/OzoneModerationDefs.swift b/Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/OzoneModerationDefs.swift index d9ce8c7a19..0ec56273dc 100644 --- a/Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/OzoneModerationDefs.swift +++ b/Sources/ATProtoKit/Models/Lexicons/tools.ozone/Moderation/OzoneModerationDefs.swift @@ -577,6 +577,7 @@ public struct OzoneModerationRepositoryView: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let relatedRecords: UnknownType /// The date and time the user was indexed. @@ -661,6 +662,7 @@ public struct OzoneModerationRepositoryViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let relatedRecords: UnknownType /// The date and time the user was last indexed. @@ -776,6 +778,7 @@ public struct OzoneModerationRecordView: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let value: UnknownType /// An array of CID hashes for blobs. @@ -787,6 +790,7 @@ public struct OzoneModerationRecordView: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let moderation: OzoneModeration /// The repository view of the record. @@ -794,6 +798,7 @@ public struct OzoneModerationRecordView: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let repository: OzoneModerationRepositoryView @@ -858,6 +863,7 @@ public struct OzoneModerationRecordViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let value: String /// An array of CID hashes for blobs. @@ -871,6 +877,7 @@ public struct OzoneModerationRecordViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let moderation: OzoneModerationDetail /// The repository view of the record. @@ -878,6 +885,7 @@ public struct OzoneModerationRecordViewDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public let repository: OzoneModerationRepositoryView @@ -950,6 +958,7 @@ public struct OzoneModerationRecordViewNotFound: Codable { /// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ +/// \ /// Clarifications from Bluesky are needed in order to fully understand this item. /// /// - SeeAlso: This is based on the [`com.atproto.admin.defs`][github] lexicon. @@ -961,6 +970,7 @@ public struct OzoneModeration: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public var subjectStatus: OzoneSubjectStatusView? = nil } @@ -970,6 +980,7 @@ public struct OzoneModeration: Codable { /// - Important: The item associated with this struct is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ +/// \ /// Clarifications from Bluesky are needed in order to fully understand this item. /// /// - SeeAlso: This is based on the [`com.atproto.admin.defs`][github] lexicon. @@ -981,6 +992,7 @@ public struct OzoneModerationDetail: Codable { /// - Important: The item associated with this property is undocumented in the AT Protocol specifications. The documentation here is based on:\ /// \* **For items with some inferable context from property names or references**: its best interpretation, though not with full certainty.\ /// \* **For items without enough context for even an educated guess**: a direct acknowledgment of their undocumented status.\ + /// \ /// Clarifications from Bluesky are needed in order to fully understand this item. public var subjectStatus: OzoneSubjectStatusView? = nil }