Merge pull request lightspeed-core#387 from tisnik/lcore-433-openapi-metadata

LCORE-433: Support for all OpenAPI metadata

Author: tisnik

docs/openapi.json

@@ -2,13 +2,25 @@
     "openapi": "3.1.0",
     "info": {
         "title": "Lightspeed Core Service (LCS) service - OpenAPI",
+        "summary": "Lightspeed Core Service (LCS) service API specification.",
         "description": "Lightspeed Core Service (LCS) service API specification.",
+        "contact": {
+            "name": "Pavel Tisnovsky",
+            "url": "https://github.com/tisnik/",
+            "email": "ptisnovs@redhat.com"
+        },
         "license": {
             "name": "Apache 2.0",
             "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
         },
         "version": "0.1.3"
     },
+    "servers": [
+        {
+            "url": "http://localhost:8080/",
+            "description": "Locally running service"
+        }
+    ],
     "paths": {
         "/": {
             "get": {

docs/openapi.md

@@ -7,6 +7,7 @@ Lightspeed Core Service (LCS) service API specification.
 
 | URL | Description |
 |-----|-------------|
+| http://localhost:8080/ | Locally running service |
 
 
 # 🛠️ APIs

docs/output.md

@@ -7,6 +7,7 @@ Lightspeed Core Service (LCS) service API specification.
 
 | URL | Description |
 |-----|-------------|
+| http://localhost:8080/ | Locally running service |
 
 
 # 🛠️ APIs

pyproject.toml

@@ -35,6 +35,7 @@ dependencies = [
     "authlib>=1.6.0",
     "openai==1.99.1",
     "sqlalchemy>=2.0.42",
+    "email-validator>=2.2.0",
 ]
 
 [tool.pyright]

scripts/generate_openapi_schema.py

@@ -67,11 +67,14 @@ def read_version_from_pyproject():
     # retrieve OpenAPI schema via initialized app
     open_api = get_openapi(
         title=app.title,
+        summary=app.summary,
         version=app.version,
         openapi_version=app.openapi_version,
         description=app.description,
         routes=app.routes,
         license_info=app.license_info,
+        servers=app.servers,
+        contact=app.contact,
     )
 
     # dump the schema into file

src/app/main.py

@@ -23,12 +23,21 @@
 
 app = FastAPI(
     title=f"{service_name} service - OpenAPI",
+    summary=f"{service_name} service API specification.",
     description=f"{service_name} service API specification.",
     version=version.__version__,
+    contact={
+        "name": "Pavel Tisnovsky",
+        "url": "https://github.com/tisnik/",
+        "email": "ptisnovs@redhat.com",
+    },
     license_info={
         "name": "Apache 2.0",
         "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
     },
+    servers=[
+        {"url": "http://localhost:8080/", "description": "Locally running service"}
+    ],
 )
 
 app.add_middleware(