Spaces:
Sleeping
Sleeping
Update api_docs.py
Browse files- api_docs.py +19 -15
api_docs.py
CHANGED
@@ -8,34 +8,38 @@ api_docs = {
|
|
8 |
"/": {
|
9 |
"method": "POST",
|
10 |
"description": "Retrieve booking information associated with a booking ID.",
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
}
|
12 |
},
|
13 |
-
"body": {
|
14 |
-
"booking_id": "string"
|
15 |
-
},
|
16 |
"headers": {
|
17 |
"Authorization": "Bearer <auth_token>",
|
18 |
"Content-Type": "application/json"
|
19 |
},
|
20 |
-
|
21 |
"response": {
|
22 |
"description": "A JSON object containing booking details for a specific booking id.",
|
23 |
"content_type": "application/json",
|
24 |
-
|
25 |
-
|
26 |
-
|
27 |
-
|
28 |
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
|
33 |
-
|
34 |
-
}
|
35 |
}
|
36 |
}
|
37 |
}
|
38 |
|
|
|
39 |
# --actual response handling with .get() and mapping entries methods are request handling code, not in here (API documentation).
|
40 |
#"response": {
|
41 |
#"description": "A JSON object containing booking details for a specific booking ID.",
|
|
|
8 |
"/": {
|
9 |
"method": "POST",
|
10 |
"description": "Retrieve booking information associated with a booking ID.",
|
11 |
+
"parameters": {
|
12 |
+
"body": {
|
13 |
+
"booking_id": {
|
14 |
+
"type": "string",
|
15 |
+
"description": "The unique identifier for the booking."
|
16 |
+
}
|
17 |
+
}
|
18 |
+
}
|
19 |
}
|
20 |
},
|
|
|
|
|
|
|
21 |
"headers": {
|
22 |
"Authorization": "Bearer <auth_token>",
|
23 |
"Content-Type": "application/json"
|
24 |
},
|
|
|
25 |
"response": {
|
26 |
"description": "A JSON object containing booking details for a specific booking id.",
|
27 |
"content_type": "application/json",
|
28 |
+
"fields": {
|
29 |
+
"booking_id": "The unique identifier for the booking.",
|
30 |
+
"full_name": "The full name of the customer associated with the booking.",
|
31 |
+
"amount": "The total amount for the booking (integer).",
|
32 |
+
"checkin": "The check-in date for the booking (ISO 8601 format).",
|
33 |
+
"checkout": "The check-out date for the booking (ISO 8601 format).",
|
34 |
+
"address": "The address associated with the booking.",
|
35 |
+
"user_id": "The user ID associated with the booking (integer).",
|
36 |
+
"infotext": "Additional information related to the booking.",
|
37 |
+
"included": "Details of services included in the booking."
|
|
|
38 |
}
|
39 |
}
|
40 |
}
|
41 |
|
42 |
+
|
43 |
# --actual response handling with .get() and mapping entries methods are request handling code, not in here (API documentation).
|
44 |
#"response": {
|
45 |
#"description": "A JSON object containing booking details for a specific booking ID.",
|