Skip to content

Release 1.0.0

Latest

Choose a tag to compare

@winrid winrid released this 21 Nov 23:30
45dc82f
  • BUMP MAJOR: This release contains breaking changes to generated models and API signatures; version bumped to 1.0.0.
  • Replace ImportedAPIStatus enums with a single APIStatus schema and type; updated all references across models and responses.
  • Introduce new high-level API model types: APIComment and APICommentBase (replaces many PickFComment* shapes) — comment representation refactor with many fields re-typed/nullable/relocated.
  • Add comment audit and log models: CommentLogData, CommentLogEntry, CommentLogType; FComment.logs and related schemas updated to use CommentLogEntry objects instead of raw arrays.
  • Add repeat-check enums and types: RepeatCommentHandlingAction and RepeatCommentCheckIgnoredReason.
  • Add APIAuditLog model and replace old PickTenantAuditLog* usage throughout (including docs/tests).
  • Add DeletedCommentResultComment model and use it in delete responses (PublicAPIDeleteCommentResponse, DeleteCommentPublic200Response, etc.).
  • Add PubSubCommentBase and PublicCommentBase models and refactor PubSubComment/PublicComment to use these base schemas; many fields moved, made nullable, or had types changed.
  • Add SetCommentTextResult model and use it for set-comment-text responses; update PublicAPISetCommentTextResponse and SetCommentText200Response.
  • Add UpdatableCommentParams model and replace PickAPICommentUpdatableCommentFields; update DefaultApi.updateComment method and its request/response handling to use UpdatableCommentParams (parameter rename in examples/docs/tests).
  • Add many new properties in API shapes and OpenAPI: CustomConfigParameters.noNewRootComments; PatchPageAPIResponse.commentsUpdated; APICreateUserBadgeResponse.notes; and others.
  • Remove many generated Pick* helper classes and ImportedAPIStatus* enum classes; corresponding JSON/type adapter registrations removed or replaced.
  • Update PublicComment/APIComment/PubSubComment/FComment schemas: restructured required fields, added/removed/nullable adjustments (e.g. date field handling, userId typed via UserId alias, domain typed via FDomain alias, many nullable updates for votes/flags/viewCount/displayLabel/rating/etc.).
  • PubSubComment schema and docs reorganized (date moved, comment/commentHTML ordering adjusted, many fields retyped/moved); PubSubCommentBase introduced.
  • JSON (gson) registration updated: register new CustomTypeAdapterFactory entries for all added models and remove adapters for removed Pick*/Imported* classes.
  • OpenAPI (openapi.yaml / openapi.json) updated: references to ImportedAPIStatus.* replaced with APIStatus; removed old imported status enums; added new schemas (APIAuditLog, APICommentBase, CommentLogData, CommentLogEntry, CommentLogType, PubSubCommentBase, PublicCommentBase, SetCommentTextResult, UpdatableCommentParams, RepeatComment* enums); adjusted examples and properties across many components.
  • Docs (.md) regenerated: many docs added/renamed (APIAuditLog, APIComment, APICommentBase, CommentLogData, CommentLogEntry, CommentLogType, DeletedCommentResultComment, PubSubCommentBase, PublicCommentBase, RepeatCommentCheckIgnoredReason, RepeatCommentHandlingAction, SetCommentTextResult, UpdatableCommentParams, etc.) and many references in README.md updated to reflect new model names.
  • DefaultApi.java updated: method signatures and internal variable names changed to accept UpdatableCommentParams for updateComment; request builders, validators, and examples updated accordingly.
  • Multiple model classes updated to use APIStatus and other new types (APIEmptyResponse, APIError, BlockSuccess, ChangeCommentPinStatusResponse, etc.).
  • Many model classes had fields added/removed/changed (examples: APICommentBase, PubSubCommentBase, PublicCommentBase, FComment, PatchPageAPIResponse, APICreateUserBadgeResponse, CommentLogData) — validations and JSON (de)serialization logic updated accordingly.
  • Tests updated: numerous model tests renamed/added/adjusted to match new model names and properties (APIAuditLogTest, APICommentBaseTest, APICommentTest, CommentLogDataTest, CommentLogEntryTest, CommentLogTypeTest, DeletedCommentResultCommentTest, PubSubCommentBaseTest, PublicCommentBaseTest, SetCommentTextResultTest, UpdatableCommentParamsTest, and more). Many test imports updated from old enums/types to APIStatus or new models.
  • Removed legacy anyOf/union types and VoteDeleteResponseStatus/VoteResponseStatus updated to use APIStatus and String where applicable; VoteDeleteResponseStatus model removed and validation simplified to APIStatus.