Skip to content

Commit 6be1f82

Browse files
authored
Add example values
1 parent 2947c1d commit 6be1f82

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

openapi.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,15 @@ paths:
2828
properties:
2929
joinUrl:
3030
type: string
31+
example: https://test-install.blindsidenetworks.com/bigbluebutton/api/join?avatarURL+=https%3A%2F%2Fexample.org%2Fstreaming.jpg&excludeFromDashboard=true&fullName=Livestream&meetingID=random-1453783&password=mp&redirect=true&userdata-bbb_ask_for_feedback_on_logout=true&userdata-bbb_custom_style_url=https%3A%2F%2Fexample.org%2Fbbb.css&userdata-bbb_hide_actions_bar=true&checksum=9a635c68b06a3a130f378ba1ebb62b25e54ec4bb
3132
description: URL to join the meeting.
3233
pauseImageUrl:
3334
type: string
35+
example: https://example.org/pause.jpg
3436
description: (Optional) URL of the pause image.
3537
rtmpUrl:
3638
type: string
39+
example: rtmp://a.rtmp.youtube.com/live2/abc-123-def-456
3740
description: RTMP target URL for the stream.
3841
required:
3942
- joinUrl
@@ -75,6 +78,7 @@ paths:
7578
- name: jobId
7679
in: path
7780
required: true
81+
example: 90b0f04212100c01eb31f0805d8ddffb289d7345e0b9829e328329035a1a8682
7882
schema:
7983
type: string
8084
responses:
@@ -96,6 +100,7 @@ paths:
96100
- name: jobId
97101
in: path
98102
required: true
103+
example: 90b0f04212100c01eb31f0805d8ddffb289d7345e0b9829e328329035a1a8682
99104
schema:
100105
type: string
101106
responses:
@@ -124,6 +129,7 @@ paths:
124129
- name: jobId
125130
in: path
126131
required: true
132+
example: 90b0f04212100c01eb31f0805d8ddffb289d7345e0b9829e328329035a1a8682
127133
schema:
128134
type: string
129135
responses:
@@ -151,6 +157,7 @@ paths:
151157
- name: jobId
152158
in: path
153159
required: true
160+
example: 90b0f04212100c01eb31f0805d8ddffb289d7345e0b9829e328329035a1a8682
154161
schema:
155162
type: string
156163
responses:
@@ -251,6 +258,7 @@ components:
251258
properties:
252259
id:
253260
type: string
261+
example: 90b0f04212100c01eb31f0805d8ddffb289d7345e0b9829e328329035a1a8682
254262
progress:
255263
type: object
256264
properties:

0 commit comments

Comments
 (0)