Skip to content

Commit

Permalink
feat: swagger stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
TheClashFruit committed Aug 1, 2024
1 parent 9e6db57 commit f96d329
Showing 1 changed file with 95 additions and 1 deletion.
96 changes: 95 additions & 1 deletion data/swagger.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,97 @@
{
"openapi": "3.0.3"
"openapi": "3.0.3",
"info": {
"title": "Zleed API",
"description": "A free and open-source streaming platform.",
"termsOfService": " https://zleed.tv/legal/tos",
"contact": {
"name": "Zleed",
"url": "https://zleed.tv",
"email": "[email protected]"
},
"license": {
"name": "GNU Affero General Public License v3.0",
"url": "https://github.com/ZleedApp/Pot/blob/main/LICENSE"
},
"version": "v0.0.1-dev"
},
"servers": [
{
"url": "https://api.zleed.tv",
"description": "Production Server"
},
{
"url": "https://api-staging.zleed.tv",
"description": "Staging Server"
},
{
"url": "http://localhost:3000",
"description": "Local Development Server"
}
],
"paths": {
"/": {
"get": {
"description": "Information about the api.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Index"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Index": {
"type": "object",
"properties": {
"latest": {
"type": "integer"
},
"swagger": {
"type": "string"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
}
}
}
},
"Version": {
"type": "object",
"properties": {
"version": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "integer"
}
}
},
"path": {
"type": "string"
},
"changelog": {
"type": "string"
},
"deprecated": {
"type": "boolean"
}
}
}
}
}
}

0 comments on commit f96d329

Please sign in to comment.