Skip to content

Commit d70e230

Browse files
espenclaude
andcommitted
Fix spelling mistakes and attribute inconsistencies in documentation
- Fix typo: authenticaiton → authentication - Fix typo: extented → extended - Fix typo: specyfing → specifying - Fix typo: existing → exciting - Fix attribute names: created_by/updated_by → created_at/updated_at - Fix grammar: will not returned → will not be returned - Fix grammar: will not return → will now return - Fix double period: SMS.. → SMS. - Fix copy-paste errors in provider opening_hours descriptions 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent da959ae commit d70e230

3 files changed

Lines changed: 15 additions & 15 deletions

File tree

changelog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Added booking status endpoint.
4646

4747
**Expandable objects**
4848

49-
The booking endpoint can now expand related objects such as resource and service using the `extented` paramater.
49+
The booking endpoint can now expand related objects such as resource and service using the `extended` parameter.
5050

5151
**Webhook version 2**
5252

@@ -105,7 +105,7 @@ Previously we retried 20 times for failed webhooks. This is now changed to 5 ret
105105

106106
**Added national_id_no and multiple column search for people**
107107

108-
Search can now be done on multiple columns by specyfing for example both email and phone number.
108+
Search can now be done on multiple columns by specifying for example both email and phone number.
109109

110110
## 2021-03-29
111111

@@ -135,7 +135,7 @@ JSON is our only God now.
135135

136136
*BREAKING CHANGE*
137137

138-
All errors based on client request input will not return a 400 Bad Request status code instead of 403 Forbidden.
138+
All errors based on client request input will now return a 400 Bad Request status code instead of 403 Forbidden.
139139

140140
**Lack of authorization now returns 403**
141141

examples_private.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Content-Type: application/json; charset=utf-8
151151

152152
### Initiate new booking for new customer
153153

154-
Now the customer is ready to book. So existing!
154+
Now the customer is ready to book. So exciting!
155155

156156
This is the first example where you will differentiate the request since the goal is to implement a custom booking site. The Makeplans booking site operates based on many settings and rules that define availability. Naturally existing bookings is taken into account so you do not get double bookings (it is possible to add double bookings, but not from the public booking site). And then there is the availability set for the resources; standard opening hours and opening hours set on specific dates. In addition you can set certain rules for when booking is allowed, for example only 2 months ahead or not the same day. You can also set the booking site to be closed during national holidays.
157157
But back to the API. When you make a request to create a new booking in the private API we will ignore most of these rules. These rules are only applicable on the public booking site. So it is very important that you add `public_booking=true` to the request to ensure booking are only allowed during the rules and availability you set on your account and resources. Unless you are authenticated your customers in your app it is also recommended that you let Makeplans handle verification. We will send an SMS that the customer needs to verify to confirm the booking.

readme.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Custom data is stored as key/value. All values are stored as strings but we do c
112112

113113
## Authentication
114114

115-
Only the private API requires authentication. If you intend to use the API on a website please use the [public API](#public-and-private-api) which does not require authenticaiton.
115+
Only the private API requires authentication. If you intend to use the API on a website please use the [public API](#public-and-private-api) which does not require authentication.
116116

117117
Use your account API-Key to authenticate with the Makeplans API. First enable the API on the account and you will find the API-Key in the account settings.
118118

@@ -407,8 +407,8 @@ Response
407407
<table>
408408
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
409409
<tr><td>id</td><td>Integer</td><td>Automatically set</td></tr>
410-
<tr><td>created_by</td><td>DateTime</td><td>Automatically set</td></tr>
411-
<tr><td>updated_by</td><td>DateTime</td><td>Automatically set</td></tr>
410+
<tr><td>created_at</td><td>DateTime</td><td>Automatically set</td></tr>
411+
<tr><td>updated_at</td><td>DateTime</td><td>Automatically set</td></tr>
412412
<tr><td>service_id</td><td>Integer</td><td>Not required</td></tr>
413413
<tr><td>event_id</td><td>Integer</td><td>Not required</td></tr>
414414
<tr><td>resource_id</td><td>Integer</td><td>Required</td></tr>
@@ -685,7 +685,7 @@ See [information about additional parameters](#additional-parameters).
685685
<table>
686686
<tr><th>Name</th><th>Type</th><th>Description</th></tr>
687687
<tr><td>cancellation_send_email</td><td>Boolean</td><td>Send out cancellation email.</td></tr>
688-
<tr><td>cancellation_send_sms</td><td>Boolean</td><td>Send out cancellation SMS..</td></tr>
688+
<tr><td>cancellation_send_sms</td><td>Boolean</td><td>Send out cancellation SMS.</td></tr>
689689
</table>
690690

691691
### Update booking
@@ -1152,7 +1152,7 @@ Response
11521152

11531153
### Delete resource
11541154

1155-
`DELETE /resources/{resource_id}` will delete existing resource with id `{resource_id}`. Deleting a resource will set it to active=false and will not returned in any listings.
1155+
`DELETE /resources/{resource_id}` will delete existing resource with id `{resource_id}`. Deleting a resource will set it to active=false and will not be returned in any listings.
11561156

11571157
### Get opening hours for specific dates
11581158

@@ -1313,12 +1313,12 @@ Resources provides services. This link is called a provider.
13131313
<tr><td>resource_id</td><td>Integer</td><td>Required</td></tr>
13141314
<tr><td>service_id</td><td>Integer</td><td>Required</td></tr>
13151315
<tr><td>opening_hours_mon</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1316-
<tr><td>opening_hours_tue</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability..</td></tr>
1317-
<tr><td>opening_hours_wed</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1318-
<tr><td>opening_hours_thu</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1319-
<tr><td>opening_hours_fri</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1320-
<tr><td>opening_hours_sat</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1321-
<tr><td>opening_hours_sun</td><td>Array</td><td>Opening hours for Monday. Fallback to resource availability.</td></tr>
1316+
<tr><td>opening_hours_tue</td><td>Array</td><td>Opening hours for Tuesday. Fallback to resource availability.</td></tr>
1317+
<tr><td>opening_hours_wed</td><td>Array</td><td>Opening hours for Wednesday. Fallback to resource availability.</td></tr>
1318+
<tr><td>opening_hours_thu</td><td>Array</td><td>Opening hours for Thursday. Fallback to resource availability.</td></tr>
1319+
<tr><td>opening_hours_fri</td><td>Array</td><td>Opening hours for Friday. Fallback to resource availability.</td></tr>
1320+
<tr><td>opening_hours_sat</td><td>Array</td><td>Opening hours for Saturday. Fallback to resource availability.</td></tr>
1321+
<tr><td>opening_hours_sun</td><td>Array</td><td>Opening hours for Sunday. Fallback to resource availability.</td></tr>
13221322
</table>
13231323

13241324
Opening hours for a provider works in the same way as availability is defined on [resource exception date](#resource-exception-date).

0 commit comments

Comments
 (0)