copenhagentruckwash/api
1
0
Fork 0
Code Issues Pull Requests 1 Actions 2 Packages Projects Releases Wiki Activity

Add OpenAPI v1 documentation for Bookings API

Browse Source 
- Introduced Writerside topics for multiple endpoints in the Bookings module, including user, admin, and public time booking routes.
- Added `Bookings_OpenAPIv1.json` specification defining API paths, schemas, and security configurations.
- Included endpoint details for operations like booking retrieval, updates, deletion, syncing, and timebookings.
This commit is contained in:
Jeppe Bundgaard
2026-02-24 11:38:41 +01:00
parent d4007bd495
commit 860b5ac6e3
17 changed files with 625 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Writerside/topics/Bookings_OpenAPIv1/API_Reference.topic
+9
View File
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic id="Bookings_API_Reference"
title="Bookings API Reference"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd">
<p>Bookings API OpenAPI 1.0.0 (separate from XLVask)</p>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Admin_Bookings_CompleteWithoutWashCertificate_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/admin/bookings/completeWashWithoutWashCertificate POST" id="Admin_Bookings_CompleteWithoutWashCertificate_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/completeWashWithoutWashCertificate"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Admin_Bookings_Delete_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/admin/bookings/delete POST" id="Admin_Bookings_Delete_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/delete"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Admin_Bookings_Department_Count_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/admin/bookings/department/count GET" id="Admin_Bookings_Department_Count_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/admin/bookings/department/count"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Admin_Bookings_Sync_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/admin/bookings/sync POST" id="Admin_Bookings_Sync_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/sync"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Bookings_Download_PDF_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/bookings/download_pdf GET" id="Bookings_Download_PDF_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/bookings/download_pdf"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Bookings_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/bookings GET" id="Bookings_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/bookings"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Bookings_PUT.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/bookings PUT" id="Bookings_PUT">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="PUT" endpoint="/bookings"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Department_Timebookings_Entries_Public_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/department/timebookings/entries/public GET" id="Department_Timebookings_Entries_Public_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/entries/public"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Department_Timebookings_Entries_Public_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/department/timebookings/entries/public POST" id="Department_Timebookings_Entries_Public_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/department/timebookings/entries/public"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Department_Timebookings_OpeningHours_Public_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/department/timebookings/opening-hours/public GET" id="Department_Timebookings_OpeningHours_Public_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/opening-hours/public"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Department_Timebookings_Types_Public_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/department/timebookings/types/public GET" id="Department_Timebookings_Types_Public_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/types/public"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/Superuser_Bookings_Sync_All_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/superuser/bookings/sync/all POST" id="Superuser_Bookings_Sync_All_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/superuser/bookings/sync/all"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/User_Bookings_Delete_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/user/bookings/delete POST" id="User_Bookings_Delete_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/user/bookings/delete"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/User_Bookings_GET.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/user/bookings GET" id="User_Bookings_GET">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/user/bookings"/>
</topic>
Writerside/topics/Bookings_OpenAPIv1/User_Bookings_Washcertificate_Download_POST.topic
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="/user/bookings/washcertificate/download POST" id="User_Bookings_Washcertificate_Download_POST">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/user/bookings/washcertificate/download"/>
</topic>