Skip to content
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

Jump to bottom

Add OpenAPI specs #38438

Merged
merged 1 commit into from
May 24, 2023
Merged

Add OpenAPI specs #38438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
402 changes: 402 additions & 0 deletions apps/cloud_federation_api/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

293 changes: 293 additions & 0 deletions apps/dashboard/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
{
"openapi": "3.0.3",
"info": {
"title": "dashboard",
"version": "0.0.1",
"description": "Dashboard app",
"license": {
"name": "agpl"
}
},
"components": {
"securitySchemes": {
"basic_auth": {
"type": "http",
"scheme": "basic"
},
"bearer_auth": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"OCSMeta": {
"type": "object",
"required": [
"status",
"statuscode"
],
"properties": {
"status": {
"type": "string"
},
"statuscode": {
"type": "integer"
},
"message": {
"type": "string"
},
"totalitems": {
"type": "string"
},
"itemsperpage": {
"type": "string"
}
}
},
"Widget": {
"type": "object",
"required": [
"id",
"title",
"order",
"icon_class",
"icon_url",
"widget_url",
"item_icons_round"
],
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"order": {
"type": "integer",
"format": "int64"
},
"icon_class": {
"type": "string"
},
"icon_url": {
"type": "string"
},
"widget_url": {
"type": "string",
"nullable": true
},
"item_icons_round": {
"type": "boolean"
},
"buttons": {
"type": "array",
"items": {
"type": "object",
"required": [
"type",
"text",
"link"
],
"properties": {
"type": {
"type": "string"
},
"text": {
"type": "string"
},
"link": {
"type": "string"
}
}
}
}
}
},
"WidgetItem": {
"type": "object",
"required": [
"subtitle",
"title",
"link",
"iconUrl",
"sinceId"
],
"properties": {
"subtitle": {
"type": "string"
},
"title": {
"type": "string"
},
"link": {
"type": "string"
},
"iconUrl": {
"type": "string"
},
"sinceId": {
"type": "string"
}
}
}
}
},
"paths": {
"/ocs/v2.php/apps/dashboard/api/v1/widgets": {
"get": {
"operationId": "dashboard_api-get-widgets",
"summary": "Get the widgets",
"tags": [
"dashboard_api"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "OCS-APIRequest",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "true"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Widget"
}
}
}
}
}
}
}
}
}
}
}
},
"/ocs/v2.php/apps/dashboard/api/v1/widget-items": {
"get": {
"operationId": "dashboard_api-get-widget-items",
"summary": "Get the items for the widgets",
"tags": [
"dashboard_api"
],
"security": [
{
"bearer_auth": []
},
{
"basic_auth": []
}
],
"parameters": [
{
"name": "sinceIds",
"in": "query",
"description": "Array indexed by widget Ids, contains date/id from which we want the new items",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limit number of result items per widget",
"schema": {
"type": "integer",
"format": "int64",
"default": 7
}
},
{
"name": "widgets",
"in": "query",
"description": "Limit results to specific widgets",
"schema": {
"type": "string"
}
},
{
"name": "OCS-APIRequest",
"in": "header",
"required": true,
"schema": {
"type": "string",
"default": "true"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ocs"
],
"properties": {
"ocs": {
"type": "object",
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/OCSMeta"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WidgetItem"
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"tags": []
}