Refactor Bird API routes to support fallback workspace and channel configuration, centralize helper methods, and update OpenAPI spec to reflect optional parameters.

2026-03-04 10:42:33 +01:00
parent 98203282ba
commit cbac9181f6
7 changed files with 175 additions and 141 deletions
@@ -98,14 +98,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
      requestBody:
        required: true
        content:
@@ -140,14 +140,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: query
          name: page
          schema:
@@ -173,14 +173,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: path
          name: id
          required: true
@@ -206,14 +206,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: path
          name: id
          required: true
@@ -240,14 +240,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
      requestBody:
        required: false
        content:
@@ -392,14 +392,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
      requestBody:
        required: true
        content:
@@ -425,14 +425,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: query
          name: page
          schema:
@@ -458,14 +458,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: path
          name: id
          required: true
@@ -490,14 +490,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
        - in: path
          name: id
          required: true
@@ -531,14 +531,14 @@ paths:
          name: workspaceId
          schema:
            type: string
-          required: true
-          description: Bird Workspace identifier
+          required: false
+          description: Bird Workspace identifier (falls back to module configuration if omitted)
        - in: query
          name: channelId
          schema:
            type: string
-          required: true
-          description: Bird Channel identifier
+          required: false
+          description: Bird Channel identifier (falls back to module configuration if omitted)
      requestBody:
        required: true
        content: