Skip to content

Commit 93ab78d

Browse files
Feature/api v2.1 (#56)
2 parents f8b22b3 + 9009f67 commit 93ab78d

106 files changed

Lines changed: 2751 additions & 3833 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api/changelogs/changelog_v2_1.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## Info
2+
### Version
3+
v2.1
4+
### Date
5+
2025-06-27
6+
### Autor
7+
James Stark
8+
## Changelog:
9+
10+
### Models
11+
- Add new Collection models
12+
- these are returned by paths instead of {array[Object]}
13+
- this should not change return types, just make code-generation cleaner
14+
- Flattened directory structure
15+
- this avoids openapi-codegen from generating several different model files when referencing across subfolders
16+
17+
``` diff
18+
19+
@@ Collections: @@
20+
+ add model UserCollection
21+
+ add model MatchCollection
22+
+ add model MatchRequestCollection
23+
+ add model ConversationStarterCollection
24+
# add collection objects {array[Object]} to make return types that contain several objects cleaner
25+
# this should not change the return types themselves, just make codegen cleaner
26+
27+
@@ All @@
28+
- remove model.yaml from subfolders ../models/{collections | values | masks | objects}/model
29+
+ insert entry for each model into openapi.yaml
30+
+ update refernces to point at new flattened model
31+
# this helps prevent openapi-codegen from generating multiple model files for each relative path
32+
33+
@ Update / New @@
34+
- remove all models with template NewObject
35+
- remove all models with template UpdateObject
36+
+ insert models with template ObjectNew
37+
+ insert models with template ObjectUpdate
38+
# this helps keep things together alphabetically
39+
40+
```
41+
42+
### Paths
43+
- Replace {array[Object]} with ObjectCollections
44+
- this should not change return types, just make code-generation cleaner
45+
- updated refs to point to new flatend models in Openapi.yaml
46+
47+
``` diff
48+
49+
@@ All @@
50+
- remove model references to subfolders ../models/{collections | values | masks | objects}/model
51+
+ insert model references to new flattened structure within openapi.yaml
52+
# this helps prevent openapi-codegen from generating multiple model files for each relative path
53+
54+
@@ /api/v2/matching/matches/{user-id} GET @@
55+
- remove response object {array[Match]}
56+
+ insert response object MatchCollection
57+
58+
@@ /api/v2/matching/requests/{user-id} GET @@
59+
- remove response object {array[MatchRequest]}
60+
+ insert response object MatchRequestCollection
61+
62+
@@ /api/v2/genai/conversation-starter GET @@
63+
- remove request object {array[User]}
64+
+ insert request object UserCollection
65+
- remove response object {array[ConversationStarter]}
66+
+ insert response object ConversationStarterCollection
67+
68+
69+
```

api/models/masks/NewMatchRequest.yaml

Lines changed: 0 additions & 37 deletions
This file was deleted.

api/models/masks/NewUser.yaml

Lines changed: 0 additions & 73 deletions
This file was deleted.

api/models/masks/UpdateMatchRequest.yaml

Lines changed: 0 additions & 31 deletions
This file was deleted.

api/models/masks/UpdateUser.yaml

Lines changed: 0 additions & 83 deletions
This file was deleted.

api/models/masks/matchStatus.yaml

Lines changed: 0 additions & 13 deletions
This file was deleted.

api/models/objects/ConversationStarter.yaml

Lines changed: 0 additions & 10 deletions
This file was deleted.

api/models/objects/Group.yaml

Lines changed: 0 additions & 38 deletions
This file was deleted.

api/models/objects/Match.yaml

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)