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

Add Writerside-based API Reference setup for Bookings_OpenAPIv1

Browse Source 
- Introduced new Writerside configuration files and topics for API documentation.
- Added build profiles, variables, and categories setup.
- Created API topics covering various endpoints including bookings, user operations, and administrative tasks.
This commit is contained in:
Jeppe Bundgaard
2025-11-04 16:58:05 +01:00
parent bfed2f231a
commit fbce187787
21 changed files with 201 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Writerside2/ar.tree
+25
View File
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
<instance-profile id="ar"
name="API Reference" start-page="API_Reference.topic">
<toc-element topic="API_Reference.topic">
<toc-element topic="Create_a_public_booking_entry.topic"/>
<toc-element topic="List_public_booking_entries_for_a_department.topic"/>
<toc-element topic="List_public_booking_types_for_a_department.topic"/>
<toc-element topic="Get_public_opening_hours_for_a_department.topic"/>
<toc-element topic="Delete_own_booking.topic"/>
<toc-element topic="Complete_wash_without_generating_a_certificate.topic"/>
<toc-element topic="Sync_all_bookings_from_external_system.topic"/>
<toc-element topic="Delete_a_booking.topic"/>
<toc-element topic="Get_download_link_for_a_booking_s_wash_certificate_PDF.topic"/>
<toc-element topic="Get_download_link_for_a_booking_s_wash_certificate.topic"/>
<toc-element topic="Get_unfulfilled_bookings_count_for_a_department_today_.topic"/>
<toc-element topic="Sync_or_upsert_a_booking_from_external_system.topic"/>
<toc-element topic="List_bookings_for_the_authenticated_user.topic"/>
<toc-element topic="Update_a_booking_reference_number_.topic"/>
<toc-element topic="List_bookings_or_fetch_a_single_booking_by_id.topic"/>
</toc-element>
</instance-profile>
Writerside2/c.list
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</categories>
Writerside2/cfg/buildprofiles.xml
+13
View File
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<variables></variables>
<build-profile instance="ar">
<variables>
<noindex-content>true</noindex-content>
</variables>
</build-profile>
</buildprofiles>
Writerside2/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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="API Reference" id="API_Reference">
<p>Start typing here...</p>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Complete_wash_without_generating_a_certificate.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Complete wash without generating a certificate" id="Complete_wash_without_generating_a_certificate">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/completeWashWithoutWashCertificate"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Create_a_public_booking_entry.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Create a public booking entry" id="Create_a_public_booking_entry">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/department/timebookings/entries/public"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Delete_a_booking.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Delete a booking" id="Delete_a_booking">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/delete"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Delete_own_booking.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Delete own booking" id="Delete_own_booking">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/user/bookings/delete"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Get download link for a booking&apos;s wash certificate" id="Get_download_link_for_a_booking_s_wash_certificate">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/user/bookings/washcertificate/download"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate_PDF.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Get download link for a booking&apos;s wash certificate PDF" id="Get_download_link_for_a_booking_s_wash_certificate_PDF">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/bookings/download_pdf"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Get_public_opening_hours_for_a_department.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Get public opening hours for a department" id="Get_public_opening_hours_for_a_department">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/opening-hours/public"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Get_unfulfilled_bookings_count_for_a_department_today_.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Get unfulfilled bookings count for a department (today)" id="Get_unfulfilled_bookings_count_for_a_department_today_">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/admin/bookings/department/count"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/List_bookings_for_the_authenticated_user.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="List bookings for the authenticated user" id="List_bookings_for_the_authenticated_user">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/user/bookings"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/List_bookings_or_fetch_a_single_booking_by_id.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="List bookings or fetch a single booking by id" id="List_bookings_or_fetch_a_single_booking_by_id">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/bookings"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_entries_for_a_department.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="List public booking entries for a department" id="List_public_booking_entries_for_a_department">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/entries/public"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_types_for_a_department.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="List public booking types for a department" id="List_public_booking_types_for_a_department">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="GET" endpoint="/department/timebookings/types/public"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Sync_all_bookings_from_external_system.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Sync all bookings from external system" id="Sync_all_bookings_from_external_system">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/superuser/bookings/sync/all"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Sync_or_upsert_a_booking_from_external_system.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Sync or upsert a booking from external system" id="Sync_or_upsert_a_booking_from_external_system">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="POST" endpoint="/admin/bookings/sync"/>
</topic>
Writerside2/topics/Bookings_OpenAPIv1/Update_a_booking_reference_number_.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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Update a booking (reference number)" id="Update_a_booking_reference_number_">
<api-endpoint openapi-path="../../../services/nginx/app/modules/bookings/Bookings_OpenAPIv1.json" method="PUT" endpoint="/bookings"/>
</topic>
Writerside2/v.list
+5
View File
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Writerside"/>
</vars>
Writerside2/writerside.cfg
+8
View File
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="ar.tree"/>
</ihp>