Skip to content

Add v2 API specs to swagger UI #991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
szuperaz merged 4 commits into from
Mar 31, 2025
Merged

Add v2 API specs to swagger UI #991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e811b2b
Add moderation API spec to swagger UI
szuperaz Feb 28, 2025
5b862f3
Add v2 API specs
szuperaz Mar 26, 2025
04ff13f
Remove old docs folder
szuperaz Mar 26, 2025
8489f78
Add missing v2 configs for swagger UI
szuperaz Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 0 additions & 29 deletions .github/workflows/docusaurus-deploy.yml
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ ts/
!.yarn/releases
!.yarn/sdks
!.yarn/versions
docusaurus/video/docusaurus/shared
node_modules/.yarn-integrity

node_modules
4 changes: 1 addition & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,4 @@ docker run --platform=linux/amd64 -v $(pwd):/local ghcr.io/getstream/protobuf-ge

## Video API and server-side SDK documentation

This repository hosts the [API and server-side SDK documentation](https://getstream.io/video/docs/api/) for video.

For more info please see [the nested readme file](./docusaurus/video/docusaurus/README.md)
Is hosted here: https://github.com/GetStream/docs-content
31 changes: 31 additions & 0 deletions docs/chat_v2_openapi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
<link rel="stylesheet" type="text/css" href="dist/index.css" />
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="32x32"
href="dist/favicon-32x32.png"
/>
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="96x96"
href="dist/favicon-96x96.png"
/>
</head>

<body>
<div id="swagger-ui"></div>
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
<script src="dist/swagger-initializer_chat_v2.js" charset="UTF-8"></script>
</body>
</html>
35 changes: 21 additions & 14 deletions docs/dist/swagger-initializer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
window.onload = function() {
window.onload = function () {
window.ui = SwaggerUIBundle({
urls: [
{
name: "Chat",
url:"https://raw.githubusercontent.com/GetStream/protocol/main/openapi/chat-openapi.yaml"
name: 'Chat',
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/chat-openapi.yaml',
},
{
name: "Video",
url:"https://raw.githubusercontent.com/GetStream/protocol/main/openapi/video-openapi.yaml"
}
name: 'Video',
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/video-openapi.yaml',
},
{
name: 'Chat v2',
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/chat-serverside-api.yaml',
},
{
name: 'Video v2',
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/video-serverside-api.yaml',
},
{
name: 'Moderation v2',
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/moderation-serverside-api.yaml',
},
],
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl,
],
layout: "StandaloneLayout"
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
layout: 'StandaloneLayout',
});
};
10 changes: 10 additions & 0 deletions docs/dist/swagger-initializer_chat_v2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
window.onload = function () {
window.ui = SwaggerUIBundle({
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/chat-serverside-api.yaml',
dom_id: '#swagger-ui',
deepLinking: true,
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
layout: 'StandaloneLayout',
});
};
10 changes: 10 additions & 0 deletions docs/dist/swagger-initializer_moderation_v2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
window.onload = function () {
window.ui = SwaggerUIBundle({
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/moderation-serverside-api.yaml',
dom_id: '#swagger-ui',
deepLinking: true,
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
layout: 'StandaloneLayout',
});
};
10 changes: 10 additions & 0 deletions docs/dist/swagger-initializer_video_v2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
window.onload = function () {
window.ui = SwaggerUIBundle({
url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/video-serverside-api.yaml',
dom_id: '#swagger-ui',
deepLinking: true,
presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
plugins: [SwaggerUIBundle.plugins.DownloadUrl],
layout: 'StandaloneLayout',
});
};
34 changes: 34 additions & 0 deletions docs/moderation_v2_openapi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
<link rel="stylesheet" type="text/css" href="dist/index.css" />
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="32x32"
href="dist/favicon-32x32.png"
/>
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="96x96"
href="dist/favicon-96x96.png"
/>
</head>

<body>
<div id="swagger-ui"></div>
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
<script
src="dist/swagger-initializer_moderation_v2.js"
charset="UTF-8"
></script>
</body>
</html>
31 changes: 31 additions & 0 deletions docs/video_v2_openapi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
<link rel="stylesheet" type="text/css" href="dist/index.css" />
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="32x32"
href="dist/favicon-32x32.png"
/>
<link
data-react-helmet="true"
rel="icon"
type="image/png"
sizes="96x96"
href="dist/favicon-96x96.png"
/>
</head>

<body>
<div id="swagger-ui"></div>
<script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
<script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
<script src="dist/swagger-initializer_video_v2.js" charset="UTF-8"></script>
</body>
</html>
1 change: 0 additions & 1 deletion docusaurus/video/.env
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docusaurus/video/docusaurus/.env
View file
Open in desktop

This file was deleted.

23 changes: 0 additions & 23 deletions docusaurus/video/docusaurus/README.md
View file
Open in desktop

This file was deleted.

52 changes: 0 additions & 52 deletions docusaurus/video/docusaurus/docs/api/_common_/CallEventModels.jsx
View file
Open in desktop

This file was deleted.

65 changes: 0 additions & 65 deletions docusaurus/video/docusaurus/docs/api/_common_/OpenApiModels.jsx
View file
Open in desktop

This file was deleted.

Loading