From 0994ea6bedc16c146d5aee3642ddb60eafd80306 Mon Sep 17 00:00:00 2001
From: Evilham <contact@evilham.com>
Date: Thu, 15 Dec 2022 12:36:00 +0100
Subject: [PATCH] NotaBLE: add information about the project
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.

És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics, guanyador
de la Ciutat Proactiva 2021, suport a la innovació urbana de la
Fundació BitHabitat.
---
 dd-sso/admin/src/admin/views/ApiViews.py       |  9 +++++++++
 .../src/admin/views/api_docs/group_delete.yml  |  6 ++++++
 .../src/admin/views/api_docs/group_get.yml     |  6 ++++++
 .../src/admin/views/api_docs/group_new.yml     |  6 ++++++
 .../admin/src/admin/views/api_docs/groups.yml  |  6 ++++++
 .../src/admin/views/api_docs/role_users.yml    |  6 ++++++
 .../admin/src/admin/views/api_docs/roles.yml   |  6 ++++++
 .../src/admin/views/api_docs/user_delete.yml   |  6 ++++++
 .../src/admin/views/api_docs/user_get.yml      |  6 ++++++
 .../src/admin/views/api_docs/user_new.yml      |  6 ++++++
 .../src/admin/views/api_docs/user_put.yml      |  6 ++++++
 .../admin/src/admin/views/api_docs/users.yml   |  6 ++++++
 .../src/admin/views/api_docs/users_filter.yml  |  6 ++++++
 dd-sso/admin/src/admin/views/test/__init__.py  |  9 +++++++++
 dd-sso/admin/src/admin/views/test/mocks.py     |  8 +++++++-
 .../src/admin/views/test/test_ApiViews.py      | 18 ++++++++++++++++++
 16 files changed, 115 insertions(+), 1 deletion(-)

diff --git a/dd-sso/admin/src/admin/views/ApiViews.py b/dd-sso/admin/src/admin/views/ApiViews.py
index c7d753a..1a86bd9 100644
--- a/dd-sso/admin/src/admin/views/ApiViews.py
+++ b/dd-sso/admin/src/admin/views/ApiViews.py
@@ -18,6 +18,15 @@
 #   along with DD. If not, see <https://www.gnu.org/licenses/>.
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
+
+"""
+NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+
+És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+la Fundació BitHabitat.
+"""
+
 import copy
 import json
 import logging as log
diff --git a/dd-sso/admin/src/admin/views/api_docs/group_delete.yml b/dd-sso/admin/src/admin/views/api_docs/group_delete.yml
index 56e2ce4..3f46fda 100644
--- a/dd-sso/admin/src/admin/views/api_docs/group_delete.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/group_delete.yml
@@ -1,5 +1,11 @@
 Delete a registered group in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/group_get.yml b/dd-sso/admin/src/admin/views/api_docs/group_get.yml
index 7c41a8a..f3f6620 100644
--- a/dd-sso/admin/src/admin/views/api_docs/group_get.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/group_get.yml
@@ -1,5 +1,11 @@
 Get a registered group in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/group_new.yml b/dd-sso/admin/src/admin/views/api_docs/group_new.yml
index a9e85b4..c1788e8 100644
--- a/dd-sso/admin/src/admin/views/api_docs/group_new.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/group_new.yml
@@ -1,5 +1,11 @@
 Register a new group in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/groups.yml b/dd-sso/admin/src/admin/views/api_docs/groups.yml
index 4fd76a2..9834328 100644
--- a/dd-sso/admin/src/admin/views/api_docs/groups.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/groups.yml
@@ -1,5 +1,11 @@
 List all registered groups on DD.
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 definitions:
   Group:
     type: object
diff --git a/dd-sso/admin/src/admin/views/api_docs/role_users.yml b/dd-sso/admin/src/admin/views/api_docs/role_users.yml
index 01bbc65..0f1e251 100644
--- a/dd-sso/admin/src/admin/views/api_docs/role_users.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/role_users.yml
@@ -1,5 +1,11 @@
 List registered users on DD with a the given role.
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/roles.yml b/dd-sso/admin/src/admin/views/api_docs/roles.yml
index 0d66abd..e03193c 100644
--- a/dd-sso/admin/src/admin/views/api_docs/roles.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/roles.yml
@@ -1,5 +1,11 @@
 List all roles configured on DD.
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 definitions:
   Role:
     type: object
