BlueBirdBigBand/open-api.yaml at main · Mavv3006/BlueBirdBigBand · 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
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
openapi: 3.1.0

info:
  title: Blue Bird Big Band API
  version: v0.0.1

servers:
  - url: https://{environment}.api.bluebirdbigband.de
    variables:
      environment:
        default: prod
        enum:
          - prod
          - dev
paths:
  /musicians/grouped-by-instrument:
    get:
      summary: Get active musicians grouped by their instruments
      description: Get currently active musicians
      responses:
        '200':
          description: A list of instrument groups containing musicians
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InstrumentGroup'

  /concerts/pull:
    get:
      summary: Triggers an event to fetch new concert information from Konzertmeister
      description: Triggers an event to fetch new concert information from Konzertmeister
      security:
        - ApiKeyAuth: []
      responses:
        '204':
          description: Indicating fetching was successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
        '401':
          description: "Validierungsfehler - Die übergebenen Daten sind ungültig."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Fetching data from Konzertmeister unsuccessful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'


  /concerts/upcoming:
    get:
      summary: Get the upcoming concerts
      description: Get the upcoming concerts
      responses:
        '200':
          description: Retrieve concerts sorted by date (asc)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Concert'

components:
  schemas:
    Address:
      type: object
      properties:
        street:
          type: string
          example: "Obere Langgasse"
        house_number:
          type: string
          example: "33" # String, falls mal "33a" vorkommt
        zip_code:
          type: integer
          format: int64
          description: "5-stellige Zahl"
          example: "67346"
        city:
          type: string
          example: "Speyer"
        full_address:
          type: string
          description: "Ein vom Server vorformatierter String für die schnelle Anzeige."
          example: "Obere Langgasse 33, 67346 Speyer"

    Concert:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 101
        start_at:
          type: string
          format: date-time
          example: "2026-03-20T20:00:00Z"
        end_at:
          type: string
          format: date-time
          example: "2026-03-20T22:30:00Z"
        location_name:
          type: string
          example: "Stadthalle Speyer"
        address:
          $ref: '#/components/schemas/Address'
        description:
          type: string
          nullable: true
          example: "Swing im Dreieck"

    InstrumentGroup:
      type: object
      properties:
        name:
          type: string
          example: "Alt-Saxophon"
        image_path:
          type: string
          example: "images/instruments/alto-sax.png"
        musicians:
          type: array
          items:
            $ref: '#/components/schemas/Musician'

    Musician:
      type: object
      properties:
        name:
          type: string
          example: "Max Mustermann"

    Error:
      type: object
      properties:
        message:
          type: string
          example: "The given data was invalid."
        errors:
          type: object
          description: "Ein Objekt, bei dem die Keys die Feldnamen und die Werte Arrays von Fehlermeldungen sind."
          additionalProperties:
            type: array
            items:
              type: string

    Success:
      type: object
      properties:
        message:
          type: string
          example: "The operation was performed successfully."

  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key # Oder Authorization: Bearer