Skip to content

Release v1.0.0 — Regenerate SDK: model renames, APIStatus, comment-log models and other breaking changes#4

Merged
winrid merged 1 commit intomainfrom
release-2025-11-21
Nov 21, 2025
Merged

Release v1.0.0 — Regenerate SDK: model renames, APIStatus, comment-log models and other breaking changes#4
winrid merged 1 commit intomainfrom
release-2025-11-21

Conversation

@winrid
Copy link
Copy Markdown
Contributor

@winrid winrid commented Nov 21, 2025

Release 1.0.0

Changes

  • BREAKING: Regenerated SDK models and API surface; this release contains multiple breaking changes requiring consumers to update references.
  • BREAKING: Replaced legacy ImportedAPIStatus enums with a unified APIStatus schema across responses and errors (many models updated to use APIStatus).
  • BREAKING: Replaced many generated "Pick..."/"Imported..." models with clearer names:
    • PickTenantAuditLogTenantAuditLogKeys -> APIAuditLog
    • PickFCommentAPICommentFieldsKeys -> APICommentBase
    • PickFCommentAPICommentFieldsKeysMeta -> CommentLogEntry
    • PickFCommentPublicCommentFieldsKeys -> PublicCommentBase
    • PickFCommentIsDeletedOrCommentHTMLOrCommenterNameOrUserId -> DeletedCommentResultComment
    • PickFCommentApprovedOrCommentHTML -> SetCommentTextResult
    • PickOmitFCommentDatePublicCommentPubSubFieldsKeys -> PubSubCommentBase
    • PickAPICommentUpdatableCommentFields -> UpdatableCommentParams
    • ImportedAPIStatusFAILED -> RepeatCommentCheckIgnoredReason (enum values changed)
    • ImportedAPIStatusSUCCESS -> RepeatCommentHandlingAction (enum values changed)
    • VoteDeleteResponseStatus model removed and replaced by APIStatus usage.
  • NEW: Added new models for comment logging and audit functionality:
    • CommentLogData
    • CommentLogEntry
    • CommentLogType (enum)
    • APIComment (full API-facing comment model)
    • APIAuditLog
  • CHANGED: Public and API comment models reworked and split into base/complete shapes. Many properties were reordered, had nullability changed, or moved between models (e.g. comment, commentHTML, anon_user_id, view_count, flag_count, rating, approved, is_spam, is_deleted, etc.). PublicComment and PubSubComment schemas updated (fields moved/renamed, new nullable handling).
  • CHANGED: API responses that previously returned "PickFComment..." now return APIComment or APIComment[] (GetComment, GetComments, APIGetCommentResponse, APIGetCommentsResponse, GetComments200Response, GetComments200Response etc.).
  • CHANGED: DefaultApi.updateComment signature changed — parameter renamed and typed to UpdatableCommentParams (previously PickAPICommentUpdatableCommentFields). All corresponding client method signatures, requests, async methods and request body handling updated.
  • NEW: Added UpdatableCommentParams model (replacing the previous PickAPICommentUpdatableCommentFields) and updated its properties and nullability handling.
  • CHANGED: Set comment text endpoints now return SetCommentTextResult (replacing prior PickFCommentApprovedOrCommentHTML shape) and related models/response types updated accordingly.
  • CHANGED: DeletedCommentResultComment introduced and used by delete-related responses in place of prior pick-shaped result.
  • CHANGED: PubSubComment and PubSubCommentBase reworked: many fields reordered, new nullable handling, new properties added/moved (date, url, domain, anon_user_id, view_count, flag_count, reviewed, expire_at, has_code, approved, locale, is_banned_user, etc.).
  • CHANGED: FComment.logs now typed as array of CommentLogEntry (was generic array[] before).
  • CHANGED: CustomConfigParameters: added new boolean field no_new_root_comments.
  • CHANGED: PatchPageAPIResponse: added comments_updated int property.
  • CHANGED: APICreateUserBadgeResponse and CreateUserBadge200Response: added optional notes:string[] property.
  • CHANGED: Many models switched properties from specific Pick... meta types to canonical meta types (meta fields now reference FCommentMeta rather than generated Pick meta types).
  • CHANGED: Numerous getters/setters updated to reflect renamed properties and new nullability behavior (openAPINullables handling logic added across many models).
  • CHANGED: openapi.json updated to reflect schema renames, new models, nullable flags, enums, and APIStatus replacements; multiple component schema definitions reworked for new shapes.
  • REMOVED: fastcomments/sso dependency removed from composer.json require section.
  • CHANGED: phpunit.xml.dist testsuite updated to run ./test/Api and ./test/Model (tests reorganized/renamed accordingly).
  • TESTS: Added and renamed many tests to match model renames (new tests added for APIComment, CommentLogData, CommentLogEntry, CommentLogType, APIAuditLog, APICommentBase, PubSubCommentBase, PublicCommentBase, UpdatableCommentParams, SetCommentTextResult, DeletedCommentResultComment, RepeatComment* enums, etc.). Many existing tests were renamed to match model file renames.

@winrid winrid merged commit 6083b6d into main Nov 21, 2025
@winrid winrid deleted the release-2025-11-21 branch November 21, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant