From 87a1dc8a705f43b53c9b3d061ffd1ec480bb4344 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 6 Oct 2023 10:25:55 +0200
Subject: [PATCH] remove unused auth from oss-params, add deprecation notice to
docs
It's optional, so no existing config should break
---
gso/oss-params-example.json | 1 -
gso/settings.py | 7 +++++--
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/gso/oss-params-example.json b/gso/oss-params-example.json
index a06212ef..771492f6 100644
--- a/gso/oss-params-example.json
+++ b/gso/oss-params-example.json
@@ -48,7 +48,6 @@
"PROVISIONING_PROXY": {
"scheme": "https",
"api_base": "localhost:44444",
- "auth": "Bearer <token>",
"api_version": 1123
}
}
diff --git a/gso/settings.py b/gso/settings.py
index 61c8b776..d7b48048 100644
--- a/gso/settings.py
+++ b/gso/settings.py
@@ -1,6 +1,7 @@
""":term:`GSO` settings.
-Ensuring that the required parameters are set correctly.
+Ensuring that the required parameters are set correctly. An example file ``oss-params-example.json`` is present in the
+:term:`GSO` package itself.
"""
import ipaddress
@@ -83,7 +84,9 @@ class ProvisioningProxyParams(BaseSettings):
scheme: str
api_base: str
- auth: str # FIXME: unfinished
+ #: .. deprecated:: 0.1
+ #: Not used anymore, may be left out from config file.
+ auth: str | None
api_version: int
--
GitLab