Skip to content

[pull] main from liveblocks:main #221

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.

Sign up for GitHub

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

Merged
pull merged 7 commits into from
Mar 18, 2026
Merged

[pull] main from liveblocks:main #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1580d96
Bump next from 16.1.6 to 16.1.7 in /starter-kits/nextjs-starter-kit (…
dependabot[bot] Mar 17, 2026
c93b343
Bump next from 16.1.6 to 16.1.7 in /examples/zustand-flowchart (#3196)
dependabot[bot] Mar 17, 2026
f2f0714
Bump next from 16.1.6 to 16.1.7 in /examples/nextjs-yjs-monaco (#3192)
dependabot[bot] Mar 17, 2026
16087db
Bump next from 16.1.6 to 16.1.7 in /examples/nextjs-yjs-lexical (#3198)
dependabot[bot] Mar 17, 2026
f4fdf19
Add missing OpenAPI docs for three public routes (#3199)
nvie Mar 17, 2026
0ccefe0
Fix route parity check (PR 1648)
nvie Mar 17, 2026
dbb73fc
Bump next from 16.1.6 to 16.1.7 in /examples/nextjs-yjs-codemirror (#…
dependabot[bot] Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 249 additions & 7 deletions docs/references/v2.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,6 +693,91 @@
}
}
},
"/rooms/{roomId}/update-organization-id": {
"post": {
"summary": "Update room organization ID",
"tags": ["Room"],
"parameters": [
{
"schema": {
"type": "string",
"description": "The ID of the room",
"example": "my-room-id"
},
"name": "roomId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Success. Returns the updated room with the new organization ID.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Room"
},
"examples": {
"example": {
"value": {
"type": "room",
"id": "react-todo-list",
"lastConnectionAt": "2022-08-04T21:07:09.380Z",
"createdAt": "2022-07-13T14:32:50.697Z",
"organizationId": "org_987654321",
"metadata": {
"color": "blue",
"size": "10",
"target": ["abc", "def"]
},
"defaultAccesses": ["room:write"],
"groupsAccesses": {
"marketing": ["room:write"]
},
"usersAccesses": {
"alice": ["room:write"],
"vinod": ["room:write"]
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"422": {
"$ref": "#/components/responses/422"
}
},
"operationId": "update-room-organization-id",
"description": "This endpoint updates the room's organization ID. The `fromOrganizationId` must match the room's current organization ID. Returns the updated room.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateRoomOrganizationIdRequestBody"
},
"examples": {
"example": {
"value": {
"fromOrganizationId": "org_123456789",
"toOrganizationId": "org_987654321"
}
}
}
}
}
}
}
},
"/rooms/{roomId}/active_users": {
"get": {
"summary": "Get active users",
Expand Down Expand Up @@ -2931,6 +3016,100 @@
}
}
},
"/rooms/{roomId}/threads/{threadId}/inbox-notifications": {
"get": {
"summary": "Get thread inbox notifications",
"tags": ["Comments"],
"description": "This endpoint returns the inbox notifications associated with a specific thread. Because this endpoint is not user-scoped, each notification includes a `userId` field identifying which user the notification belongs to. Only thread-kind notifications are returned.",
"operationId": "get-thread-inbox-notifications",
"parameters": [
{
"name": "roomId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the room",
"example": "my-room-id"
}
},
{
"name": "threadId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the thread",
"example": "th_abc123"
}
}
],
"responses": {
"200": {
"description": "Success. Returns the inbox notifications for the thread.",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response",
"properties": {
"data": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/InboxNotificationThreadData"
},
{
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "The user ID this notification belongs to."
}
},
"required": ["userId"]
}
]
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"example": "my-room-id"
},
"name": "roomId",
"in": "path",
"required": true
},
{
"schema": {
"type": "string",
"example": "th_abc123"
},
"name": "threadId",
"in": "path",
"required": true
}
]
},
"/authorize-user": {
"post": {
"summary": "Get access token with secret key",
Expand Down Expand Up @@ -3948,6 +4127,51 @@
}
}
},
"/inbox-notifications/{inboxNotificationId}/read": {
"parameters": [
{
"schema": {
"type": "string",
"example": "in_abc123"
},
"name": "inboxNotificationId",
"in": "path",
"required": true
}
],
"post": {
"summary": "Mark inbox notification as read",
"tags": ["Notifications"],
"operationId": "mark-inbox-notification-as-read",
"description": "This endpoint marks a specific inbox notification as read.",
"parameters": [
{
"name": "inboxNotificationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the inbox notification",
"example": "in_abc123"
}
}
],
"responses": {
"200": {
"description": "Success. The inbox notification has been marked as read. This endpoint does not return any content."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
}
}
},
"/groups": {
"post": {
"summary": "Create group",
Expand Down Expand Up @@ -4688,6 +4912,7 @@
"application/json": {
"schema": {
"type": "object",
"title": "Response",
"properties": {
"id": {
"type": "string"
Expand Down Expand Up @@ -6141,9 +6366,6 @@
},
"metadata": {
"$ref": "#/components/schemas/RoomMetadata"
},
"organizationId": {
"type": "string"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -6303,9 +6525,6 @@
"type": "integer",
"enum": [1, 2],
"description": "Preferred storage engine version to use when creating new rooms. The v2 Storage engine supports larger documents, is more performant, has native streaming support, and will become the default in the future."
},
"organizationId": {
"type": "string"
}
},
"required": ["id", "defaultAccesses"],
Expand Down Expand Up @@ -6463,6 +6682,26 @@
"newRoomId": "new-room-id"
}
},
"UpdateRoomOrganizationIdRequestBody": {
"type": "object",
"title": "UpdateRoomOrganizationIdRequestBody",
"additionalProperties": false,
"properties": {
"fromOrganizationId": {
"type": "string",
"description": "The current organization ID of the room. Must match the room's current organization ID."
},
"toOrganizationId": {
"type": "string",
"description": "The new organization ID to assign to the room."
}
},
"required": ["fromOrganizationId", "toOrganizationId"],
"example": {
"fromOrganizationId": "org_123456789",
"toOrganizationId": "org_987654321"
}
},
"ActiveUsersResponse": {
"title": "ActiveUsersResponse",
"type": "object",
Expand Down Expand Up @@ -7781,6 +8020,9 @@
"roomId": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"readAt": {
"oneOf": [
{
Expand All @@ -7805,11 +8047,11 @@
"notifiedAt",
"readAt"
],
"additionalProperties": false,
"example": {
"kind": "thread",
"id": "in_abc123",
"roomId": "my-room-id",
"organizationId": "org_123456789",
"threadId": "th_abc123",
"notifiedAt": "2024-01-15T10:30:00.000Z",
"readAt": null
Expand Down
Loading