Skip to content

Commit 751e4db

Browse files
akahenryakahenry
committed
Fix documentation and linter indicated errors
1 parent 5c68ca0 commit 751e4db

37 files changed

+181
-2759
lines changed

‎.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
node_modules
2-
.vscode
2+
.vscode
3+
dist.yaml
4+
redoc-static.html

‎.redocly.lint-ignore.yaml

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
2+
# See https://redoc.ly/docs/cli/ for more information.
3+
openapi/openapi.yaml:
4+
info-license:
5+
- '#/info'
6+
openapi/paths/root.yaml:
7+
operation-4xx-response:
8+
- '#/get/responses'
9+
openapi/paths/getMeetings.yaml:
10+
operation-4xx-response:
11+
- '#/get/responses'
12+
openapi/paths/getAllMeetings.yaml:
13+
operation-parameters-unique:
14+
- '#/get/parameters/3'
15+
operation-4xx-response:
16+
- '#/get/responses'
17+
openapi/paths/isMeetingRunning.yaml:
18+
operation-4xx-response:
19+
- '#/get/responses'
20+
openapi/paths/create.yaml:
21+
spec:
22+
- '#/components'
23+
operation-4xx-response:
24+
- '#/get/responses'
25+
- '#/post/responses'
26+
operation-operationId-unique:
27+
- '#/post/create'
28+
openapi/paths/end.yaml:
29+
operation-4xx-response:
30+
- '#/get/responses'
31+
openapi/paths/getMeetingInfo.yaml:
32+
operation-4xx-response:
33+
- '#/get/responses'
34+
openapi/paths/join.yaml:
35+
operation-4xx-response:
36+
- '#/get/responses'
37+
openapi/paths/getRecordings.yaml:
38+
operation-4xx-response:
39+
- '#/get/responses'
40+
openapi/paths/publishRecordings.yaml:
41+
operation-4xx-response:
42+
- '#/get/responses'
43+
openapi/paths/deleteRecordings.yaml:
44+
operation-4xx-response:
45+
- '#/get/responses'
46+
openapi/paths/updateRecordings.yaml:
47+
operation-4xx-response:
48+
- '#/get/responses'
49+
openapi/paths/getRecordingToken.yaml:
50+
operation-4xx-response:
51+
- '#/get/responses'
52+
openapi/paths/createHook.yaml:
53+
operation-4xx-response:
54+
- '#/get/responses'
55+
openapi/paths/list.yaml:
56+
operation-4xx-response:
57+
- '#/get/responses'
58+
openapi/paths/destroy.yaml:
59+
operation-4xx-response:
60+
- '#/get/responses'
61+
openapi/paths/getDefaultConfigXML.yaml:
62+
operation-4xx-response:
63+
- '#/get/responses'
64+
openapi/paths/setConfigXML.yaml:
65+
operation-4xx-response:
66+
- '#/post/responses'

‎.redocly.yaml

+2-7
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,8 @@ lint:
77
rules:
88
no-unused-components: warning
99
referenceDocs:
10-
htmlTemplate: ./docs/index.html
10+
htmlTemplate: ./public/index.html
1111
theme:
1212
colors:
1313
primary:
14-
main: "#32329f"
15-
generateCodeSamples:
16-
languages: # Array of language config objects; indicates in which languages to generate code samples.
17-
- lang: curl # Can be one of the following supported languages: "curl", "Node.js", "JavaScript".
18-
- lang: "Node.js"
19-
- lang: "JavaScript"
14+
main: "#32329f"

‎Makefile

-2
This file was deleted.

‎README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,24 @@ A repository with the Redoc configuration that reads the `openapi.yaml` file and
44

55
## Code dependencies
66

7-
To install and run, just use the commands bellow:
7+
To install the dependencies, run:
88

99
```bash
1010
$ npm install
11+
```
12+
13+
## How to run
14+
15+
To run a webserver watching for changes in the OpenAPI resources, run:
16+
17+
```bash
1118
$ npm start
1219
```
1320

14-
## Makefile
21+
## How to build
1522

16-
Just use the commands bellow to export a static HTML file for the documentation:
23+
To build a HTML file from the documentation, run:
1724

