LiveOps_EventEnrollment/liveops_api.yaml at main · cagribuyuk/LiveOps_EventEnrollment · GitHub

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
openapi: 3.1.0
info:
  title: LiveOps API
  description: API for submitting join requests to events and retrieving group assignments.
  version: 1.0.0
servers:
  - url: http://localhost:3000
    description: Local development server

paths:
  /v1/events/{eventId}/join:
    post:
      summary: Submit a join request for an event
      parameters:
        - name: eventId
          in: path
          description: ID of the event to join
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinRequest'
      responses:
        '200':
          description: Join successful or already joined
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JoinResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string

components:
  schemas:
    JoinRequest:
      type: object
      required:
        - playerId
        - level
      properties:
        playerId:
          type: string
          example: "player123"
        level:
          type: integer
          example: 25

    JoinResponse:
      type: object
      properties:
        eventId:
          type: string
          example: "event001"
        playerId:
          type: string
          example: "player123"
        category:
          type: string
          example: "silver"
        groupId:
          type: integer
          example: 42
        status:
          type: string
          enum: [joined, already_joined]
          example: "joined"