From 68f48a163b60dbea2aa8a15aab7041b10391c3f4 Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Wed, 8 Jan 2025 11:51:02 +0100
Subject: [PATCH] Add checkin bundle submodule

---
 .gitmodules                           |  3 +++
 docs/components/api/check-in/index.md | 31 ---------------------------
 docs/components/api/checkin           |  1 +
 mkdocs.yml                            |  4 ++--
 submodules/relay-checking-bundle      |  1 +
 5 files changed, 7 insertions(+), 33 deletions(-)
 delete mode 100644 docs/components/api/check-in/index.md
 create mode 120000 docs/components/api/checkin
 create mode 160000 submodules/relay-checking-bundle

diff --git a/.gitmodules b/.gitmodules
index 57dfc16..0932df8 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -70,3 +70,6 @@
 [submodule "submodules/relay-cabinet-connector-campusonline-bundle"]
 	path = submodules/relay-cabinet-connector-campusonline-bundle
 	url = https://github.com/digital-blueprint/relay-cabinet-connector-campusonline-bundle
+[submodule "submodules/relay-checking-bundle"]
+	path = submodules/relay-checking-bundle
+	url = https://github.com/digital-blueprint/relay-checkin-bundle
diff --git a/docs/components/api/check-in/index.md b/docs/components/api/check-in/index.md
deleted file mode 100644
index 30b2aea..0000000
--- a/docs/components/api/check-in/index.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# Overview
-
-[GitHub](https://github.com/digital-blueprint/relay-checkin-bundle) |
-[Packagist](https://packagist.org/packages/dbp/relay-checkin-bundle)
-
-This bundle provides an API for interacting with a [Campus QR](https://github.com/studo-app/campus-qr) server. It allows to:
-
-* Query locations
-* Check in/out of those locations
-* Check in/out external guests of those locations
-
-## Configuration
-
-```yaml
-dbp_location_check_in:
-  campus_qr_url: '' # The URL to the Campus QR server
-  campus_qr_token: '' # The token for accessing the API
-```
-
-## Security
-
-To interact with this bundle the user needs to be fully authenticated.
-
-There are two roles that are required for using the provided endpoints:
-
-* `ROLE_SCOPE_LOCATION-CHECK-IN`: Check-in and check-out for the authenticated
-  user
-
-* `ROLE_SCOPE_LOCATION-CHECK-IN-GUEST`: Check-in and check-out for external
-  guest users. It's recommended to only give this to trusted users to avoid
-  bogus check-in/out requests.
diff --git a/docs/components/api/checkin b/docs/components/api/checkin
new file mode 120000
index 0000000..d9afc40
--- /dev/null
+++ b/docs/components/api/checkin
@@ -0,0 +1 @@
+../../../submodules/relay-checking-bundle/docs
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index 852a2cb..13afeef 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -138,7 +138,7 @@ nav:
       - Authentic Documents Bundle:
         - components/api/authentic-documents/README.md
       - Check In Bundle:
-        - components/api/check-in/index.md
+        - components/api/checkin/README.md
       - Mono Bundle:
         - components/api/mono/README.md
         - components/api/mono/config.md
@@ -176,7 +176,7 @@ nav:
       - Blob Library:
         - components/supporting-software/blob-library/README.md
         - components/supporting-software/blob-library/api.md
-        - components/supporting-software/blob-library/error-codes.md
+        - components/supporting-software/blob-library/error-codescheck-in.md
 
     - Archived Components:
       - Greenlight Bundle:
diff --git a/submodules/relay-checking-bundle b/submodules/relay-checking-bundle
new file mode 160000
index 0000000..0417a8b
--- /dev/null
+++ b/submodules/relay-checking-bundle
@@ -0,0 +1 @@
+Subproject commit 0417a8b998afd2ef24fd783ce543ef4b47e101e9