@proxima-nexus/openapi 1.0.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +66 -0
- package/openapi.json +726 -142
- package/openapi.yaml +564 -125
- package/package.json +3 -1
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to the Proxima Nexus OpenAPI specification are documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [2.0.0] - 2025-01-29
|
|
9
|
+
|
|
10
|
+
### Breaking changes
|
|
11
|
+
|
|
12
|
+
#### Path and parameter renames
|
|
13
|
+
|
|
14
|
+
- **User connections**
|
|
15
|
+
- `GET/PUT/DELETE /user/{userId}/friends/{friendUserId}` → `PUT/DELETE /user/{userId}/connections/{targetUserId}` (path param `friendUserId` → `targetUserId`)
|
|
16
|
+
- `GET /user/{userId}/friends` → `GET /user/{userId}/connections`
|
|
17
|
+
- **Event connections**
|
|
18
|
+
- `PUT /event/{eventId}/attendees/{userId}` → `PUT /event/{eventId}/connection/{userId}`; DELETE added for removing attendees
|
|
19
|
+
- `GET /event/{eventId}/attendees` → `GET /event/{eventId}/connections`
|
|
20
|
+
- **Group connections**
|
|
21
|
+
- `PUT/DELETE /group/{groupId}/members/{userId}` → `PUT/DELETE /group/{groupId}/connection/{userId}`
|
|
22
|
+
- `GET /group/{groupId}/members` → `GET /group/{groupId}/connections`
|
|
23
|
+
|
|
24
|
+
#### Operation ID renames
|
|
25
|
+
|
|
26
|
+
- `UserController_findOne` → `UserController_get`
|
|
27
|
+
- `UserController_addFriend` → `UserController_putConnection`
|
|
28
|
+
- `UserController_removeFriend` → `UserController_deleteConnection`
|
|
29
|
+
- `UserController_getFriends` → `UserController_getConnections`
|
|
30
|
+
- `EventController_findOne` → `EventController_get`
|
|
31
|
+
- `EventController_addAttendee` → `EventController_addConnection`
|
|
32
|
+
- `EventController_getAttendees` → `EventController_getConnections` (new `EventController_removeConnection` for DELETE)
|
|
33
|
+
- `GroupController_findOne` → `GroupController_get`
|
|
34
|
+
- `GroupController_addMember` → `GroupController_addConnection`
|
|
35
|
+
- `GroupController_removeMember` → `GroupController_removeConnection`
|
|
36
|
+
- `GroupController_getMembers` → `GroupController_getConnections`
|
|
37
|
+
|
|
38
|
+
#### Security
|
|
39
|
+
|
|
40
|
+
- All operations: security scheme `bearer` → `api_key`.
|
|
41
|
+
|
|
42
|
+
#### Request identity: header instead of body
|
|
43
|
+
|
|
44
|
+
- **Requester identity** is no longer sent in request bodies. Use the **`X-Proxima-Nexus-Requester-User-Id`** header on all relevant endpoints (create/update/delete, search, get-by-id, batch, list connections).
|
|
45
|
+
- **Removed** `requesterUserId` from: `CreateEntityDto`, `UpdateUserDto`, `CreateEventDto`, `UpdateEventDto`, `CreateGroupDto`, `UpdateGroupDto`.
|
|
46
|
+
|
|
47
|
+
#### Schema changes
|
|
48
|
+
|
|
49
|
+
- **Removed** `tenantId` from `UserDto`, `EventDto`, and `GroupDto`.
|
|
50
|
+
- **Added** `requesterConnection` (`EntityConnectionDto`) to `UserDto`, `EventDto`, and `GroupDto` for the calling user’s relationship to the entity.
|
|
51
|
+
- **EntityConnectionDto**: Now includes both `state` and `type`. New mutation DTOs: `MutateUserConnectionDto`, `MutateEventEntityConnectionDto`, `MutateGroupEntityConnectionDto` (with `type` only).
|
|
52
|
+
- **User connections**
|
|
53
|
+
- PUT create/update: **Required** request body `MutateUserConnectionDto` with `type` (`friend` | `blocked`).
|
|
54
|
+
- DELETE: **Required** query param `type` (`friend` | `blocked`); success response **200** → **204** (no body).
|
|
55
|
+
- **Event/group connections**
|
|
56
|
+
- PUT: **Required** request body `MutateEventEntityConnectionDto` or `MutateGroupEntityConnectionDto` with `type`.
|
|
57
|
+
- DELETE: **Required** request body (same DTO); success response **200** → **204** (no body).
|
|
58
|
+
- **Connection DTOs** (`UserEntityConnectionDto`, etc.): **Added** required `type`; **added** `blocked` to `state` enum.
|
|
59
|
+
- **Group type**: Now enum `open` | `request` | `invite` (replaces free-form string).
|
|
60
|
+
- **Events**: `CreateEventDto`/`EventDto`/`UpdateEventDto` add `maxNumAttendees`; `EventDto` adds `numAttendees`.
|
|
61
|
+
- **Groups**: `GroupDto` adds `numMembers` and `requesterConnection`.
|
|
62
|
+
|
|
63
|
+
### Added
|
|
64
|
+
|
|
65
|
+
- Optional `state` and `type` query filters on `GET /user/{userId}/connections`, `GET /event/{eventId}/connections`, and `GET /group/{groupId}/connections`.
|
|
66
|
+
- Explicit 400/401 response descriptions for create and visibility errors where applicable.
|