From fbce187787979c996c4558595e9713d77bae9fb7 Mon Sep 17 00:00:00 2001 From: Jeppe Bundgaard Date: Tue, 4 Nov 2025 16:58:05 +0100 Subject: [PATCH] Add Writerside-based API Reference setup for Bookings_OpenAPIv1 - 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. --- Writerside2/ar.tree | 25 +++++++++++++++++++ Writerside2/c.list | 6 +++++ Writerside2/cfg/buildprofiles.xml | 13 ++++++++++ .../Bookings_OpenAPIv1/API_Reference.topic | 9 +++++++ ...ash_without_generating_a_certificate.topic | 9 +++++++ .../Create_a_public_booking_entry.topic | 9 +++++++ .../Bookings_OpenAPIv1/Delete_a_booking.topic | 9 +++++++ .../Delete_own_booking.topic | 9 +++++++ ...ink_for_a_booking_s_wash_certificate.topic | 9 +++++++ ...for_a_booking_s_wash_certificate_PDF.topic | 9 +++++++ ...ublic_opening_hours_for_a_department.topic | 9 +++++++ ...okings_count_for_a_department_today_.topic | 9 +++++++ ..._bookings_for_the_authenticated_user.topic | 9 +++++++ ...ings_or_fetch_a_single_booking_by_id.topic | 9 +++++++ ...lic_booking_entries_for_a_department.topic | 9 +++++++ ...ublic_booking_types_for_a_department.topic | 9 +++++++ ...nc_all_bookings_from_external_system.topic | 9 +++++++ ...psert_a_booking_from_external_system.topic | 9 +++++++ .../Update_a_booking_reference_number_.topic | 9 +++++++ Writerside2/v.list | 5 ++++ Writerside2/writerside.cfg | 8 ++++++ 21 files changed, 201 insertions(+) create mode 100644 Writerside2/ar.tree create mode 100644 Writerside2/c.list create mode 100644 Writerside2/cfg/buildprofiles.xml create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/API_Reference.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Complete_wash_without_generating_a_certificate.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Create_a_public_booking_entry.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Delete_a_booking.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Delete_own_booking.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate_PDF.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Get_public_opening_hours_for_a_department.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Get_unfulfilled_bookings_count_for_a_department_today_.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/List_bookings_for_the_authenticated_user.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/List_bookings_or_fetch_a_single_booking_by_id.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_entries_for_a_department.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_types_for_a_department.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Sync_all_bookings_from_external_system.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Sync_or_upsert_a_booking_from_external_system.topic create mode 100644 Writerside2/topics/Bookings_OpenAPIv1/Update_a_booking_reference_number_.topic create mode 100644 Writerside2/v.list create mode 100644 Writerside2/writerside.cfg diff --git a/Writerside2/ar.tree b/Writerside2/ar.tree new file mode 100644 index 00000000..9921bc5d --- /dev/null +++ b/Writerside2/ar.tree @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Writerside2/c.list b/Writerside2/c.list new file mode 100644 index 00000000..c4c77a29 --- /dev/null +++ b/Writerside2/c.list @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/Writerside2/cfg/buildprofiles.xml b/Writerside2/cfg/buildprofiles.xml new file mode 100644 index 00000000..76339965 --- /dev/null +++ b/Writerside2/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ + + + + + + + + true + + + + diff --git a/Writerside2/topics/Bookings_OpenAPIv1/API_Reference.topic b/Writerside2/topics/Bookings_OpenAPIv1/API_Reference.topic new file mode 100644 index 00000000..586298c9 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/API_Reference.topic @@ -0,0 +1,9 @@ + + + + +

Start typing here...

+
\ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Complete_wash_without_generating_a_certificate.topic b/Writerside2/topics/Bookings_OpenAPIv1/Complete_wash_without_generating_a_certificate.topic new file mode 100644 index 00000000..9384fb8c --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Complete_wash_without_generating_a_certificate.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Create_a_public_booking_entry.topic b/Writerside2/topics/Bookings_OpenAPIv1/Create_a_public_booking_entry.topic new file mode 100644 index 00000000..aaa3df9d --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Create_a_public_booking_entry.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Delete_a_booking.topic b/Writerside2/topics/Bookings_OpenAPIv1/Delete_a_booking.topic new file mode 100644 index 00000000..a71c8997 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Delete_a_booking.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Delete_own_booking.topic b/Writerside2/topics/Bookings_OpenAPIv1/Delete_own_booking.topic new file mode 100644 index 00000000..b1a87aed --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Delete_own_booking.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate.topic b/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate.topic new file mode 100644 index 00000000..4f43bdb8 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate_PDF.topic b/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate_PDF.topic new file mode 100644 index 00000000..1c277ef8 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Get_download_link_for_a_booking_s_wash_certificate_PDF.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Get_public_opening_hours_for_a_department.topic b/Writerside2/topics/Bookings_OpenAPIv1/Get_public_opening_hours_for_a_department.topic new file mode 100644 index 00000000..a90853fd --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Get_public_opening_hours_for_a_department.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Get_unfulfilled_bookings_count_for_a_department_today_.topic b/Writerside2/topics/Bookings_OpenAPIv1/Get_unfulfilled_bookings_count_for_a_department_today_.topic new file mode 100644 index 00000000..6eaf9c69 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Get_unfulfilled_bookings_count_for_a_department_today_.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_for_the_authenticated_user.topic b/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_for_the_authenticated_user.topic new file mode 100644 index 00000000..a295785f --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_for_the_authenticated_user.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_or_fetch_a_single_booking_by_id.topic b/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_or_fetch_a_single_booking_by_id.topic new file mode 100644 index 00000000..63e84f5d --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/List_bookings_or_fetch_a_single_booking_by_id.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_entries_for_a_department.topic b/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_entries_for_a_department.topic new file mode 100644 index 00000000..6da30979 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_entries_for_a_department.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_types_for_a_department.topic b/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_types_for_a_department.topic new file mode 100644 index 00000000..6dd17a6c --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/List_public_booking_types_for_a_department.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Sync_all_bookings_from_external_system.topic b/Writerside2/topics/Bookings_OpenAPIv1/Sync_all_bookings_from_external_system.topic new file mode 100644 index 00000000..d42f1d34 --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Sync_all_bookings_from_external_system.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Sync_or_upsert_a_booking_from_external_system.topic b/Writerside2/topics/Bookings_OpenAPIv1/Sync_or_upsert_a_booking_from_external_system.topic new file mode 100644 index 00000000..e333975b --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Sync_or_upsert_a_booking_from_external_system.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/topics/Bookings_OpenAPIv1/Update_a_booking_reference_number_.topic b/Writerside2/topics/Bookings_OpenAPIv1/Update_a_booking_reference_number_.topic new file mode 100644 index 00000000..63acf0ed --- /dev/null +++ b/Writerside2/topics/Bookings_OpenAPIv1/Update_a_booking_reference_number_.topic @@ -0,0 +1,9 @@ + + + + + + \ No newline at end of file diff --git a/Writerside2/v.list b/Writerside2/v.list new file mode 100644 index 00000000..2d12cb39 --- /dev/null +++ b/Writerside2/v.list @@ -0,0 +1,5 @@ + + + + + diff --git a/Writerside2/writerside.cfg b/Writerside2/writerside.cfg new file mode 100644 index 00000000..1f2766d8 --- /dev/null +++ b/Writerside2/writerside.cfg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file