Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chat/add-delete-message-feature-spec #216

Merged
merged 6 commits into from
Nov 22, 2024

Conversation

splindsay-92
Copy link
Contributor

@splindsay-92 splindsay-92 commented Nov 11, 2024

This pull request includes updates to the chat features, including new changes to message ordering, the introduction of V2 API chat endpoints, and deprecation of old V1 endpoints and functionality.

Message Ordering and Serials:

  • Introduced @Serial@, a field on a chat message, containing a lexicographically sortable string. (textile/chat-features.textile).
  • Deprecated the use of @timeserial@ field for message ordering and replaced it with @serial@
  • Updated the definitions for message ordering to be clearer and include lexicographic comparison.
  • Added @latestActionSerial@ for actions, a lexicographically sortable string similar to @serial@. (textile/chat-features.textile)

API Endpoint Versioning:

  • Added V2 endpoints for sending, updating, and deleting messages, including V2 request and response formats (textile/chat-features.textile).
  • Deprecated the V1 endpoints (textile/chat-features.textile)

Chat Message Updates:

  • Deprecated the old chat message structure.
  • Introduce a new V2 struct that includes all new fields @serial@, @latestActionSerial@, @action@ etc..

CSS and Styling Updates:

  • Added a new .deprecated CSS class to apply a gray text color to deprecated elements (templates/main.css).

@AndyTWF AndyTWF changed the base branch from main to chat-lifecycle November 11, 2024 16:34
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from aa6d5b6 to 1559c88 Compare November 11, 2024 16:53
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 1559c88 to 37b9a05 Compare November 11, 2024 17:09
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
@splindsay-92 splindsay-92 requested review from a team and removed request for a team November 11, 2024 21:21
textile/chat-features.textile Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Show resolved Hide resolved
@splindsay-92
Copy link
Contributor Author

@coderabbitai summary

@splindsay-92 splindsay-92 marked this pull request as ready for review November 12, 2024 15:31
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 2c78a09 to 80391fa Compare November 12, 2024 15:38
Base automatically changed from chat-lifecycle to main November 12, 2024 16:47
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 80391fa to d99422d Compare November 13, 2024 09:34
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from b7a218a to ded59cc Compare November 13, 2024 13:14
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 5b7a17b to 11c80cf Compare November 13, 2024 13:47
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 11c80cf to b48cf89 Compare November 13, 2024 13:48
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from b48cf89 to a0e92d4 Compare November 14, 2024 16:23
textile/chat-features.textile Outdated Show resolved Hide resolved
textile/chat-features.textile Outdated Show resolved Hide resolved
@splindsay-92 splindsay-92 requested a review from AndyTWF November 17, 2024 19:40
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from 95232a0 to b2b6063 Compare November 21, 2024 14:34
@splindsay-92 splindsay-92 requested a review from AndyTWF November 21, 2024 17:21
@splindsay-92 splindsay-92 force-pushed the chat/add-delete-message-feature-spec branch from b2b6063 to 73c59b8 Compare November 21, 2024 17:22
- Introduce V2 endpoints for sending, updating, and deleting messages, with corresponding changes in text structure and fields.
- Deprecate existing V1 API elements.
Refine definitions of `serial` and `latestActionSerial` for message ordering to be lexicographically sortable.
- Also fixed div not correctly graying out the spec point CHA-M4c
Clarified the usage of "shall" and "must" to ensure consistency.
- Makes the spec more requirement focused.
This spec point is more of an informative blurb and the testable points are covered below.
@splindsay-92 splindsay-92 merged commit b342115 into main Nov 22, 2024
2 checks passed
@splindsay-92 splindsay-92 deleted the chat/add-delete-message-feature-spec branch November 22, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants