chore: clean up generated documentation page

Author: justandras

packages/live-status-gateway-api/api/refactor/components/subscriptions/subscriptionRequestDetails/subscriptionRequestDetails.yaml

@@ -3,7 +3,8 @@ $defs:
     type: object
     title: SubscriptionRequestDetails
     properties:
-      $ref: '../subscriptionDetails/subscriptionDetails.yaml#/$defs/subscriptionDetails/properties'
+      name:
+        $ref: '../subscriptionDetails/subscriptionDetails.yaml#/$defs/subscriptionDetails/properties/name'
     required: [name]
     additionalProperties: false
     examples:

packages/live-status-gateway-api/api/refactor/index.yaml

@@ -10,8 +10,6 @@ info:
   contact:
     name: Sofie TV Automation
     url: https://github.com/Sofie-Automation/sofie-core/issues
-    # TODO: Remove example email
-    email: example@example.com
 
 servers:
   development:
@@ -50,10 +48,11 @@ channels:
   buckets:
     $ref: './topics/buckets/bucketsTopic.yaml'
 
-  # Needed to retain the types from the old schema structure. Eventually this should be removed.
+  # Needed to retain the Slash type from the old schema structure. Eventually this should be removed.
   /:
     subscribe:
-      description: Messages that are received from the API
+      summary: Slash Messages
+      description: Messages that are received from the API - This channel is needed to retain the generated Slash type from the old schema structure. Eventually this should be removed.
       operationId: sendRootMessage
       message:
         oneOf:

packages/live-status-gateway-api/api/refactor/topics/activePieces/activePiecesTopic.yaml

@@ -2,7 +2,7 @@ description: Topic for active pieces updates
 
 subscribe:
   operationId: receiveActivePieces
-  summary: Server sends active pieces events
+  description: Server sends active pieces events
   message:
     oneOf:
       - $ref: '../../components/piece/messages/activePiecesMessage.yaml#/components/messages/activePiecesMessage'

packages/live-status-gateway-api/api/refactor/topics/activePlaylist/activePlaylistTopic.yaml

@@ -2,7 +2,7 @@ description: Topic for active playlist updates
 
 subscribe:
   operationId: receiveActivePlaylist
-  summary: Server sends active playlist events
+  description: Server sends active playlist events
   message:
     oneOf:
       - $ref: '../../components/playlist/messages/activePlaylistMessage.yaml#/components/messages/activePlaylistMessage'

packages/live-status-gateway-api/api/refactor/topics/adLibs/adLibsTopic.yaml

@@ -1,8 +1,8 @@
 description: Topic for AdLibs updates
 
 subscribe:
-  operationId: publishAdLibs
-  summary: Server publishes AdLibs updates
+  operationId: receiveAdLibs
+  description: Server publishes AdLibs updates
   message:
     oneOf:
       - $ref: '../../components/adLibs/messages/adLibsMessage.yaml#/components/messages/adLibsMessage'

packages/live-status-gateway-api/api/refactor/topics/buckets/bucketsTopic.yaml

@@ -2,7 +2,7 @@ description: Buckets schema for websocket subscriptions
 
 subscribe:
   operationId: receiveBucketsUpdate
-  summary: Server publishes Buckets updates
+  description: Server publishes Buckets updates
   message:
     oneOf:
       - $ref: '../../components/buckets/messages/bucketsMessage.yaml#/components/messages/bucketsMessage'

packages/live-status-gateway-api/api/refactor/topics/heartbeat/heartbeatTopic.yaml

@@ -1,6 +1,7 @@
 description: Topic for server heartbeat messages
 subscribe:
   operationId: receiveHeartbeat
+  description: Server sends heartbeat messages when no other communication is happening.
   message:
     oneOf:
       - $ref: '../../components/connection/messages/heartbeatMessage.yaml#/components/messages/heartbeatMessage'

packages/live-status-gateway-api/api/refactor/topics/packages/packagesTopic.yaml

@@ -1,6 +1,7 @@
 description: Packages topic for websocket subscriptions. Packages are assets that need to be prepared by Sofie Package Manager or third-party systems to make AdLibs and Pieces playable.
 subscribe:
   operationId: receivePackagesUpdate
+  description: Server sends packages updates
   message:
     oneOf:
       - $ref: '../../components/packages/messages/packagesMessage.yaml#/components/messages/packagesMessage'

packages/live-status-gateway-api/api/refactor/topics/segments/segmentsTopic.yaml

@@ -2,6 +2,6 @@ description: Topic for Segment updates
 
 subscribe:
   operationId: receiveSegments
-  summary: Server publishes Segment updates
+  description: Server publishes Segment updates
   message:
     $ref: '../../components/segment/messages/segmentsMessage.yaml#/components/messages/segmentsMessage'

packages/live-status-gateway-api/api/refactor/topics/studio/studioTopic.yaml

@@ -1,6 +1,7 @@
 description: Studio topic for websocket subscriptions
 subscribe:
   operationId: receiveStudioUpdate
+  description: Server sends studio status updates
   message:
     oneOf:
       - $ref: '../../components/studio/messages/studioUpdate.yaml#/components/messages/studioUpdate'