@proxima-nexus/openapi 2.0.0 → 2.0.1

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/openapi.json +48 -58
  3. package/openapi.yaml +39 -49
  4. package/package.json +23 -23
package/CHANGELOG.md CHANGED
@@ -5,6 +5,21 @@ All notable changes to the Proxima Nexus OpenAPI specification are documented in
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [2.0.1] - 2026-02-04
9
+
10
+ ### Changed
11
+
12
+ #### Connection state enums
13
+
14
+ - **User connections** (`GET /user/{userId}/connections` query filter and connection DTOs): state enum `requested` | `active` | `rejected` | `blocked` → `incoming_request` | `outgoing_request` | `active`.
15
+ - **Event connections** (`GET /event/{eventId}/connections` query filter and connection DTOs): state enum `requested` | `active` | `rejected` | `blocked` → `requested` | `active` | `invited`.
16
+ - **Group connections** (connection DTOs): state enum aligned with the same values as event connections: `incoming_request` | `outgoing_request` | `active` | `requested` | `invited`.
17
+
18
+ #### Connection DTOs (User, Event, Group)
19
+
20
+ - **EntityConnectionDto** and related connection response DTOs: `state` is no longer in `required`; only `type` is required.
21
+ - **type** enum: removed duplicate `admin` and `owner` values from connection type enums.
22
+
8
23
  ## [2.0.0] - 2025-01-29
9
24
 
10
25
  ### Breaking changes
package/openapi.json CHANGED
@@ -448,10 +448,9 @@
448
448
  "items": {
449
449
  "type": "string",
450
450
  "enum": [
451
- "requested",
452
- "active",
453
- "rejected",
454
- "blocked"
451
+ "incoming_request",
452
+ "outgoing_request",
453
+ "active"
455
454
  ]
456
455
  }
457
456
  }
@@ -1663,8 +1662,7 @@
1663
1662
  "enum": [
1664
1663
  "requested",
1665
1664
  "active",
1666
- "rejected",
1667
- "blocked"
1665
+ "invited"
1668
1666
  ]
1669
1667
  }
1670
1668
  }
@@ -1953,16 +1951,6 @@
1953
1951
  "description": "Date/time the connection was last updated (ISO string)",
1954
1952
  "example": "2024-05-02T12:34:56.789Z"
1955
1953
  },
1956
- "state": {
1957
- "type": "string",
1958
- "description": "Connection state",
1959
- "enum": [
1960
- "requested",
1961
- "active",
1962
- "rejected",
1963
- "blocked"
1964
- ]
1965
- },
1966
1954
  "type": {
1967
1955
  "type": "string",
1968
1956
  "description": "Connection type",
@@ -1971,16 +1959,24 @@
1971
1959
  "admin",
1972
1960
  "owner",
1973
1961
  "member",
1974
- "admin",
1975
- "owner",
1976
1962
  "friend",
1977
1963
  "blocked",
1978
1964
  "none"
1979
1965
  ]
1966
+ },
1967
+ "state": {
1968
+ "type": "string",
1969
+ "description": "Connection state",
1970
+ "enum": [
1971
+ "incoming_request",
1972
+ "outgoing_request",
1973
+ "active",
1974
+ "requested",
1975
+ "invited"
1976
+ ]
1980
1977
  }
1981
1978
  },
1982
1979
  "required": [
1983
- "state",
1984
1980
  "type"
1985
1981
  ]
1986
1982
  },
@@ -2153,16 +2149,6 @@
2153
2149
  "description": "Date/time the connection was last updated (ISO string)",
2154
2150
  "example": "2024-05-02T12:34:56.789Z"
2155
2151
  },
2156
- "state": {
2157
- "type": "string",
2158
- "description": "Connection state",
2159
- "enum": [
2160
- "requested",
2161
- "active",
2162
- "rejected",
2163
- "blocked"
2164
- ]
2165
- },
2166
2152
  "type": {
2167
2153
  "type": "string",
2168
2154
  "description": "Connection type",
@@ -2171,13 +2157,22 @@
2171
2157
  "admin",
2172
2158
  "owner",
2173
2159
  "member",
2174
- "admin",
2175
- "owner",
2176
2160
  "friend",
2177
2161
  "blocked",
2178
2162
  "none"
2179
2163
  ]
2180
2164
  },
2165
+ "state": {
2166
+ "type": "string",
2167
+ "description": "Connection state",
2168
+ "enum": [
2169
+ "incoming_request",
2170
+ "outgoing_request",
2171
+ "active",
2172
+ "requested",
2173
+ "invited"
2174
+ ]
2175
+ },
2181
2176
  "userId": {
2182
2177
  "type": "string",
2183
2178
  "description": "User ID",
@@ -2185,7 +2180,6 @@
2185
2180
  }
2186
2181
  },
2187
2182
  "required": [
2188
- "state",
2189
2183
  "type",
2190
2184
  "userId"
2191
2185
  ]
@@ -2222,16 +2216,6 @@
2222
2216
  "description": "Date/time the connection was last updated (ISO string)",
2223
2217
  "example": "2024-05-02T12:34:56.789Z"
2224
2218
  },
2225
- "state": {
2226
- "type": "string",
2227
- "description": "Connection state",
2228
- "enum": [
2229
- "requested",
2230
- "active",
2231
- "rejected",
2232
- "blocked"
2233
- ]
2234
- },
2235
2219
  "type": {
2236
2220
  "type": "string",
2237
2221
  "description": "Connection type",
@@ -2240,13 +2224,22 @@
2240
2224
  "admin",
2241
2225
  "owner",
2242
2226
  "member",
2243
- "admin",
2244
- "owner",
2245
2227
  "friend",
2246
2228
  "blocked",
2247
2229
  "none"
2248
2230
  ]
2249
2231
  },
2232
+ "state": {
2233
+ "type": "string",
2234
+ "description": "Connection state",
2235
+ "enum": [
2236
+ "incoming_request",
2237
+ "outgoing_request",
2238
+ "active",
2239
+ "requested",
2240
+ "invited"
2241
+ ]
2242
+ },
2250
2243
  "groupId": {
2251
2244
  "type": "string",
2252
2245
  "description": "Group ID",
@@ -2254,7 +2247,6 @@
2254
2247
  }
2255
2248
  },
2256
2249
  "required": [
2257
- "state",
2258
2250
  "type",
2259
2251
  "groupId"
2260
2252
  ]
@@ -2272,16 +2264,6 @@
2272
2264
  "description": "Date/time the connection was last updated (ISO string)",
2273
2265
  "example": "2024-05-02T12:34:56.789Z"
2274
2266
  },
2275
- "state": {
2276
- "type": "string",
2277
- "description": "Connection state",
2278
- "enum": [
2279
- "requested",
2280
- "active",
2281
- "rejected",
2282
- "blocked"
2283
- ]
2284
- },
2285
2267
  "type": {
2286
2268
  "type": "string",
2287
2269
  "description": "Connection type",
@@ -2290,13 +2272,22 @@
2290
2272
  "admin",
2291
2273
  "owner",
2292
2274
  "member",
2293
- "admin",
2294
- "owner",
2295
2275
  "friend",
2296
2276
  "blocked",
2297
2277
  "none"
2298
2278
  ]
2299
2279
  },
2280
+ "state": {
2281
+ "type": "string",
2282
+ "description": "Connection state",
2283
+ "enum": [
2284
+ "incoming_request",
2285
+ "outgoing_request",
2286
+ "active",
2287
+ "requested",
2288
+ "invited"
2289
+ ]
2290
+ },
2300
2291
  "eventId": {
2301
2292
  "type": "string",
2302
2293
  "description": "Event ID",
@@ -2304,7 +2295,6 @@
2304
2295
  }
2305
2296
  },
2306
2297
  "required": [
2307
- "state",
2308
2298
  "type",
2309
2299
  "eventId"
2310
2300
  ]
