Spaces:
Sleeping
Sleeping
File size: 3,200 Bytes
35fdf97 af33f81 35fdf97 87bae49 af33f81 35fdf97 af33f81 87bae49 35fdf97 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
### api_docs.py
import json
api_docs = {
"base_url": "https://aivisions.no/data/daysoff/api/v1/booking/",
"endpoints": {
"/": {
"method": "POST",
"description": "Retrieve booking information associated with a booking ID.",
"parameters": {
"body": {
"booking_id": {
"type": "string",
"description": "The unique identifier for the booking."
}
}
}
}
},
"headers": {
"Authorization": "Bearer <auth_token>",
"Content-Type": "application/json"
},
"response": {
"description": "A JSON object containing booking details for a specific booking id.",
"content_type": "application/json",
"fields": {
"booking_id": "The unique identifier for the booking.",
"full_name": "The full name of the customer associated with the booking.",
"amount": "The total amount for the booking (integer).",
"checkin": "The check-in date for the booking (ISO 8601 format).",
"checkout": "The check-out date for the booking (ISO 8601 format).",
"address": "The address associated with the booking.",
"user_id": "The user ID associated with the booking (integer).",
"infotext": "Additional information related to the booking.",
"included": "Details of services included in the booking."
}
}
}
# --actual response handling with .get() and mapping entries methods are request handling code, not in here (API documentation).
#"response": {
#"description": "A JSON object containing booking details for a specific booking ID.",
#"content_type": "application/json",
#"booking_info": {
#"booking_id": {"description": "The unique identifier for the booking.", "mapping": "response.get('booking_id', 'N/A')"},
#"full_name": {"description": "The full name of the customer associated with the booking.", "mapping": "response.get('full_name', 'N/A')"},
#"amount": {"description": "The total amount for the booking (integer).", "mapping": "response.get('amount', 0)"},
#"checkin": {"description": "The check-in date for the booking (ISO 8601).", "mapping": "response.get('checkin', 'N/A')"}, # --datetime format is 2024-12-20T15:00:00
#"checkout": {"description": "The check-out date for the booking (ISO 8601).", "mapping": "response.get('checkout', 'N/A')"},
#"address": {"description": "The address associated with the booking.", "mapping": "response.get('address', 'N/A')"},
#"user_id": {"description": "The user ID associated with the booking (integer).", "mapping": "response.get('user_id', 0)"},
#"infotext": {"description": "Additional information related to the booking.", "mapping": "response.get('infotext', 'N/A')"},
#"included": {"description": "Details of services included in the booking.", "mapping": "response.get('included', 'N/A')"}
#}
#}
api_docs_str = json.dumps(api_docs, indent=2)
api_docs_str |