added spec generation

Author: Andrei Neagu

services/notifications/.env-devel

@@ -0,0 +1,14 @@
+SC_BOOT_MODE=debug
+
+RABBIT_HOST=rabbit
+RABBIT_PASSWORD=adminadmin
+RABBIT_PORT=5672
+RABBIT_SECURE=false
+RABBIT_USER=admin
+
+POSTGRES_DB=simcoredb
+POSTGRES_ENDPOINT=postgres:5432
+POSTGRES_HOST=postgres
+POSTGRES_PASSWORD=adminadmin
+POSTGRES_PORT=5432
+POSTGRES_USER=scu

services/notifications/Makefile

@@ -3,3 +3,16 @@
 #
 include ../../scripts/common.Makefile
 include ../../scripts/common-service.Makefile
+
+
+.PHONY: openapi.json
+openapi-specs: openapi.json
+openapi.json: .env
+	# generating openapi specs file (need to have the environment set for this)
+	@set -o allexport; \
+	source $<; \
+	set +o allexport; \
+	python3 -c "import json; from $(APP_PACKAGE_NAME).main import *; print( json.dumps(the_app.openapi(), indent=2) )" > $@
+
+	# validates OAS file: $@
+	$(call validate_openapi_specs,$@)

services/notifications/openapi.json

@@ -0,0 +1,66 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "simcore-service-notifications",
+    "description": "Service for executing commands on docker nodes",
+    "version": "0.0.1"
+  },
+  "servers": [
+    {
+      "url": "/",
+      "description": "Default server: requests directed to serving url"
+    },
+    {
+      "url": "http://{host}:{port}",
+      "description": "Development server: can configure any base url",
+      "variables": {
+        "host": {
+          "default": "127.0.0.1"
+        },
+        "port": {
+          "default": "8000"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/health": {
+      "get": {
+        "summary": "Check Service Health",
+        "operationId": "check_service_health_health_get",
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HealthCheckGet"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "HealthCheckGet": {
+        "properties": {
+          "timestamp": {
+            "type": "string",
+            "title": "Timestamp"
+          }
+        },
+        "type": "object",
+        "required": [
+          "timestamp"
+        ],
+        "title": "HealthCheckGet",
+        "example": {
+          "timestamp": "simcore_service_directorv2.api.routes.health@2023-07-03T12:59:12.024551+00:00"
+        }
+      }
+    }
+  }
+}