Skip to content

v3.0.1

Latest
Latest

Choose a tag to compare

View all tags
@winrid winrid released this 22 Nov 05:31
· 1 commit to main since this release
v3.0.1
d1f08cb
  • BREAKING: Unified API status type: removed ImportedAPIStatus.SUCCESS / ImportedAPIStatus.FAILED and replaced usages with APIStatus across the SDK and OpenAPI schema (many response models and types updated).
  • BREAKING: Renamed and restructured comment-related models (these are breaking type/name changes): Pick_FComment.APICommentFieldsKeys_ -> APICommentBase, APIComment (new composite), Pick_APIComment.UpdatableCommentFields_ -> UpdatableCommentParams, Pick_FComment.PublicCommentFieldsKeys_ -> PublicCommentBase, Pick_Omit_FComment.date_.PublicCommentPubSubFieldsKeys_ -> PubSubCommentBase. Many generated model names and exports changed accordingly.
  • BREAKING: Function signature change in DefaultApi.updateComment: parameter renamed and typed from body: PickAPICommentUpdatableCommentFields to updatableCommentParams: UpdatableCommentParams. Request body serialization updated to use UpdatableCommentParamsToJSON.
  • Added new models/types: APIAuditLog, APIComment, APICommentBase, CommentLogData, CommentLogEntry, CommentLogType, DeletedCommentResultComment, PubSubCommentBase, PublicCommentBase, RepeatCommentCheckIgnoredReason, RepeatCommentHandlingAction, SetCommentTextResult, UpdatableCommentParams. These are exported from src/models and referenced throughout generated code.
  • Added enums & helpers for repeat-handling and comment log types: RepeatCommentHandlingAction, RepeatCommentCheckIgnoredReason, CommentLogType and associated JSON conversion helpers.
  • Introduced structured comment log model: CommentLogEntry { d, t, da } and CommentLogData with many fields (clearContent, isDeletedUser, phrase, badWord, engine, engineResponse, engineTokens, trustFactor, rule, repeatAction, reason, spamBefore/spamAfter, permanentFlag, expireBefore/expireAfter, flagCountBefore, trustFactorBefore/After, referencedCommentId, etc.). FComment.logs now uses CommentLogEntry instead of generic arrays.
  • Public and API comment models changed: APIGetCommentResponse, APIGetCommentsResponse, GetComment200Response, GetComments200Response and others now reference APIComment / APICommentBase instead of previous Pick_* types. PublicComment and PubSubComment shapes updated (fields reordered and many fields changed to nullable/optional/typed differently).
  • PubSubComment and related models: PubSubComment properties were reorganized and expanded (moved date, url, urlId, anonUserId, viewCount, isDeleted, isDeletedUser, isSpam, flagCount, domain, url, pageTitle, expireAt, reviewed, hasCode, approved, locale, isBannedUser, etc.) and PubSubComment now builds on PubSubCommentBase.
  • PublicComment changes: fields made nullable or optional, several fields added or reordered (date, anonUserId, isDeleted, isDeletedUser, isSpam, viewCount, feedbackIds, approved), and PublicComment now aligns to PublicCommentBase structure.
  • SetCommentText result type changed: Pick_FComment.approved-or-commentHTML_ renamed to SetCommentTextResult and PublicAPISetCommentTextResponse/SetCommentText200Response now return comment: SetCommentTextResult.
  • DeletedComment result type renamed: Pick_FComment.isDeleted-or-commentHTML-or-commenterName-or-userId_ -> DeletedCommentResultComment and used by PublicAPIDeleteCommentResponse/DeleteCommentPublic_200_response.
  • Added/changed fields in multiple response and model types:
    • CustomConfigParameters: added noNewRootComments (boolean).
    • PatchPageAPIResponse: added commentsUpdated (long) property.
    • APICreateUserBadgeResponse and CreateUserBadge200Response: added optional notes: List.
  • Many response models and API responses updated to reference APIStatus (e.g. APIEmptyResponse, APIError, AggregateQuestionResults_200_response, BlockFromCommentPublic_200_response, BlockSuccess, BulkAggregateQuestionResults_200_response, CreateCommentPublic_200_response, CreateFeedPost_200_response, CreateFeedPostPublic_200_response, CreateUserBadge_200_response, DeleteCommentPublic_200_response, DeleteComment_200_response, DeleteFeedPostPublic_200_response, DeleteCommentVote_200_response, FlagCommentPublic_200_response, FlagComment_200_response, GetAuditLogsResponse, GetAuditLogs_200_response, GetCommentText_200_response, GetCommentVoteUserNamesSuccessResponse, GetCommentVoteUserNames_200_response, GetComment_200_response, GetCommentsPublic_200_response, GetComments_200_response, GetEventLogResponse, GetEventLog_200_response, GetFeedPostsPublic_200_response, GetFeedPosts_200_response, GetFeedPostsStats_200_response, GetMyNotificationsResponse, GetPublicFeedPostsResponse, GetUserBadgeProgressById_200_response, GetUserBadgeProgressList_200_response, GetUserBadge_200_response, GetUserBadges_200_response, GetUserNotificationCountResponse, GetUserNotificationCount_200_response, GetUserNotifications_200_response, GetUserPresenceStatusesResponse, GetUserPresenceStatuses_200_response, GetUserReactsPublic_200_response, HeaderState, IgnoredResponse, LockComment_200_response, ResetUserNotificationsResponse, ResetUserNotifications_200_response, SaveCommentResponse, SaveCommentResponseOptimized, SaveComment_200_response, SaveCommentsResponseWithPresence, SearchUsersResponse, SearchUsers_200_response, SetCommentText_200_response, UnBlockCommentPublic_200_response, UnblockSuccess, UpdateUserBadge_200_response, UpdateUserNotificationStatus_200_response, UserNotificationWriteResponse, VoteComment_200_response, VoteDeleteResponse, etc.).
  • Removed several legacy/auxiliary generated types/files: ImportedAPIStatus.FAILED, ImportedAPIStatus.SUCCESS, legacy Pick_* model files, PickFCommentAPICommentFieldsKeysMeta, PickFCommentIsDeletedOrCommentHTMLOrCommenterNameOrUserId, VoteDeleteResponse_status/VoteDeleteResponseStatus, and similar pick/aux files were removed in favor of canonical schema types.
  • OpenAPI schema updates: openapi.json updated: added new components and schemas (APIAuditLog, APIComment, APICommentBase, CommentLogData, CommentLogEntry, CommentLogType, RepeatCommentHandlingAction, RepeatCommentCheckIgnoredReason, PubSubCommentBase, PublicCommentBase, SetCommentTextResult, DeletedCommentResultComment, etc.); removed the separate ImportedAPIStatus enums and replaced references with APIStatus; added/changed nullable and allOf constraints, made many properties nullable and added additionalProperties:false where appropriate.
  • Generated client code updates (src/generated): many model files added/renamed (APIAuditLog.ts, APIComment.ts, APICommentBase.ts, CommentLogData.ts, CommentLogEntry.ts, CommentLogType.ts, DeletedCommentResultComment.ts, PubSubCommentBase.ts, PublicCommentBase.ts, RepeatCommentCheckIgnoredReason.ts, RepeatCommentHandlingAction.ts, SetCommentTextResult.ts, UpdatableCommentParams.ts) and numerous existing model files updated to use the new types and JSON converters.
  • Index/export updates: src/models index updated to export the new/renamed types and to remove exports for deleted legacy types.
  • DefaultApi and other API classes updated to import and use the renamed models and JSON conversion functions (e.g. UpdatableCommentParamsFromJSON/ToJSON and APIComment/APICommentBase conversions).
  • Miscellaneous codegen adjustments: multiple model properties were changed from non-nullable to nullable or optional, arrays given explicit nullability, additional properties disallowed in several generated schemas, and numerous JSON (de)serialization helpers updated to match the new shapes.
  • Overall: this release is a breaking API/schema alignment and model rename release — SDK surface types and some API method signatures have changed, model names and exports were updated, and new comment/log models were introduced to better represent server schema.
Assets 2
Loading