Skip to content

Commit ebfa9b1

Browse files
authored
Add v2 API specs to swagger UI (#991)
2 parents bd122bb + 8489f78 commit ebfa9b1

File tree

91 files changed

+148
-11003
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+148
-11003
lines changed

.github/workflows/docusaurus-deploy.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ ts/
1818
!.yarn/releases
1919
!.yarn/sdks
2020
!.yarn/versions
21-
docusaurus/video/docusaurus/shared
2221
node_modules/.yarn-integrity
2322

2423
node_modules

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,4 @@ docker run --platform=linux/amd64 -v $(pwd):/local ghcr.io/getstream/protobuf-ge
102102

103103
## Video API and server-side SDK documentation
104104

105-
This repository hosts the [API and server-side SDK documentation](https://getstream.io/video/docs/api/) for video.
106-
107-
For more info please see [the nested readme file](./docusaurus/video/docusaurus/README.md)
105+
Is hosted here: https://github.com/GetStream/docs-content

docs/chat_v2_openapi.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- HTML for static distribution bundle build -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8" />
6+
<title>Swagger UI</title>
7+
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
8+
<link rel="stylesheet" type="text/css" href="dist/index.css" />
9+
<link
10+
data-react-helmet="true"
11+
rel="icon"
12+
type="image/png"
13+
sizes="32x32"
14+
href="dist/favicon-32x32.png"
15+
/>
16+
<link
17+
data-react-helmet="true"
18+
rel="icon"
19+
type="image/png"
20+
sizes="96x96"
21+
href="dist/favicon-96x96.png"
22+
/>
23+
</head>
24+
25+
<body>
26+
<div id="swagger-ui"></div>
27+
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
28+
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
29+
<script src="dist/swagger-initializer_chat_v2.js" charset="UTF-8"></script>
30+
</body>
31+
</html>

docs/dist/swagger-initializer.js

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
1-
window.onload = function() {
1+
window.onload = function () {
22
window.ui = SwaggerUIBundle({
33
urls: [
44
{
5-
name: "Chat",
6-
url:"https://raw.githubusercontent.com/GetStream/protocol/main/openapi/chat-openapi.yaml"
5+
name: 'Chat',
6+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/chat-openapi.yaml',
77
},
88
{
9-
name: "Video",
10-
url:"https://raw.githubusercontent.com/GetStream/protocol/main/openapi/video-openapi.yaml"
11-
}
9+
name: 'Video',
10+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/video-openapi.yaml',
11+
},
12+
{
13+
name: 'Chat v2',
14+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/chat-serverside-api.yaml',
15+
},
16+
{
17+
name: 'Video v2',
18+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/video-serverside-api.yaml',
19+
},
20+
{
21+
name: 'Moderation v2',
22+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/moderation-serverside-api.yaml',
23+
},
1224
],
1325
dom_id: '#swagger-ui',
1426
deepLinking: true,
15-
presets: [
16-
SwaggerUIBundle.presets.apis,
17-
SwaggerUIStandalonePreset
18-
],
19-
plugins: [
20-
SwaggerUIBundle.plugins.DownloadUrl,
21-
],
22-
layout: "StandaloneLayout"
27+
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
28+
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
29+
layout: 'StandaloneLayout',
2330
});
2431
};
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
window.onload = function () {
2+
window.ui = SwaggerUIBundle({
3+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/chat-serverside-api.yaml',
4+
dom_id: '#swagger-ui',
5+
deepLinking: true,
6+
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
7+
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
8+
layout: 'StandaloneLayout',
9+
});
10+
};
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
window.onload = function () {
2+
window.ui = SwaggerUIBundle({
3+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/moderation-serverside-api.yaml',
4+
dom_id: '#swagger-ui',
5+
deepLinking: true,
6+
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
7+
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
8+
layout: 'StandaloneLayout',
9+
});
10+
};
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
window.onload = function () {
2+
window.ui = SwaggerUIBundle({
3+
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/video-serverside-api.yaml',
4+
dom_id: '#swagger-ui',
5+
deepLinking: true,
6+
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
7+
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
8+
layout: 'StandaloneLayout',
9+
});
10+
};

docs/moderation_v2_openapi.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- HTML for static distribution bundle build -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8" />
6+
<title>Swagger UI</title>
7+
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
8+
<link rel="stylesheet" type="text/css" href="dist/index.css" />
9+
<link
10+
data-react-helmet="true"
11+
rel="icon"
12+
type="image/png"
13+
sizes="32x32"
14+
href="dist/favicon-32x32.png"
15+
/>
16+
<link
17+
data-react-helmet="true"
18+
rel="icon"
19+
type="image/png"
20+
sizes="96x96"
21+
href="dist/favicon-96x96.png"
22+
/>
23+
</head>
24+
25+
<body>
26+
<div id="swagger-ui"></div>
27+
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
28+
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
29+
<script
30+
src="dist/swagger-initializer_moderation_v2.js"
31+
charset="UTF-8"
32+
></script>
33+
</body>
34+
</html>

docs/video_v2_openapi.html

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!-- HTML for static distribution bundle build -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="UTF-8" />
6+
<title>Swagger UI</title>
7+
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
8+
<link rel="stylesheet" type="text/css" href="dist/index.css" />
9+
<link
10+
data-react-helmet="true"
11+
rel="icon"
12+
type="image/png"
13+
sizes="32x32"
14+
href="dist/favicon-32x32.png"
15+
/>
16+
<link
17+
data-react-helmet="true"
18+
rel="icon"
19+
type="image/png"
20+
sizes="96x96"
21+
href="dist/favicon-96x96.png"
22+
/>
23+
</head>
24+
25+
<body>
26+
<div id="swagger-ui"></div>
27+
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
28+
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
29+
<script src="dist/swagger-initializer_video_v2.js" charset="UTF-8"></script>
30+
</body>
31+
</html>

0 commit comments

Comments
 (0)