Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit 9e97e98

Browse files
committed
[deprecation-of-passwords] - Changes in the review
1 parent 6cccee5 commit 9e97e98

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

_data/create.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
- name: "attendeePW"
1212
type: "String"
13-
description: "The password that the <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will join as a viewer. If no <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> is provided, the <code class=\"language-plaintext highlighter-rouge\">create</code> call will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> password for the meeting."
13+
description: "<b>[DEPRECATED]</b> The password that the <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will join as a viewer. If no <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> is provided, the <code class=\"language-plaintext highlighter-rouge\">create</code> call will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">attendeePW</code> password for the meeting."
1414

1515
- name: "moderatorPW"
1616
type: "String"
17-
description: "The password that will <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will as a moderator. if no <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> is provided, <code class=\"language-plaintext highlighter-rouge\">create</code> will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> password for the meeting."
17+
description: "<b>[DEPRECATED]</b> The password that will <a href=\"#join\">join</a> URL can later provide as its <code class=\"language-plaintext highlighter-rouge\">password</code> parameter to indicate the user will as a moderator. if no <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> is provided, <code class=\"language-plaintext highlighter-rouge\">create</code> will return a randomly generated <code class=\"language-plaintext highlighter-rouge\">moderatorPW</code> password for the meeting."
1818

1919
- name: "welcome"
2020
required: false

_data/end.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
- name: "password"
66
required: true
77
type: "String"
8-
description: "The moderator password for this meeting. You can not end a meeting using the attendee password."
8+
description: "<b>[DEPRECATED]</b> The moderator password for this meeting. You can not end a meeting using the attendee password."

_data/join.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
- name: "password"
1212
required: true
1313
type: "String"
14-
description: "This password value is used to determine the role of the user based on whether it matches the moderator or attendee password. Note: This parameter is <b>not</b> required when the role parameter is passed."
14+
description: "<b>[DEPRECATED]</b> This password value is used to determine the role of the user based on whether it matches the moderator or attendee password. Note: This parameter is <b>not</b> required when the role parameter is passed."
1515

1616
- name: "role"
1717
required: true

_posts/2.4/2021-06-09-new.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -393,17 +393,17 @@ Even though it is still possible to create a meeting with a password, it is now
393393
- **Create** - It is possible and recommended to not use the passwords while creating the request:
394394
395395
```url
396-
https://bbb25.bbbvm.imdt.com.br/bigbluebutton/api/create?allowStartStopRecording=true&attendeePW=ap&moderatorPW=mp&... &checksum=
396+
https://bbb.example.com/bigbluebutton/api/create?allowStartStopRecording=true&attendeePW=ap&moderatorPW=mp&... &checksum=
397397
```
398398
or
399399
```url
400-
https://bbb25.bbbvm.imdt.com.br/bigbluebutton/api/create?allowStartStopRecording=true&... &checksum=
400+
https://bbb.example.com/bigbluebutton/api/create?allowStartStopRecording=true&... &checksum=
401401
```
402402
403-
- **Join** - These requests don't need to follow the `/create` endpoint, on the grounds that it has its own parameter to know the role of the user. Se the explanation down below:
403+
- **Join** - These requests don't need to follow the `/create` endpoint, on the grounds that it has its own parameter to know the role of the user. See the explanation down below:
404404
405405
- In any cases, if the `role` parameter is sent along, it will be respected, even if `password` is passed too;
406-
- If the `role` parameter is not passed in the call, and the password exists (i.e., it has been sent in `/create` endpoint), then the password is mandatory for the `/join` endpoint to acknowledge which role does the user have.
406+
- If the `role` parameter is not passed in the request, and the password exists (i.e., it has been sent in `/create` endpoint), then the password is mandatory for the `/join` endpoint to identify which role the user has.
407407
- If the password does not exist (i.e., it was not defined in `/create` endpoint), then the `role` parameter is mandatory, otherwise it is not possible to enter a meeting.
408408
409409
- **End** - the password is really not used here. But, if it was set (in the `/create` endpoint) and passed along in the `end` endpoint, it will be validated, otherwise, it won't.

0 commit comments

Comments
 (0)