package/openapi.yaml CHANGED
@@ -302,10 +302,9 @@ paths:
302
302
  items:
303
303
  type: string
304
304
  enum:
305
- - requested
305
+ - incoming_request
306
+ - outgoing_request
306
307
  - active
307
- - rejected
308
- - blocked
309
308
  - name: type
310
309
  required: false
311
310
  in: query
@@ -1081,8 +1080,7 @@ paths:
1081
1080
  enum:
1082
1081
  - requested
1083
1082
  - active
1084
- - rejected
1085
- - blocked
1083
+ - invited
1086
1084
  - name: type
1087
1085
  required: false
1088
1086
  in: query
@@ -1280,14 +1278,6 @@ components:
1280
1278
  type: string
1281
1279
  description: Date/time the connection was last updated (ISO string)
1282
1280
  example: '2024-05-02T12:34:56.789Z'
1283
- state:
1284
- type: string
1285
- description: Connection state
1286
- enum:
1287
- - requested
1288
- - active
1289
- - rejected
1290
- - blocked
1291
1281
  type:
1292
1282
  type: string
1293
1283
  description: Connection type
@@ -1296,13 +1286,19 @@ components:
1296
1286
  - admin
1297
1287
  - owner
1298
1288
  - member
1299
- - admin
1300
- - owner
1301
1289
  - friend
1302
1290
  - blocked
1303
1291
  - none
1292
+ state:
1293
+ type: string
1294
+ description: Connection state
1295
+ enum:
1296
+ - incoming_request
1297
+ - outgoing_request
1298
+ - active
1299
+ - requested
1300
+ - invited
1304
1301
  required:
1305
- - state
1306
1302
  - type
1307
1303
  UserDto:
1308
1304
  type: object
@@ -1427,14 +1423,6 @@ components:
1427
1423
  type: string
1428
1424
  description: Date/time the connection was last updated (ISO string)
1429
1425
  example: '2024-05-02T12:34:56.789Z'
1430
- state:
1431
- type: string
1432
- description: Connection state
1433
- enum:
1434
- - requested
1435
- - active
1436
- - rejected
1437
- - blocked
1438
1426
  type:
1439
1427
  type: string
1440
1428
  description: Connection type
@@ -1443,17 +1431,23 @@ components:
1443
1431
  - admin
1444
1432
  - owner
1445
1433
  - member
1446
- - admin
1447
- - owner
1448
1434
  - friend
1449
1435
  - blocked
1450
1436
  - none
1437
+ state:
1438
+ type: string
1439
+ description: Connection state
1440
+ enum:
1441
+ - incoming_request
1442
+ - outgoing_request
1443
+ - active
1444
+ - requested
1445
+ - invited
1451
1446
  userId:
1452
1447
  type: string
1453
1448
  description: User ID
1454
1449
  example: user-123
1455
1450
  required:
1456
- - state
1457
1451
  - type
1458
1452
  - userId
1459
1453
  GetUsersDto:
@@ -1480,14 +1474,6 @@ components:
1480
1474
  type: string
1481
1475
  description: Date/time the connection was last updated (ISO string)
1482
1476
  example: '2024-05-02T12:34:56.789Z'
1483
- state:
1484
- type: string
1485
- description: Connection state
1486
- enum:
1487
- - requested
1488
- - active
1489
- - rejected
1490
- - blocked
1491
1477
  type:
1492
1478
  type: string
1493
1479
  description: Connection type
@@ -1496,17 +1482,23 @@ components:
1496
1482
  - admin
1497
1483
  - owner
1498
1484
  - member
1499
- - admin
1500
- - owner
1501
1485
  - friend
1502
1486
  - blocked
1503
1487
  - none
1488
+ state:
1489
+ type: string
1490
+ description: Connection state
1491
+ enum:
1492
+ - incoming_request
1493
+ - outgoing_request
1494
+ - active
1495
+ - requested
1496
+ - invited
1504
1497
  groupId:
