Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix misformatted API docs. #391

Merged
merged 2 commits into from
Jul 19, 2024
Merged

docs: fix misformatted API docs. #391

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0143cf3
docs: fix misformatted API docs.
JohnVillalovos Jul 11, 2024
eb0f555
docs: correct the names of the authentication headers
JohnVillalovos Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions doc/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ For all of the secure service calls it is required to be
1. The result from the [Authenticate](#Authenticate) POST API call, if
successful, will contain the two values: `sessionToken` and `userId`
1. When making secure service calls the following headers must be set:
1. `X-LibreBooking-SessionToken` set to the value of `sessionToken`
1. `X-Booked-SessionToken` set to the value of `sessionToken`
returned by the [Authenticate](#Authenticate) API call.
1. `X-LibreBooking-UserId` set to the value of `userId` returned by the
1. `X-Booked-UserId` set to the value of `userId` returned by the
[Authenticate](#Authenticate) API call.

### POST Requests
Expand Down Expand Up @@ -959,8 +959,6 @@ _This service is secure and requires authentication_
__Response:__

```json
And get your pretty indented JSON right here

{
"referenceNumber": "referenceNumber",
"isPendingApproval": true,
Expand Down Expand Up @@ -1688,7 +1686,8 @@ __Response:__
],
"links": [],
"message": null
}```
}
```


#### GetGroups
Expand Down Expand Up @@ -1777,7 +1776,8 @@ __Response:__
],
"links": [],
"message": null
}```
}
```


#### GetResource
Expand Down Expand Up @@ -1835,7 +1835,8 @@ __Response:__
"maxConcurrentReservations": 1,
"links": [],
"message": null
}```
}
```


GetAvailability
Expand Down
Loading