You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit was created on GitHub.com and signed with GitHub’s verified signature.
BREAKING: Replace legacy ImportedAPIStatus.* types with models::ApiStatus across the SDK and OpenAPI schema (many response models, API docs and function signatures updated).
BREAKING: Remove many generated Pick_* / Pick... types and replace with concrete models (ApiComment, ApiCommentBase, PublicCommentBase, PubSubCommentBase, APICommentBase, DeletedCommentResultComment, SetCommentTextResult, UpdatableCommentParams). Consumers must migrate usages of removed pick-types to the new model types.
BREAKING: Rename/replace vote and delete status wrapper types: VoteDeleteResponse.status is now models::ApiStatus (was Boxmodels::VoteDeleteResponseStatus), and related status model VoteDeleteResponseStatus deleted.
BREAKING: Update DefaultApi.update_comment signature and request body: UpdateCommentParams.body (PickApiCommentPeriodUpdatableCommentFields) -> UpdateCommentParams.updatable_comment_params: models::UpdatableCommentParams. The request JSON now uses updatable_comment_params.
BREAKING: Change FComment.logs type from generic Vec<Vec<serde_json::Value>> to Vecmodels::CommentLogEntry and replace CommentLog representation. Update related docs and OpenAPI schema.
NEW: Add ApiAuditLog model (src/docs and src/models) and replace previous PickTenantAuditLogPeriodTenantAuditLogKeys references with ApiAuditLog in GetAuditLogs responses and docs.
NEW: Add ApiComment and ApiCommentBase models (detailed comment representations) and replace previous PickFCommentPeriodApiCommentFieldsKeys usages with ApiComment across API responses (GetComment, GetComments, SaveComment responses, etc.).
NEW: Add ApiCommentBase model file and corresponding docs.
NEW: Add CommentLogData, CommentLogEntry and CommentLogType models and docs to represent structured comment log entries and their data.
NEW: Add DeletedCommentResultComment model and docs; replace previous pick type for deleted comment result in DeleteCommentPublic/PublicApiDeleteComment responses.
NEW: Add PubSubCommentBase model and docs; update PubSubComment model to use new fields/order/nullable handling and adjust OpenAPI representation.
NEW: Add PublicCommentBase model and docs; update PublicComment model to use nullable/double-option fields and reorder fields; Add approved field and other optional fields.
NEW: Add SetCommentTextResult model (renamed from PickFCommentPeriodApprovedOrCommentHtml) and update PublicApiSetCommentTextResponse and SetCommentText200Response to use SetCommentTextResult.
NEW: Add UpdatableCommentParams model and docs (replaces PickApiCommentPeriodUpdatableCommentFields) and update API documentation and request handling to accept it.
NEW: Add RepeatCommentCheckIgnoredReason and RepeatCommentHandlingAction enums (replacing previously imported status enums) and corresponding docs.
NEW: Add PubSubCommentBase and PublicCommentBase to models::mod and export them for SDK consumers.
NEW: Add ApiCreateUserBadgeResponse.notes optional field (docs and models) to include notes in responses related to creating user badges.
NEW: Add PatchPageApiResponse.comments_updated field (docs and models) to report number of comments updated by patching a page.
NEW: Add many model fields with improved optional/null handling (use of serde_with double_option and Option<Option>) to better reflect nullable properties in OpenAPI (e.g., ApiAuditLog.url/ip, APIComment and related models, PubSubComment fields, etc.).
CHANGED: Numerous models updated to use Option<Option> and serde_with::rust::double_option where fields can be omitted vs present-null, improving (but changing) serialization semantics for nullable properties.
CHANGED: Many docs under client/docs updated to reflect renamed models, replaced properties, and changed status type references (e.g., ImportedAPIStatus.* -> APIStatus) and new/renamed model docs added (ApiAuditLog, ApiComment, CommentLogData, CommentLogEntry, CommentLogType, PubSubCommentBase, PublicCommentBase, SetCommentTextResult, UpdatableCommentParams, RepeatComment*).
CHANGED: openapi.json updated extensively: removed ImportedAPIStatus enums, added APIStatus references, introduced new schemas for new/renamed models (APIAuditLog, APICommentBase/APIComment, PubSubCommentBase, PublicCommentBase, SetCommentTextResult, UpdatableCommentParams, CommentLogData/CommentLogEntry/CommentLogType, RepeatComment* enums), added commentsUpdated and notes schema entries, and adjusted many schema properties to be nullable or use referenced types.
REMOVED: Deleted many generated pick-type model files (PickFComment*, PickApiComment*, PickOmitFComment*, PickFCommentApiCommentFieldsKeysMeta, ImportedApiStatusPeriodFailed, ImportedApiStatusPeriodSuccess, VoteDeleteResponseStatus, and other Pick_* files) as they were replaced by concrete models or consolidated schemas.
INTERNAL: Updated src/models/mod.rs to add new model modules and remove deprecated/renamed exports (reflecting the above model renames/removals).
INTERNAL: Update many model constructors (new functions) to accept new types (ApiStatus, ApiComment, ApiAuditLog, etc.) and to initialize newly added optional fields with None/defaults.
DOCS: README and model lists updated to include new/renamed models and remove deprecated ones; multiple API docs updated to reflect model changes and status type replacements.
NOTE (for integrators): These changes are not backward compatible. Users must update code to use the new model names/types (ApiComment, ApiCommentBase, PublicCommentBase, PubSubCommentBase, ApiAuditLog, DeletedCommentResultComment, SetCommentTextResult, UpdatableCommentParams, CommentLogEntry/Data/Type, RepeatComment enums) and adapt to ApiStatus usage across responses and function signatures (notably update_comment).