-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1536 lines (1461 loc) · 43.7 KB
/
openapi.yaml
File metadata and controls
1536 lines (1461 loc) · 43.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: CNDQ Marketplace API
description: |
API for the CNDQ (Chemical Name-Drop Quote) marketplace game.
Players trade chemicals (C, N, D, Q), negotiate deals, and compete for the best returns.
## Authentication
All endpoints (except session status) require authentication via session cookies.
## Game Flow
1. **TRADING** phase - Players can create offers, negotiate, and trade
2. **PRODUCTION** phase - Production runs, market is locked
3. Sessions advance automatically or manually
version: 1.1.0
contact:
name: CNDQ API Support
servers:
- url: /api
description: API endpoints
tags:
- name: Session
description: Game session and phase management
- name: Team
description: Team profile, settings, and inventory
- name: Marketplace
description: Public marketplace offers and buy orders
- name: Offers
description: Create and manage sell offers and buy bids
- name: Trades
description: Trade execution history
- name: Listings
description: Interest advertisements (buy/sell intent without price)
- name: Negotiations
description: Private negotiations between teams
- name: Notifications
description: Team notifications
- name: Production
description: Production results and shadow prices
- name: Reports
description: Financial summaries and LP optimization reports
- name: Leaderboard
description: Team standings
- name: Admin
description: Administrative endpoints (admin only)
components:
schemas:
Chemical:
type: string
enum: [C, N, D, Q]
description: Chemical type (C, N, D, or Q)
TradeType:
type: string
enum: [buy, sell]
description: Trade direction
GamePhase:
type: string
enum: [TRADING, PRODUCTION, STOPPED]
description: Current game phase
StalenessLevel:
type: string
enum: [fresh, warning, stale]
description: How stale shadow price calculations are relative to recent trades
Error:
type: object
properties:
error:
type: string
message:
type: string
Offer:
type: object
properties:
id:
type: string
sellerId:
type: string
format: email
sellerName:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
minimum: 1
minPrice:
type: number
format: float
minimum: 0
type:
type: string
enum: [sell]
timestamp:
type: integer
BuyOrder:
type: object
properties:
id:
type: string
buyerId:
type: string
format: email
buyerName:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
minimum: 1
maxPrice:
type: number
format: float
minimum: 0
type:
type: string
enum: [buy]
timestamp:
type: integer
Negotiation:
type: object
properties:
id:
type: string
initiatorId:
type: string
format: email
initiatorName:
type: string
responderId:
type: string
format: email
responderName:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
status:
type: string
enum: [pending, accepted, rejected, countered, cancelled]
currentOffer:
type: object
properties:
quantity:
type: integer
price:
type: number
history:
type: array
items:
type: object
session:
type: integer
type:
$ref: '#/components/schemas/TradeType'
Listing:
type: object
description: A public interest advertisement (buy or sell intent, no price)
properties:
id:
type: string
teamId:
type: string
format: email
teamName:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
type:
$ref: '#/components/schemas/TradeType'
message:
type: string
timestamp:
type: integer
session:
type: integer
Transaction:
type: object
properties:
transactionId:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
pricePerGallon:
type: number
totalAmount:
type: number
sellerName:
type: string
buyerName:
type: string
timestamp:
type: integer
heat:
type: number
nullable: true
ShadowPrices:
type: object
properties:
C:
type: number
N:
type: number
D:
type: number
Q:
type: number
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: PHPSESSID
security:
- cookieAuth: []
paths:
# ─── Session ────────────────────────────────────────────────────────────────
/session/status:
get:
tags: [Session]
summary: Get current session status
description: Returns current session number, phase, and time remaining. Public endpoint.
security: []
responses:
'200':
description: Session status
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
session:
type: integer
phase:
$ref: '#/components/schemas/GamePhase'
timeRemaining:
type: integer
description: Seconds remaining in current phase
autoAdvance:
type: boolean
productionJustRan:
type: boolean
nullable: true
gameStopped:
type: boolean
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
tags: [Session]
summary: Acknowledge production results
description: Clear the productionJustRan flag
security: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
acknowledgeProduction:
type: boolean
responses:
'200':
description: Production acknowledged
/session/restart:
post:
tags: [Session]
summary: Restart the game
description: |
Restarts the game with existing NPC count.
Non-admins can only restart when autoAdvance (24/7 mode) is enabled AND the game has finished.
Admins can restart at any time.
responses:
'200':
description: Game restarted and started
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
session:
type: object
'403':
description: Restart not allowed (game in progress or autoAdvance disabled)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'405':
description: Method not allowed
'500':
description: Server error
# ─── Team ───────────────────────────────────────────────────────────────────
/team/profile:
get:
tags: [Team]
summary: Get team profile and inventory
description: Returns full profile including funds, inventory quantities, and shadow price staleness indicator
responses:
'200':
description: Team profile and inventory
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
profile:
type: object
properties:
email:
type: string
format: email
teamName:
type: string
currentFunds:
type: number
startingFunds:
type: number
initialProductionPotential:
type: number
settings:
type: object
inventory:
type: object
properties:
C:
type: number
N:
type: number
D:
type: number
Q:
type: number
transactionsSinceLastShadowCalc:
type: integer
stalenessLevel:
$ref: '#/components/schemas/StalenessLevel'
'401':
description: Not authenticated
'500':
description: Server error
post:
tags: [Team]
summary: Update team profile
description: Update limited profile fields (currently only teamName)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
teamName:
type: string
responses:
'200':
description: Profile updated
'401':
description: Not authenticated
'405':
description: Method not allowed
'500':
description: Server error
/team/settings:
get:
tags: [Team]
summary: Get team settings
responses:
'200':
description: Team settings
'401':
description: Not authenticated
'500':
description: Server error
post:
tags: [Team]
summary: Update team settings
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
teamName:
type: string
responses:
'200':
description: Settings updated
'400':
description: Invalid request
'401':
description: Not authenticated
'405':
description: Method not allowed
'500':
description: Server error
# ─── Marketplace ────────────────────────────────────────────────────────────
/marketplace/offers:
get:
tags: [Marketplace]
summary: Get all marketplace offers
description: Returns all active sell offers and buy orders, optionally filtered by chemical. Results are cached for 3 seconds.
parameters:
- name: chemical
in: query
description: Filter by chemical(s), comma-separated (e.g., "C" or "C,N,D")
schema:
type: string
responses:
'200':
description: Marketplace offers
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
offersByChemical:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/Offer'
buyOrdersByChemical:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/BuyOrder'
summary:
type: object
description: Market summary statistics
timestamp:
type: integer
'401':
description: Not authenticated
'500':
description: Server error
# ─── Offers ─────────────────────────────────────────────────────────────────
/offers/create:
post:
tags: [Offers]
summary: Create a new sell offer
description: Create a new sell offer for a chemical you have in inventory
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [chemical, quantity, minPrice]
properties:
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
minimum: 1
minPrice:
type: number
format: float
minimum: 0
responses:
'200':
description: Offer created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
offer:
$ref: '#/components/schemas/Offer'
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Trading not allowed (wrong phase)
'405':
description: Method not allowed
'500':
description: Server error
/offers/cancel:
post:
tags: [Offers]
summary: Cancel a sell offer
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [offerId]
properties:
offerId:
type: string
responses:
'200':
description: Offer cancelled
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Not authorized to cancel this offer
'405':
description: Method not allowed
'500':
description: Server error
/offers/bid:
post:
tags: [Offers]
summary: Create a buy order
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [chemical, quantity, maxPrice]
properties:
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
minimum: 1
maxPrice:
type: number
format: float
minimum: 0
responses:
'200':
description: Buy order created
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Trading not allowed
'405':
description: Method not allowed
'500':
description: Server error
# ─── Trades ─────────────────────────────────────────────────────────────────
/trades/history:
get:
tags: [Trades]
summary: Get team trade history
description: Returns all completed transactions for the current team
responses:
'200':
description: Trade history
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
transactions:
type: array
items:
type: object
debug:
type: object
properties:
teamEmail:
type: string
teamName:
type: string
transactionCount:
type: integer
'401':
description: Not authenticated
'500':
description: Server error
/trades/global:
get:
tags: [Trades]
summary: Get all marketplace transactions
description: Returns all completed trades across all teams (public trade tape)
parameters:
- name: limit
in: query
description: Maximum number of results (default 50, max 100)
schema:
type: integer
minimum: 1
maximum: 100
default: 50
responses:
'200':
description: Global trade history
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
transactions:
type: array
items:
$ref: '#/components/schemas/Transaction'
count:
type: integer
'500':
description: Server error
# ─── Listings ───────────────────────────────────────────────────────────────
/listings/list:
get:
tags: [Listings]
summary: Get all active listings
description: Returns all active interest advertisements grouped by chemical. Price and quantity are hidden from non-owners.
responses:
'200':
description: Active listings
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
listings:
type: array
items:
$ref: '#/components/schemas/Listing'
'401':
description: Not authenticated
'500':
description: Server error
/listings/post:
post:
tags: [Listings]
summary: Post a listing
description: Create a buy or sell interest advertisement (no price — intent only)
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [chemical, type]
properties:
chemical:
$ref: '#/components/schemas/Chemical'
type:
$ref: '#/components/schemas/TradeType'
responses:
'200':
description: Listing posted
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Trading not allowed
'405':
description: Method not allowed
'500':
description: Server error
/listings/my-listings:
get:
tags: [Listings]
summary: Get my listings
description: Returns all listings posted by the current team
responses:
'200':
description: Your listings
'401':
description: Not authenticated
'500':
description: Server error
/listings/cancel:
post:
tags: [Listings]
summary: Cancel a listing
description: Cancel one of your own listings. Also removes the corresponding buy order.
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [listingId]
properties:
listingId:
type: string
responses:
'200':
description: Listing cancelled
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
listingId:
type: string
chemical:
$ref: '#/components/schemas/Chemical'
'400':
description: Missing listingId
'401':
description: Not authenticated
'403':
description: Can only cancel your own listings
'405':
description: Method not allowed
'500':
description: Server error
# ─── Negotiations ───────────────────────────────────────────────────────────
/negotiations/initiate:
post:
tags: [Negotiations]
summary: Initiate a negotiation
description: Start a private negotiation with another team
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [responderId, chemical, quantity, price]
properties:
responderId:
type: string
format: email
adId:
type: string
description: Optional listing ID this negotiation responds to
chemical:
$ref: '#/components/schemas/Chemical'
quantity:
type: integer
minimum: 1
price:
type: number
format: float
minimum: 0
type:
$ref: '#/components/schemas/TradeType'
responses:
'200':
description: Negotiation initiated
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
negotiation:
$ref: '#/components/schemas/Negotiation'
'400':
description: Invalid request (cannot negotiate with self, missing fields)
'401':
description: Not authenticated
'403':
description: Trading not allowed
'405':
description: Method not allowed
'500':
description: Server error
/negotiations/list:
get:
tags: [Negotiations]
summary: List negotiations
description: Get all negotiations involving the current team
responses:
'200':
description: List of negotiations
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
negotiations:
type: array
items:
$ref: '#/components/schemas/Negotiation'
'401':
description: Not authenticated
'500':
description: Server error
/negotiations/accept:
post:
tags: [Negotiations]
summary: Accept a negotiation
description: Accept the current offer. Executes the trade immediately.
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [negotiationId]
properties:
negotiationId:
type: string
responses:
'200':
description: Negotiation accepted and trade executed
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Not authorized or trading not allowed
'405':
description: Method not allowed
'500':
description: Server error
/negotiations/counter:
post:
tags: [Negotiations]
summary: Counter a negotiation
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [negotiationId, quantity, price]
properties:
negotiationId:
type: string
quantity:
type: integer
minimum: 1
price:
type: number
format: float
minimum: 0
responses:
'200':
description: Counter-offer made
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Not authorized or trading not allowed
'405':
description: Method not allowed
'500':
description: Server error
/negotiations/reject:
post:
tags: [Negotiations]
summary: Reject a negotiation
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [negotiationId]
properties:
negotiationId:
type: string
responses:
'200':
description: Negotiation rejected
'400':
description: Invalid request
'401':
description: Not authenticated
'403':
description: Not authorized
'405':
description: Method not allowed
'500':
description: Server error
/negotiations/react:
post:
tags: [Negotiations]
summary: React to a negotiation
description: Send an emoji reaction to a negotiation message
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [negotiationId, emoji]
properties:
negotiationId:
type: string
emoji:
type: string
responses:
'200':
description: Reaction added
'400':
description: Invalid request
'401':
description: Not authenticated
'405':
description: Method not allowed
'500':
description: Server error
# ─── Notifications ──────────────────────────────────────────────────────────
/notifications/list:
get:
tags: [Notifications]
summary: List notifications
description: Get all notifications for the current team
responses:
'200':
description: Notifications
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
notifications:
type: array
items:
type: object
'401':
description: Not authenticated
'500':
description: Server error