diff --git a/dd-sso/admin/src/admin/views/api_docs/user_delete.yml b/dd-sso/admin/src/admin/views/api_docs/user_delete.yml
index 0b3eeb9..1bb46e1 100644
--- a/dd-sso/admin/src/admin/views/api_docs/user_delete.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/user_delete.yml
@@ -1,5 +1,11 @@
 Delete a registered user in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/user_get.yml b/dd-sso/admin/src/admin/views/api_docs/user_get.yml
index 3e131d7..3876865 100644
--- a/dd-sso/admin/src/admin/views/api_docs/user_get.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/user_get.yml
@@ -1,5 +1,11 @@
 Get a registered user in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/user_new.yml b/dd-sso/admin/src/admin/views/api_docs/user_new.yml
index 9cf8a64..49d61f9 100644
--- a/dd-sso/admin/src/admin/views/api_docs/user_new.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/user_new.yml
@@ -1,5 +1,11 @@
 Register a new user in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 definitions:
   KeycloakId:
     type: object
diff --git a/dd-sso/admin/src/admin/views/api_docs/user_put.yml b/dd-sso/admin/src/admin/views/api_docs/user_put.yml
index 3906bfd..52b2f92 100644
--- a/dd-sso/admin/src/admin/views/api_docs/user_put.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/user_put.yml
@@ -1,5 +1,11 @@
 Modify a user in DD
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/api_docs/users.yml b/dd-sso/admin/src/admin/views/api_docs/users.yml
index 0f95a56..64d305c 100644
--- a/dd-sso/admin/src/admin/views/api_docs/users.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/users.yml
@@ -1,5 +1,11 @@
 List all registered users on DD.
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 definitions:
   User:
     type: object
diff --git a/dd-sso/admin/src/admin/views/api_docs/users_filter.yml b/dd-sso/admin/src/admin/views/api_docs/users_filter.yml
index 0331d85..2d49a0b 100644
--- a/dd-sso/admin/src/admin/views/api_docs/users_filter.yml
+++ b/dd-sso/admin/src/admin/views/api_docs/users_filter.yml
@@ -1,5 +1,11 @@
 List registered users on DD with a filter applied.
 ---
+# NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+#
+# És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+# guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+# la Fundació BitHabitat.
+
 consumes:
   - application/json
 parameters:
diff --git a/dd-sso/admin/src/admin/views/test/__init__.py b/dd-sso/admin/src/admin/views/test/__init__.py
index e69de29..2580a83 100644
--- a/dd-sso/admin/src/admin/views/test/__init__.py
+++ b/dd-sso/admin/src/admin/views/test/__init__.py
@@ -0,0 +1,9 @@
+"""
+Tests for admin.views, particularly the NotaBLE API.
+
+NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+
+És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+la Fundació BitHabitat.
+"""
diff --git a/dd-sso/admin/src/admin/views/test/mocks.py b/dd-sso/admin/src/admin/views/test/mocks.py
index dc053d7..cca0270 100644
--- a/dd-sso/admin/src/admin/views/test/mocks.py
+++ b/dd-sso/admin/src/admin/views/test/mocks.py
@@ -1,5 +1,11 @@
 """
-Mocks to test API views.
+Mock classes to test NotaBLE API from a simple environment.
+
+NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+
+És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+la Fundació BitHabitat.
 """
 import copy
 from typing import Any, Dict, Iterable, List, Optional, cast
diff --git a/dd-sso/admin/src/admin/views/test/test_ApiViews.py b/dd-sso/admin/src/admin/views/test/test_ApiViews.py
index 80b1941..429b9b9 100644
--- a/dd-sso/admin/src/admin/views/test/test_ApiViews.py
+++ b/dd-sso/admin/src/admin/views/test/test_ApiViews.py
@@ -1,4 +1,22 @@
+#!/usr/bin/env python3
 """
+Tests and helper script for NotaBLE API.
+
+From the admin development environment:
+
+The API spec file can be generated with:
+    python -m admin.views.test.test_ApiViews --generate-spec
+
+
+A simple testing ground that serves the Swagger UI can also be started with:
+    python -m admin.views.test.test_ApiViews
+
+
+NotaBLE és la col·laboració entre Gwido i el Workspace educatiu DD.
+
+És un projecte de Xnet, IsardVDI, Gwido i Taller de Músics,
+guanyador de la Ciutat Proactiva 2021, suport a la innovació urbana de
+la Fundació BitHabitat.
 """
 
 import copy