diff --git a/server/src/middleware/__generated__/swagger.json b/server/src/middleware/__generated__/swagger.json index c42d6a50..cf914607 100644 --- a/server/src/middleware/__generated__/swagger.json +++ b/server/src/middleware/__generated__/swagger.json @@ -483,7 +483,7 @@ }, "description": { "type": "string", - "description": "An optional description for this event\r\nThis should be in markdown" + "description": "An optional description for this event\nThis should be in markdown" }, "image_url": { "type": "string", @@ -495,19 +495,19 @@ }, "start_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "The signup period start date.\r\nNote that this date is in UTC time.\r\nUse the same start and end date to indicate a 1 day signup period." + "description": "The signup period start date.\nNote that this date is in UTC time.\nUse the same start and end date to indicate a 1 day signup period." }, "end_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "The signup period end date.\r\nNote that this date is in UTC time." + "description": "The signup period end date.\nNote that this date is in UTC time." }, "physical_start_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "Event start date for the event i.e the day members should meet at shads,\r\n**NOT** the signups, refer to {@link start_date} for signup start" + "description": "Event start date for the event i.e the day members should meet at shads,\n**NOT** the signups, refer to {@link start_date} for signup start" }, "physical_end_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "Event end time for the event i.e the last day members will be at the lodge,\r\nis optionial in case of one day events. **NOT** the signups, refer to\r\n{@link end_date} for signup end date" + "description": "Event end time for the event i.e the last day members will be at the lodge,\nis optionial in case of one day events. **NOT** the signups, refer to\n{@link end_date} for signup end date" }, "max_occupancy": { "type": "number", @@ -536,7 +536,7 @@ }, "nextCursor": { "type": "string", - "description": "Needed for firestore operations which do not support offset\r\nbased pagination\r\n\r\n**Will be undefined in case of last page**" + "description": "Needed for firestore operations which do not support offset\nbased pagination\n\n**Will be undefined in case of last page**" }, "data": { "items": { @@ -1021,7 +1021,7 @@ }, "nextCursor": { "type": "string", - "description": "Needed for firestore operations which do not support offset\r\nbased pagination\r\n\r\n**Will be undefined in case of last page**" + "description": "Needed for firestore operations which do not support offset\nbased pagination\n\n**Will be undefined in case of last page**" }, "data": { "items": { @@ -1276,7 +1276,7 @@ "added_user_to_booking" ], "nullable": false, - "description": "The type of event that the admin performed, used for parsing on the front-end\r\n\r\nEach of these are associated with the following:\r\n\r\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\r\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\r\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" + "description": "The type of event that the admin performed, used for parsing on the front-end\n\nEach of these are associated with the following:\n\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" }, "uid": { "type": "string", @@ -1314,7 +1314,7 @@ "removed_user_from_booking" ], "nullable": false, - "description": "The type of event that the admin performed, used for parsing on the front-end\r\n\r\nEach of these are associated with the following:\r\n\r\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\r\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\r\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" + "description": "The type of event that the admin performed, used for parsing on the front-end\n\nEach of these are associated with the following:\n\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" }, "uid": { "type": "string", @@ -1352,12 +1352,12 @@ "changed_date_availability" ], "nullable": false, - "description": "The type of event that the admin performed, used for parsing on the front-end\r\n\r\nEach of these are associated with the following:\r\n\r\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\r\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\r\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" + "description": "The type of event that the admin performed, used for parsing on the front-end\n\nEach of these are associated with the following:\n\n- `\"added_user_to_booking\"`: {@link BookingAddedEvent}\n- `\"removed_user_from_booking\"`: {@link BookingDeletedEvent}\n- `\"changed_date_availability\"`: {@link BookingAvailabilityChangeEvent}" }, "change": { "type": "number", "format": "double", - "description": "The **signed** difference between the newly available slots and the previously available slots.\r\n\r\nFor example, if the original available slots was 32, and the availability was set to 0,\r\nthe `change` in the slots needs to be **0 - 32 = -32**\r\n\r\nAnd vice versa, if the original available slots was 16, and the availability was set to 32,\r\nthe `change` would be **32 - 16 = 16**" + "description": "The **signed** difference between the newly available slots and the previously available slots.\n\nFor example, if the original available slots was 32, and the availability was set to 0,\nthe `change` in the slots needs to be **0 - 32 = -32**\n\nAnd vice versa, if the original available slots was 16, and the availability was set to 32,\nthe `change` would be **32 - 16 = 16**" } }, "required": [ @@ -1388,7 +1388,7 @@ "properties": { "nextCursor": { "type": "string", - "description": "Needed for firestore operations which do not support offset\r\nbased pagination\r\n\r\n**Will be undefined in case of last page**" + "description": "Needed for firestore operations which do not support offset\nbased pagination\n\n**Will be undefined in case of last page**" }, "error": { "type": "string" @@ -1426,7 +1426,7 @@ }, "description": { "type": "string", - "description": "An optional description for this event\r\nThis should be in markdown" + "description": "An optional description for this event\nThis should be in markdown" }, "image_url": { "type": "string", @@ -1438,19 +1438,19 @@ }, "start_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "The signup period start date.\r\nNote that this date is in UTC time.\r\nUse the same start and end date to indicate a 1 day signup period." + "description": "The signup period start date.\nNote that this date is in UTC time.\nUse the same start and end date to indicate a 1 day signup period." }, "end_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "The signup period end date.\r\nNote that this date is in UTC time." + "description": "The signup period end date.\nNote that this date is in UTC time." }, "physical_start_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "Event start date for the event i.e the day members should meet at shads,\r\n**NOT** the signups, refer to {@link start_date} for signup start" + "description": "Event start date for the event i.e the day members should meet at shads,\n**NOT** the signups, refer to {@link start_date} for signup start" }, "physical_end_date": { "$ref": "#/components/schemas/FirebaseFirestore.Timestamp", - "description": "Event end time for the event i.e the last day members will be at the lodge,\r\nis optionial in case of one day events. **NOT** the signups, refer to\r\n{@link end_date} for signup end date" + "description": "Event end time for the event i.e the last day members will be at the lodge,\nis optionial in case of one day events. **NOT** the signups, refer to\n{@link end_date} for signup end date" }, "max_occupancy": { "type": "number", @@ -1643,7 +1643,7 @@ "description": "Webhook post received" } }, - "description": "Webhook endpoint for Stripe events.\r\nThis single endpoint is setup in the Stripe developer config to handle various events.", + "description": "Webhook endpoint for Stripe events.\nThis single endpoint is setup in the Stripe developer config to handle various events.", "security": [], "parameters": [] } @@ -1826,7 +1826,7 @@ } } }, - "description": "Creates a new booking session for the date ranges passed in,\r\nwill return any existing sessions if they have been started in\r\nthe last 30 minutes (the minimum period stripe has to persist a session for)", + "description": "Creates a new booking session for the date ranges passed in,\nwill return any existing sessions if they have been started in\nthe last 30 minutes (the minimum period stripe has to persist a session for)", "security": [ { "jwt": [ @@ -1894,7 +1894,7 @@ } } }, - "description": "Fetches latest events starting from the event with the latest starting date\r\n(**NOT** the signup open date) based on limit. Is paginated with a cursor", + "description": "Fetches latest events starting from the event with the latest starting date\n(**NOT** the signup open date) based on limit. Is paginated with a cursor", "security": [], "parameters": [ { @@ -1926,7 +1926,7 @@ "description": "No content" } }, - "description": "Streams the signup count for active events signups.\r\nNote that when testing this on swagger, the connection will remain open.", + "description": "Streams the signup count for active events signups.\nNote that when testing this on swagger, the connection will remain open.", "security": [], "parameters": [] } @@ -2010,7 +2010,7 @@ } } }, - "description": "This method fetches users based on a booking date range.\r\nThis method requires an admin JWT token.", + "description": "This method fetches users based on a booking date range.\nThis method requires an admin JWT token.", "security": [ { "jwt": [ @@ -2246,7 +2246,7 @@ } } }, - "description": "Get a user by their UID.\r\nRequires an admin JWT token.", + "description": "Get a user by their UID.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2275,7 +2275,7 @@ "description": "Created" } }, - "description": "Adds a new user to the database with their UID and user data.\r\nRequires an admin JWT token.", + "description": "Adds a new user to the database with their UID and user data.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2306,7 +2306,7 @@ "description": "Edited" } }, - "description": "Edits a list of users with updated user additional info.\r\nRequires an admin JWT token.", + "description": "Edits a list of users with updated user additional info.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2337,7 +2337,7 @@ "description": "Promoted user" } }, - "description": "Promotes a user to a member. This returns a conflict when the user is already a member.\r\nRequires an admin JWT token.", + "description": "Promotes a user to a member. This returns a conflict when the user is already a member.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2368,7 +2368,7 @@ "description": "Demoted user" } }, - "description": "Demotes a member to a guest. This returns a conflict when the user is already a guest.\r\nRequires an admin JWT token.", + "description": "Demotes a member to a guest. This returns a conflict when the user is already a guest.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2399,7 +2399,7 @@ "description": "Demoted all non-admin users" } }, - "description": "Demotes all non-admin users to guests. This is used to purge all membership statuses at the end of a billing cycle.\r\nRequires an admin JWT token.", + "description": "Demotes all non-admin users to guests. This is used to purge all membership statuses at the end of a billing cycle.\nRequires an admin JWT token.", "security": [ { "jwt": [ @@ -2418,7 +2418,7 @@ "description": "Coupon Added" } }, - "description": "Adds a coupon to a user's stripe id.\r\nRequires an admin JWT token.", + "description": "Adds a coupon to a user's stripe id.\nRequires an admin JWT token.", "security": [ { "jwt": [