1505
1498
  type: string
1506
1499
  description: Group ID
1507
1500
  example: group-123
1508
1501
  required:
1509
- - state
1510
1502
  - type
1511
1503
  - groupId
1512
1504
  EventEntityConnectionDto:
@@ -1520,14 +1512,6 @@ components:
1520
1512
  type: string
1521
1513
  description: Date/time the connection was last updated (ISO string)
1522
1514
  example: '2024-05-02T12:34:56.789Z'
1523
- state:
1524
- type: string
1525
- description: Connection state
1526
- enum:
1527
- - requested
1528
- - active
1529
- - rejected
1530
- - blocked
1531
1515
  type:
1532
1516
  type: string
1533
1517
  description: Connection type
@@ -1536,17 +1520,23 @@ components:
1536
1520
  - admin
1537
1521
  - owner
1538
1522
  - member
1539
- - admin
1540
- - owner
1541
1523
  - friend
1542
1524
  - blocked
1543
1525
  - none
1526
+ state:
1527
+ type: string
1528
+ description: Connection state
1529
+ enum:
1530
+ - incoming_request
1531
+ - outgoing_request
1532
+ - active
1533
+ - requested
1534
+ - invited
1544
1535
  eventId:
1545
1536
  type: string
1546
1537
  description: Event ID
1547
1538
  example: event-123
1548
1539
  required:
1549
- - state
1550
1540
  - type
1551
1541
  - eventId
1552
1542
  CreateEventDto:
package/package.json CHANGED
@@ -1,47 +1,47 @@
1
1
  {
2
2
  "name": "@proxima-nexus/openapi",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "OpenAPI specification for Proxima Nexus",
5
5
  "main": "openapi.json",
6
6
  "types": "openapi.json",
7
7
  "files": [
8
- "openapi.json",
9
- "openapi.yaml",
10
- "README.md",
11
- "CHANGELOG.md",
12
- "LICENSE"
8
+ "openapi.json",
9
+ "openapi.yaml",
10
+ "README.md",
11
+ "CHANGELOG.md",
12
+ "LICENSE"
13
13
  ],
14
14
  "scripts": {
15
- "validate": "swagger-cli validate openapi.yaml",
16
- "prepublishOnly": "npm run validate"
15
+ "validate": "swagger-cli validate openapi.yaml",
16
+ "prepublishOnly": "npm run validate"
17
17
  },
18
18
  "keywords": [
19
- "openapi",
20
- "swagger",
21
- "api",
22
- "specification",
23
- "proxima-nexus",
24
- "rest-api"
19
+ "openapi",
20
+ "swagger",
21
+ "api",
22
+ "specification",
23
+ "proxima-nexus",
24
+ "rest-api"
25
25
  ],
26
26
  "author": "Proxima Nexus",
27
27
  "license": "ISC",
28
28
  "repository": {
29
- "type": "git",
30
- "url": "https://github.com/proxima-nexus/openapi.git"
29
+ "type": "git",
30
+ "url": "https://github.com/proxima-nexus/openapi.git"
31
31
  },
32
32
  "bugs": {
33
- "url": "https://github.com/proxima-nexus/openapi/issues"
33
+ "url": "https://github.com/proxima-nexus/openapi/issues"
34
34
  },
35
35
  "homepage": "https://github.com/proxima-nexus/openapi#readme",
36
36
  "publishConfig": {
37
- "access": "public",
38
- "provenance": "true",
39
- "registry": "https://registry.npmjs.org/"
37
+ "access": "public",
38
+ "provenance": "true",
39
+ "registry": "https://registry.npmjs.org/"
40
40
  },
41
41
  "devDependencies": {
42
- "@apidevtools/swagger-cli": "^4.0.4"
42
+ "@apidevtools/swagger-cli": "^4.0.4"
43
43
  },
44
44
  "engines": {
45
- "node": ">=18.x"
45
+ "node": ">=18.x"
46
46
  }
47
- }
47
+ }