1825
```bash
19-
$ make html
26+
$ npm run build
2027
```

‎docs/favicon.png

-1.78 KB
Binary file not shown.

‎openapi/components/examples/list/success.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ success:
77
<hookID>1</hookID>
88
<hookGUID>f4fd4b8a-5c8e-4930-8f33-4f133d5d9b57</hookGUID>
99
<authToken>e74963291b18e915d9470585ffd33b87d69f1cd6</authToken>
10-
<callbackURL><![CDATA[https://url-here.com]]></callbackURL>
10+
<callbackURL>https://webhook-test.test.webhook/test/hook</callbackURL>
1111
<sharedSecretGUID>ed3cef25-9376-4efb-be8b-d5914524e1b9</sharedSecretGUID>
1212
<enabled>true</enabled>
1313
</hook>

‎openapi/components/parameters/callbackURL.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: callbackURL
22
in: query
3-
description: The URL which will be sent the events
4-
required: true
3+
description: The URL which receive the events.
54
schema:
65
type: string

‎openapi/components/parameters/enabled.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: record
1+
name: enabled
22
in: query
33
description: If true, hook will receive events, else, it won't
44
schema:

‎openapi/components/parameters/guest.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: action
2+
in: query
3+
description: Set to `true` to indicate that the user is a guest, otherwise do NOT send this parameter.
4+
schema:
5+
type: boolean

‎openapi/components/parameters/hookID.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
name: hookID
22
in: query
3-
description: The identification of the hook which will be deleted.
4-
required: true
3+
description: The identification of the hook.
54
schema:
65
type: string

‎openapi/components/parameters/limit.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: limit
22
in: query
3-
description: maximum number of rows to return in the response
3+
description: Maximum number of rows to return in the response.
44
schema:
55
type: integer

‎openapi/components/parameters/password.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ in: query
33
description: Meeting password to join as Atendee or Moderator
44
required: true
55
schema:
6-
type: stringa
6+
type: string

‎openapi/components/schemas/hook.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ required:
44
- hookGUID
55
- authToken
66
- callbackURL
7-
- sharedSecretGUID
87
- enabled
98
properties:
109
hookID:
@@ -17,5 +16,7 @@ properties:
1716
type: string
1817
sharedSecretGUID:
1918
type: string
19+
externalMeetingID:
20+
type: string
2021
enabled:
2122
type: boolean

‎openapi/openapi.yaml

-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ tags:
2424
description: Monitoring centered requests
2525
- name: hooks
2626
description: Everything about your Hooks
27-
schemes:
28-
- https
2927
paths:
3028
/:
3129
$ref: './paths/root.yaml'

‎openapi/paths/create.yaml

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
get:
2-
operationId: create
2+
summary: create
3+
operationId: get-create
34
description:
45
$ref: '../../docs/create/description.md'
56
tags:
@@ -16,7 +17,8 @@ get:
1617
schema:
1718
$ref: '../components/schemas/responses/create.yaml'
1819
post:
19-
operationId: create
20+
summary: create
21+
operationId: post-create
2022
description:
2123
$ref: '../../docs/create/description.md'
2224
tags:
@@ -99,5 +101,5 @@ components:
99101
- $ref: '../components/parameters/learningDashboardCleanupDelayInMinutes.yaml'
100102
- $ref: '../components/parameters/allowModsToEjectCameras.yaml'
101103
- $ref: '../components/parameters/allowRequestsWithoutSession.yaml'
102-
- $ref: '../components/parameters/virtualBackgroundDisabled.yaml'
104+
- $ref: '../components/parameters/virtualBackgroundsDisabled.yaml'
103105
- $ref: '../components/parameters/checksum.yaml'

‎openapi/paths/createHook.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
get:
2-
operationId: createHook
3-
description: Create a Hook to receive events from api-webhooks
2+
summary: create
3+
operationId: hooks-create
4+
description: Create a Hook to receive events of meetings based on scope.
45
tags:
56
- hooks
67
parameters:
78
- $ref: '../components/parameters/callbackURL.yaml'
89
required: true
910
- $ref: '../components/parameters/meetingID.yaml'
10-
required: true
1111
- $ref: '../components/parameters/enabled.yaml'
1212
- $ref: '../components/parameters/checksum.yaml'
1313

‎openapi/paths/deleteRecordings.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
summary: deleteRecordings
23
operationId: deleteRecordings
34
description: Delete one or more recordings for a given recordID (or set of record IDs).
45
tags:

‎openapi/paths/destroy.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
get:
2-
operationId: destroy
2+
summary: destroy
3+
operationId: hooks-destroy
34
description: Delete a specific hook based on the given hook id.
4-
Only the secret which was used in the creation of this hook is enable to do this operation.
5+
Only global secrets or the secret which was used in the creation of this hook can do this operation.
56
tags:
67
- hooks
78
parameters:

‎openapi/paths/end.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
get:
2-
operationId: end
2+
summary: end
3+
operationId: end-meeting
34
description: Use this to forcibly end a meeting and kick all participants out of the meeting.
45
tags:
56
- meeting

‎openapi/paths/getAllMeetings.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
summary: getAllMeetings
23
operationId: getAllMeetings
34
description:
45
$ref: '../../docs/getAllMeetings/description.md'

‎openapi/paths/getDefaultConfigXML.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
summary: getDefaultConfigXML
23
operationId: getDefaultConfigXML
34
description: Retrieve the default `config.xml`.
45
deprecated: true

‎openapi/paths/getMeetingInfo.yaml

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
get:
2-
operationId: getMeetingInfo
3-
description: Returns information about a meeting
4-
tags:
5-
- meeting
6-
parameters:
7-
- $ref: '../components/parameters/meetingID.yaml'
8-
required: true
9-
- $ref: '../components/parameters/checksum.yaml'
10-
responses:
11-
'200':
12-
description: Successful operation
13-
content:
14-
application/xml:
15-
examples:
16-
$ref: '../components/examples/getMeetingInfo/success.yaml'
17-
schema:
18-
$ref: "../components/schemas/responses/getMeetingInfo.yaml"
1+
get:
2+
summary: getMeetingInfo
3+
operationId: getMeetingInfo
4+
description: Returns information about a meeting
5+
tags:
6+
- meeting
7+
parameters:
8+
- $ref: '../components/parameters/meetingID.yaml'
9+
required: true
10+
- $ref: '../components/parameters/checksum.yaml'
11+
responses:
12+
'200':
13+
description: Successful operation
14+
content:
15+
application/xml:
16+
examples:
17+
$ref: '../components/examples/getMeetingInfo/success.yaml'
18+
schema:
19+
$ref: "../components/schemas/responses/getMeetingInfo.yaml"

‎openapi/paths/getMeetings.yaml

+17-16
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
1-
get:
2-
operationId: getMeetings
3-
description: This call will return a list of all the meetings found on the servers based on the scope of the secret.
4-
tags:
5-
- meeting
6-
parameters:
7-
- $ref: '../components/parameters/checksum.yaml'
8-
responses:
9-
'200':
10-
description: Successful operation
11-
content:
12-
application/xml:
13-
examples:
14-
$ref: '../components/examples/getMeetings/success.yaml'
15-
schema:
16-
$ref: '../components/schemas/responses/getMeetings.yaml'
1+
get:
2+
summary: getMeetings
3+
operationId: getMeetings
4+
description: This call will return a list of all the meetings found on the servers based on the scope of the secret.
5+
tags:
6+
- meeting
7+
parameters:
8+
- $ref: '../components/parameters/checksum.yaml'
9+
responses:
10+
'200':
11+
description: Successful operation
12+
content:
13+
application/xml:
14+
examples:
15+
$ref: '../components/examples/getMeetings/success.yaml'
16+
schema:
17+
$ref: '../components/schemas/responses/getMeetings.yaml'

‎openapi/paths/getRecordingToken.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
summary: getRecordingToken
23
operationId: getRecordingToken
34
description: This call returns a JWT which gives access to the recording of the specified meeting.
45
tags:

‎openapi/paths/getRecordings.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
get:
2+
summary: getRecordings
23
operationId: getRecordings
34
description:
45
$ref: '../../docs/getRecordings/description.md'

0 commit comments

Comments
 (0)