From 5c710d329b16efb947a6d25793f6a0f7865f3df1 Mon Sep 17 00:00:00 2001
From: Fabian Mastenbroek <mail.fabianm@gmail.com>
Date: Sun, 16 May 2021 11:43:03 +0200
Subject: api: Add Swagger UI for API documentation

This change adds Swagger UI to the REST API endpoint in order to
experiment with the API endpoints interactively. It also serves as the
documentation for the API endpoints.
---
 opendc-api-spec.yml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'opendc-api-spec.yml')

diff --git a/opendc-api-spec.yml b/opendc-api-spec.yml
index 1f7c5697..c23b2f3d 100644
--- a/opendc-api-spec.yml
+++ b/opendc-api-spec.yml
@@ -3,11 +3,25 @@ info:
   version: 2.0.0
   title: OpenDC API
   description: 'OpenDC is an open-source datacenter simulator for education, featuring real-time online collaboration, diverse simulation models, and detailed performance feedback statistics.'
-host: opendc.org
+host: api.opendc.org
 basePath: /v2
 schemes:
   - https
 
+security:
+  - auth0:
+      - openid
+
+securityDefinitions:
+  auth0:
+    type: oauth2
+    scopes:
+      openid: Grants access to user_id
+    flow: accessCode
+    authorizationUrl: https://opendc.eu.auth0.com/authorize
+    tokenUrl: https://opendc.eu.auth0.com/oauth/token
+    x-token-validation-url: https://opendc.eu.auth0.com/userinfo
+
 paths:
   '/projects':
     get:
-- 
cgit v1.2.3