{ "version": "1.0", "modules": [ { "name": "Aircraft Management", "prefix": "/aircraft", "endpoints": [ { "method": "POST", "path": "/", "summary": "Create Aircraft", "description": "Creates a new aircraft record with registration number, model, manufacturer, and seating capacity. Returns 409 if the registration number already exists. Validates that total_seats is greater than 0 and year_manufactured is greater than 1900.", "request_body": { "schema_name": "AircraftCreate", "fields": [ { "name": "registration_number", "type": "str", "required": false }, { "name": "model", "type": "str", "required": false }, { "name": "manufacturer", "type": "str", "required": false }, { "name": "total_seats", "type": "int", "required": false }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] } ] }, "response": { "schema_name": "AircraftResponse", "fields": [ { "name": "registration_number", "type": "str", "required": false }, { "name": "model", "type": "str", "required": false }, { "name": "manufacturer", "type": "str", "required": false }, { "name": "total_seats", "type": "int", "required": false }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/", "summary": "List Aircraft", "description": "Returns a paginated list of aircraft. Supports optional filtering by status and search term (matches registration number, model, or manufacturer). Results are ordered by creation date descending.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "status", "type": "AircraftStatus", "required": false }, { "name": "search", "type": "str", "required": false } ], "response": { "schema_name": "AircraftResponse", "fields": [ { "name": "registration_number", "type": "str", "required": false }, { "name": "model", "type": "str", "required": false }, { "name": "manufacturer", "type": "str", "required": false }, { "name": "total_seats", "type": "int", "required": false }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/{id}", "summary": "Get Aircraft By ID", "description": "Returns a single aircraft record by its unique identifier. Returns 404 if the aircraft does not exist.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "AircraftResponse", "fields": [ { "name": "registration_number", "type": "str", "required": false }, { "name": "model", "type": "str", "required": false }, { "name": "manufacturer", "type": "str", "required": false }, { "name": "total_seats", "type": "int", "required": false }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/{id}", "summary": "Update Aircraft", "description": "Updates an existing aircraft record. Only provided fields are updated. Returns 404 if the aircraft does not exist. Returns 409 if the new registration number conflicts with another aircraft.", "path_params": [ { "name": "id", "type": "str" } ], "request_body": { "schema_name": "AircraftUpdate", "fields": [ { "name": "registration_number", "type": "str", "required": false, "nullable": true }, { "name": "model", "type": "str", "required": false, "nullable": true }, { "name": "manufacturer", "type": "str", "required": false, "nullable": true }, { "name": "total_seats", "type": "int", "required": false, "nullable": true }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "nullable": true, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] } ] }, "response": { "schema_name": "AircraftResponse", "fields": [ { "name": "registration_number", "type": "str", "required": false }, { "name": "model", "type": "str", "required": false }, { "name": "manufacturer", "type": "str", "required": false }, { "name": "total_seats", "type": "int", "required": false }, { "name": "year_manufactured", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "AircraftStatus", "required": false, "enum_values": [ "ACTIVE", "MAINTENANCE", "RETIRED" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/{id}", "summary": "Delete Aircraft", "description": "Deletes an aircraft record. Returns 404 if the aircraft does not exist. Returns 400 if the aircraft has future flight assignments, as aircraft cannot be deleted when they have scheduled flights.", "path_params": [ { "name": "id", "type": "str" } ], "status_code": 200 }, { "method": "GET", "path": "/{id}/details", "summary": "Get Aircraft Details", "description": "Returns detailed aircraft information including all seats configured on the aircraft and all associated flights. Uses eager loading to prevent N+1 queries. Returns 404 if the aircraft does not exist.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "AircraftDetailResponse", "fields": [ { "name": "registration_number", "type": "str", "required": true }, { "name": "model", "type": "str", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "GET", "path": "/{id}/availability", "summary": "Check Aircraft Availability", "description": "Checks if an aircraft is available for a given date range. Returns availability status, reason, and any conflicting flight assignments. Considers aircraft operational status and existing flight schedules including required turnaround time.", "path_params": [ { "name": "id", "type": "str" } ], "query_params": [ { "name": "start_date", "type": "datetime", "required": false, "default": null }, { "name": "end_date", "type": "datetime", "required": false, "default": null } ], "status_code": 200 }, { "method": "POST", "path": "/seats", "summary": "Create Seat", "description": "Creates a new seat configuration for an aircraft. Returns 404 if the aircraft does not exist. Returns 409 if a seat with the same seat number already exists on the specified aircraft.", "request_body": { "schema_name": "SeatCreate", "fields": [ { "name": "aircraft_id", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "default": false }, { "name": "is_aisle", "type": "bool", "required": false, "default": false }, { "name": "is_exit_row", "type": "bool", "required": false, "default": false } ] }, "response": { "schema_name": "SeatResponse", "fields": [ { "name": "aircraft_id", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "default": false }, { "name": "is_aisle", "type": "bool", "required": false, "default": false }, { "name": "is_exit_row", "type": "bool", "required": false, "default": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/seats", "summary": "List Seats", "description": "Returns a paginated list of seats. Supports optional filtering by aircraft_id and class_type. Results are ordered by seat number.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": false } ], "response": { "schema_name": "SeatResponse", "fields": [ { "name": "aircraft_id", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "default": false }, { "name": "is_aisle", "type": "bool", "required": false, "default": false }, { "name": "is_exit_row", "type": "bool", "required": false, "default": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/seats/{id}", "summary": "Get Seat By ID", "description": "Returns a single seat record by its unique identifier. Returns 404 if the seat does not exist.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "SeatResponse", "fields": [ { "name": "aircraft_id", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "default": false }, { "name": "is_aisle", "type": "bool", "required": false, "default": false }, { "name": "is_exit_row", "type": "bool", "required": false, "default": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/seats/{id}", "summary": "Update Seat", "description": "Updates an existing seat record. Only provided fields are updated. Returns 404 if the seat or referenced aircraft does not exist. Returns 409 if the updated seat number conflicts with another seat on the same aircraft.", "path_params": [ { "name": "id", "type": "str" } ], "request_body": { "schema_name": "SeatUpdate", "fields": [ { "name": "aircraft_id", "type": "str", "required": false, "nullable": true }, { "name": "seat_number", "type": "str", "required": false, "nullable": true }, { "name": "class_type", "type": "SeatClassType", "required": false, "nullable": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "nullable": true }, { "name": "is_aisle", "type": "bool", "required": false, "nullable": true }, { "name": "is_exit_row", "type": "bool", "required": false, "nullable": true } ] }, "response": { "schema_name": "SeatResponse", "fields": [ { "name": "aircraft_id", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false }, { "name": "class_type", "type": "SeatClassType", "required": true, "enum_values": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ] }, { "name": "is_window", "type": "bool", "required": false, "default": false }, { "name": "is_aisle", "type": "bool", "required": false, "default": false }, { "name": "is_exit_row", "type": "bool", "required": false, "default": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/seats/{id}", "summary": "Delete Seat", "description": "Deletes a seat record. Returns 404 if the seat does not exist.", "path_params": [ { "name": "id", "type": "str" } ], "status_code": 200 } ] }, { "name": "Airport & Route Management", "prefix": "/airport-route-management", "endpoints": [ { "method": "POST", "path": "/airports", "summary": "Create Airport", "description": "Creates a new airport record with unique IATA code. Returns 409 if the airport code already exists. Airport code must be exactly 3 uppercase letters.", "request_body": { "schema_name": "AirportCreate", "fields": [ { "name": "code", "type": "str", "required": false }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true }, { "name": "country", "type": "str", "required": true }, { "name": "timezone", "type": "str", "required": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "AirportResponse", "fields": [ { "name": "code", "type": "str", "required": false }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true }, { "name": "country", "type": "str", "required": true }, { "name": "timezone", "type": "str", "required": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/airports", "summary": "List Airports", "description": "Returns a paginated list of airports. Supports optional search filter on code, name, city, and country fields.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "search", "type": "str", "required": false } ], "response": { "schema_name": "AirportResponse", "fields": [ { "name": "code", "type": "str", "required": false }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true }, { "name": "country", "type": "str", "required": true }, { "name": "timezone", "type": "str", "required": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/airports/{id}", "summary": "Get Airport By ID", "description": "Returns a single airport by its unique identifier. Returns 404 if the airport is not found.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "AirportResponse", "fields": [ { "name": "code", "type": "str", "required": false }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true }, { "name": "country", "type": "str", "required": true }, { "name": "timezone", "type": "str", "required": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/airports/{id}", "summary": "Update Airport", "description": "Updates an existing airport record. Returns 404 if the airport is not found. Returns 409 if the new code conflicts with an existing airport.", "path_params": [ { "name": "id", "type": "str" } ], "request_body": { "schema_name": "AirportUpdate", "fields": [ { "name": "code", "type": "str", "required": false, "nullable": true }, { "name": "name", "type": "str", "required": false, "nullable": true }, { "name": "city", "type": "str", "required": false, "nullable": true }, { "name": "country", "type": "str", "required": false, "nullable": true }, { "name": "timezone", "type": "str", "required": false, "nullable": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "AirportResponse", "fields": [ { "name": "code", "type": "str", "required": false }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true }, { "name": "country", "type": "str", "required": true }, { "name": "timezone", "type": "str", "required": true }, { "name": "latitude", "type": "str", "required": false, "nullable": true }, { "name": "longitude", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/airports/{id}", "summary": "Delete Airport", "description": "Deletes an airport record. Returns 404 if the airport is not found. Returns 409 if the airport is referenced by any routes.", "path_params": [ { "name": "id", "type": "str" } ], "status_code": 200 }, { "method": "POST", "path": "/routes", "summary": "Create Route", "description": "Creates a new route between two airports. Validates that origin and destination airports exist and are different. Returns 409 if a route between these airports already exists.", "request_body": { "schema_name": "RouteCreate", "fields": [ { "name": "origin_airport_id", "type": "str", "required": true }, { "name": "destination_airport_id", "type": "str", "required": true }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true }, { "name": "status", "type": "RouteStatus", "required": false, "enum_values": [ "ACTIVE", "INACTIVE" ] } ] }, "response": { "schema_name": "RouteResponse", "fields": [ { "name": "origin_airport_id", "type": "str", "required": true }, { "name": "destination_airport_id", "type": "str", "required": true }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true }, { "name": "status", "type": "RouteStatus", "required": false, "enum_values": [ "ACTIVE", "INACTIVE" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/routes", "summary": "List Routes", "description": "Returns a paginated list of routes. Supports optional filters for status, origin airport, and destination airport.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "status_filter", "type": "RouteStatus", "required": false }, { "name": "origin_airport_id", "type": "str", "required": false }, { "name": "destination_airport_id", "type": "str", "required": false } ], "response": { "schema_name": "RouteResponse", "fields": [ { "name": "origin_airport_id", "type": "str", "required": true }, { "name": "destination_airport_id", "type": "str", "required": true }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true }, { "name": "status", "type": "RouteStatus", "required": false, "enum_values": [ "ACTIVE", "INACTIVE" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/routes/{id}", "summary": "Get Route By ID", "description": "Returns a single route by its unique identifier. Returns 404 if the route is not found.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "RouteResponse", "fields": [ { "name": "origin_airport_id", "type": "str", "required": true }, { "name": "destination_airport_id", "type": "str", "required": true }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true }, { "name": "status", "type": "RouteStatus", "required": false, "enum_values": [ "ACTIVE", "INACTIVE" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "GET", "path": "/routes/{id}/details", "summary": "Get Route Details", "description": "Returns detailed route information including origin and destination airport details. Returns 404 if the route is not found.", "path_params": [ { "name": "id", "type": "str" } ], "response": { "schema_name": "RouteDetailResponse", "fields": [ { "name": "origin_airport", "type": "RouteAirportResponse", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] }, { "name": "destination_airport", "type": "RouteAirportResponse", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/routes/{id}", "summary": "Update Route", "description": "Updates an existing route record. Validates that origin and destination airports exist and are different. Returns 404 if the route is not found. Returns 409 if the updated route conflicts with an existing route.", "path_params": [ { "name": "id", "type": "str" } ], "request_body": { "schema_name": "RouteUpdate", "fields": [ { "name": "origin_airport_id", "type": "str", "required": false, "nullable": true }, { "name": "destination_airport_id", "type": "str", "required": false, "nullable": true }, { "name": "distance_km", "type": "int", "required": false, "nullable": true }, { "name": "estimated_duration_minutes", "type": "int", "required": false, "nullable": true }, { "name": "status", "type": "RouteStatus", "required": false, "nullable": true, "enum_values": [ "ACTIVE", "INACTIVE" ] } ] }, "response": { "schema_name": "RouteResponse", "fields": [ { "name": "origin_airport_id", "type": "str", "required": true }, { "name": "destination_airport_id", "type": "str", "required": true }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true }, { "name": "status", "type": "RouteStatus", "required": false, "enum_values": [ "ACTIVE", "INACTIVE" ] }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/routes/{id}", "summary": "Delete Route", "description": "Deletes a route record. Returns 404 if the route is not found. Returns 409 if the route has associated flights.", "path_params": [ { "name": "id", "type": "str" } ], "status_code": 200 } ] }, { "name": "Flight Management", "prefix": "/flight-management", "endpoints": [ { "method": "POST", "path": "/fare-classes", "summary": "Create Fare Class", "description": "Creates a new fare class with pricing rules and baggage allowances. Returns 409 if a fare class with the same name already exists.", "request_body": { "schema_name": "FareclassCreate", "fields": [ { "name": "name", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false }, { "name": "price_multiplier", "type": "Decimal", "required": false }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false }, { "name": "cancellation_allowed", "type": "str", "required": false }, { "name": "change_fee_percentage", "type": "Decimal", "required": false } ] }, "response": { "schema_name": "FareclassResponse", "fields": [ { "name": "name", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false }, { "name": "price_multiplier", "type": "Decimal", "required": false }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false }, { "name": "cancellation_allowed", "type": "str", "required": false }, { "name": "change_fee_percentage", "type": "Decimal", "required": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/fare-classes", "summary": "List Fare Classes", "description": "Returns a paginated list of fare classes. Supports optional filtering by name search and class type.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "search", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false } ], "response": { "schema_name": "FareclassResponse", "fields": [ { "name": "name", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false }, { "name": "price_multiplier", "type": "Decimal", "required": false }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false }, { "name": "cancellation_allowed", "type": "str", "required": false }, { "name": "change_fee_percentage", "type": "Decimal", "required": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/fare-classes/{fareclass_id}", "summary": "Get Fare Class", "description": "Returns details of a specific fare class by ID. Returns 404 if the fare class is not found.", "path_params": [ { "name": "fareclass_id", "type": "str" } ], "response": { "schema_name": "FareclassResponse", "fields": [ { "name": "name", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false }, { "name": "price_multiplier", "type": "Decimal", "required": false }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false }, { "name": "cancellation_allowed", "type": "str", "required": false }, { "name": "change_fee_percentage", "type": "Decimal", "required": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/fare-classes/{fareclass_id}", "summary": "Update Fare Class", "description": "Updates an existing fare class. Only provided fields are updated. Returns 404 if not found, 409 if the new name conflicts with an existing fare class.", "path_params": [ { "name": "fareclass_id", "type": "str" } ], "request_body": { "schema_name": "FareclassUpdate", "fields": [ { "name": "name", "type": "str", "required": false, "nullable": true }, { "name": "class_type", "type": "str", "required": false, "nullable": true }, { "name": "price_multiplier", "type": "Decimal", "required": false, "nullable": true }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false, "nullable": true }, { "name": "cancellation_allowed", "type": "str", "required": false, "nullable": true }, { "name": "change_fee_percentage", "type": "Decimal", "required": false, "nullable": true } ] }, "response": { "schema_name": "FareclassResponse", "fields": [ { "name": "name", "type": "str", "required": false }, { "name": "class_type", "type": "str", "required": false }, { "name": "price_multiplier", "type": "Decimal", "required": false }, { "name": "baggage_allowance_kg", "type": "Decimal", "required": false }, { "name": "cancellation_allowed", "type": "str", "required": false }, { "name": "change_fee_percentage", "type": "Decimal", "required": false }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/fare-classes/{fareclass_id}", "summary": "Delete Fare Class", "description": "Deletes a fare class by ID. Returns 404 if the fare class is not found.", "path_params": [ { "name": "fareclass_id", "type": "str" } ], "status_code": 200 }, { "method": "POST", "path": "/flights", "summary": "Create Flight", "description": "Creates a new scheduled flight. Validates that the route and aircraft exist, aircraft is active, departure is in the future, and arrival is after departure. Returns 400 for validation failures, 404 if route or aircraft not found.", "request_body": { "schema_name": "FlightCreate", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/flights", "summary": "List Flights", "description": "Returns a paginated list of flights. Supports optional filtering by status, aircraft, route, and date.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "status", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "date", "type": "date", "required": false } ], "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/flights/{flight_id}", "summary": "Get Flight", "description": "Returns details of a specific flight by ID. Returns 404 if the flight is not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/flights/{flight_id}", "summary": "Update Flight", "description": "Updates an existing flight. Only provided fields are updated. Validates that flights with departed or arrived status cannot be edited. Returns 400 for validation failures, 404 if flight, route, or aircraft not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "request_body": { "schema_name": "FlightUpdate", "fields": [ { "name": "flight_number", "type": "str", "required": false, "nullable": true }, { "name": "route_id", "type": "str", "required": false, "nullable": true }, { "name": "aircraft_id", "type": "str", "required": false, "nullable": true }, { "name": "scheduled_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "scheduled_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "nullable": true }, { "name": "gate", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/flights/{flight_id}", "summary": "Delete Flight", "description": "Deletes a flight by ID. Returns 404 if the flight is not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "status_code": 200 }, { "method": "GET", "path": "/flights/{flight_id}/details", "summary": "Get Flight Details", "description": "Returns comprehensive flight details including route with origin and destination airports, aircraft information, bookings list, and assigned crew members with their roles. All related data is eagerly loaded in a single query.", "path_params": [ { "name": "flight_id", "type": "str" } ], "response": { "schema_name": "FlightDetailResponse", "fields": [ { "name": "flight_number", "type": "str", "required": true }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "status", "type": "str", "required": true }, { "name": "route", "type": "RouteDetailResponse", "required": true, "fields": [ { "name": "origin_airport", "type": "RouteAirportResponse", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] }, { "name": "destination_airport", "type": "RouteAirportResponse", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] }, { "name": "distance_km", "type": "int", "required": true }, { "name": "estimated_duration_minutes", "type": "int", "required": true } ] }, { "name": "aircraft", "type": "AircraftDetailResponse", "required": true, "fields": [ { "name": "registration_number", "type": "str", "required": true }, { "name": "model", "type": "str", "required": true } ] } ], "is_list": false }, "status_code": 200 }, { "method": "GET", "path": "/flights/search", "summary": "Search Flights", "description": "Searches for scheduled flights between two airports on a specific date. Returns flights with origin and destination airport codes matching the search criteria.", "query_params": [ { "name": "origin", "type": "str", "required": false, "default": null }, { "name": "destination", "type": "str", "required": false, "default": null }, { "name": "date", "type": "date", "required": false, "default": null } ], "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "POST", "path": "/flights/{flight_id}/update-status", "summary": "Update Flight Status", "description": "Updates the status of a flight. Automatically sets actual departure or arrival timestamps when transitioning to departed or arrived status. Returns 404 if flight not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "request_body": { "schema_name": "FlightStatusUpdateRequest", "fields": [ { "name": "status", "type": "FlightStatus", "required": true, "enum_values": [ "SCHEDULED", "BOARDING", "DEPARTED", "ARRIVED", "CANCELLED", "DELAYED" ] } ] }, "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "POST", "path": "/flights/{flight_id}/cancel", "summary": "Cancel Flight", "description": "Cancels a flight and automatically cancels all associated bookings. Returns 400 if the flight is already departed, arrived, or cancelled. Returns 404 if flight not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "response": { "schema_name": "FlightResponse", "fields": [ { "name": "flight_number", "type": "str", "required": false }, { "name": "route_id", "type": "str", "required": false }, { "name": "aircraft_id", "type": "str", "required": false }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "actual_departure", "type": "datetime", "required": false, "nullable": true }, { "name": "actual_arrival", "type": "datetime", "required": false, "nullable": true }, { "name": "base_fare", "type": "Decimal", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "gate", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "GET", "path": "/flights/{flight_id}/passenger-manifest", "summary": "Get Passenger Manifest", "description": "Returns a list of all passengers booked on a specific flight, including booking reference, passenger name, seat assignment, booking status, and fare class. Returns 404 if flight not found.", "path_params": [ { "name": "flight_id", "type": "str" } ], "response": { "schema_name": "PassengerManifestResponse", "fields": [ { "name": "booking_reference", "type": "str", "required": true }, { "name": "passenger_first_name", "type": "str", "required": true }, { "name": "passenger_last_name", "type": "str", "required": true }, { "name": "seat_number", "type": "str", "required": false, "nullable": true }, { "name": "booking_status", "type": "str", "required": true }, { "name": "fare_class_name", "type": "str", "required": true } ], "is_list": true }, "status_code": 200 } ] }, { "name": "Crew Management", "prefix": "/crew-management", "endpoints": [ { "method": "POST", "path": "/crew-members", "summary": "Create Crew Member", "description": "Creates a new crew member record with personal details, role, and certification information. Returns 409 if employee number or email already exists.", "request_body": { "schema_name": "CrewmemberCreate", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" } ] }, "response": { "schema_name": "CrewmemberResponse", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/crew-members", "summary": "List Crew Members", "description": "Returns a paginated list of crew members. Supports optional filters for search (name, email, employee number), status, and role.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "search", "type": "str", "required": false }, { "name": "status", "type": "str", "required": false }, { "name": "role", "type": "str", "required": false } ], "response": { "schema_name": "CrewmemberResponse", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/crew-members/{crew_member_id}", "summary": "Get Crew Member", "description": "Returns detailed information for a specific crew member by ID. Returns 404 if crew member not found.", "path_params": [ { "name": "crew_member_id", "type": "str" } ], "response": { "schema_name": "CrewmemberResponse", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/crew-members/{crew_member_id}", "summary": "Update Crew Member", "description": "Updates crew member information. Only provided fields are updated. Returns 404 if crew member not found, 409 if employee number or email conflicts with existing record.", "path_params": [ { "name": "crew_member_id", "type": "str" } ], "request_body": { "schema_name": "CrewmemberUpdate", "fields": [ { "name": "employee_number", "type": "str", "required": false, "nullable": true }, { "name": "first_name", "type": "str", "required": false, "nullable": true }, { "name": "last_name", "type": "str", "required": false, "nullable": true }, { "name": "email", "type": "EmailStr", "required": false, "nullable": true }, { "name": "phone", "type": "str", "required": false, "nullable": true }, { "name": "date_of_birth", "type": "date", "required": false, "nullable": true }, { "name": "hire_date", "type": "date", "required": false, "nullable": true }, { "name": "role", "type": "str", "required": false, "nullable": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "CrewmemberResponse", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/crew-members/{crew_member_id}", "summary": "Delete Crew Member", "description": "Deletes a crew member record. Returns 400 if crew member has active flight assignments, 404 if crew member not found.", "path_params": [ { "name": "crew_member_id", "type": "str" } ], "status_code": 200 }, { "method": "GET", "path": "/crew-members/{crew_member_id}/details", "summary": "Get Crew Member Details", "description": "Returns comprehensive crew member information including all flight assignments with flight details, routes, and airports. Returns 404 if crew member not found.", "path_params": [ { "name": "crew_member_id", "type": "str" } ], "response": { "schema_name": "CrewmemberDetailResponse", "fields": [ { "name": "employee_number", "type": "str", "required": true }, { "name": "first_name", "type": "str", "required": true }, { "name": "last_name", "type": "str", "required": true }, { "name": "email", "type": "EmailStr", "required": true }, { "name": "phone", "type": "str", "required": true }, { "name": "date_of_birth", "type": "date", "required": true }, { "name": "hire_date", "type": "date", "required": true }, { "name": "role", "type": "str", "required": true }, { "name": "certification_number", "type": "str", "required": false, "nullable": true }, { "name": "certification_expiry", "type": "date", "required": false, "nullable": true }, { "name": "status", "type": "str", "required": false, "default": "Active" }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true }, { "name": "flight_crew_assignments", "type": "List[FlightcrewassignmentDetail]", "required": true, "is_list": true, "item_fields": [ { "name": "id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": true }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "flight", "type": "FlightAssignmentDetail", "required": true, "fields": [ { "name": "flight_number", "type": "str", "required": true }, { "name": "scheduled_departure", "type": "datetime", "required": true }, { "name": "scheduled_arrival", "type": "datetime", "required": true }, { "name": "route", "type": "FlightRouteDetail", "required": true, "fields": [ { "name": "origin_airport", "type": "FlightRouteAirportDetail", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] }, { "name": "destination_airport", "type": "FlightRouteAirportDetail", "required": true, "fields": [ { "name": "code", "type": "str", "required": true }, { "name": "name", "type": "str", "required": true }, { "name": "city", "type": "str", "required": true } ] } ] } ] }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ] } ], "is_list": false }, "status_code": 200 }, { "method": "GET", "path": "/crew-members/{crew_member_id}/schedule", "summary": "Get Crew Member Schedule", "description": "Returns all flight assignments for a crew member within the specified date range. Returns 400 if start date is after end date, 404 if crew member not found.", "path_params": [ { "name": "crew_member_id", "type": "str" } ], "query_params": [ { "name": "start_date", "type": "date", "required": false, "default": null }, { "name": "end_date", "type": "date", "required": false, "default": null } ], "response": { "schema_name": "FlightcrewassignmentResponse", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "POST", "path": "/flight-crew-assignments", "summary": "Create Flight Crew Assignment", "description": "Assigns a crew member to a flight with validation for crew availability, certification validity, and rest period requirements. Returns 400 for validation failures, 404 if flight or crew member not found, 409 if crew member already assigned or has overlapping assignments.", "request_body": { "schema_name": "FlightcrewassignmentCreate", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "FlightcrewassignmentResponse", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 201 }, { "method": "GET", "path": "/flight-crew-assignments", "summary": "List Flight Crew Assignments", "description": "Returns a paginated list of flight crew assignments. Supports optional filters for flight ID, crew member ID, assignment status, and assigned role.", "query_params": [ { "name": "limit", "type": "int", "required": false, "default": 20 }, { "name": "offset", "type": "int", "required": false, "default": 0 }, { "name": "flight_id", "type": "str", "required": false }, { "name": "crew_member_id", "type": "str", "required": false }, { "name": "assignment_status", "type": "str", "required": false }, { "name": "assigned_role", "type": "str", "required": false } ], "response": { "schema_name": "FlightcrewassignmentResponse", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": true }, "status_code": 200 }, { "method": "GET", "path": "/flight-crew-assignments/{assignment_id}", "summary": "Get Flight Crew Assignment", "description": "Returns detailed information for a specific flight crew assignment by ID. Returns 404 if assignment not found.", "path_params": [ { "name": "assignment_id", "type": "str" } ], "response": { "schema_name": "FlightcrewassignmentResponse", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "PUT", "path": "/flight-crew-assignments/{assignment_id}", "summary": "Update Flight Crew Assignment", "description": "Updates flight crew assignment information. Only provided fields are updated. Validates crew member status if crew member is changed. Returns 404 if assignment or crew member not found, 400 if crew member is not active.", "path_params": [ { "name": "assignment_id", "type": "str" } ], "request_body": { "schema_name": "FlightcrewassignmentUpdate", "fields": [ { "name": "flight_id", "type": "str", "required": false, "nullable": true }, { "name": "crew_member_id", "type": "str", "required": false, "nullable": true }, { "name": "assigned_role", "type": "str", "required": false, "nullable": true }, { "name": "assignment_status", "type": "str", "required": false, "nullable": true }, { "name": "notes", "type": "str", "required": false, "nullable": true } ] }, "response": { "schema_name": "FlightcrewassignmentResponse", "fields": [ { "name": "flight_id", "type": "str", "required": true }, { "name": "crew_member_id", "type": "str", "required": true }, { "name": "assigned_role", "type": "str", "required": true }, { "name": "assignment_status", "type": "str", "required": false, "default": "Assigned" }, { "name": "notes", "type": "str", "required": false, "nullable": true }, { "name": "id", "type": "str", "required": true }, { "name": "created_at", "type": "datetime", "required": true }, { "name": "updated_at", "type": "datetime", "required": true } ], "is_list": false }, "status_code": 200 }, { "method": "DELETE", "path": "/flight-crew-assignments/{assignment_id}", "summary": "Delete Flight Crew Assignment", "description": "Deletes a flight crew assignment. Returns 400 if assignment is already completed, 404 if assignment not found.", "path_params": [ { "name": "assignment_id", "type": "str" } ], "status_code": 200 } ] } ], "enums": { "AircraftStatus": [ "ACTIVE", "MAINTENANCE", "RETIRED" ], "SeatClassType": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ], "RouteStatus": [ "ACTIVE", "INACTIVE" ], "FlightStatus": [ "SCHEDULED", "BOARDING", "DEPARTED", "ARRIVED", "CANCELLED", "DELAYED" ], "FareClassType": [ "ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS" ], "CrewRole": [ "CAPTAIN", "FIRST_OFFICER", "FLIGHT_ATTENDANT", "PURSER" ], "CrewStatus": [ "ACTIVE", "ON_LEAVE", "INACTIVE" ], "AssignmentStatus": [ "ASSIGNED", "CONFIRMED", "COMPLETED", "CANCELLED" ], "BookingStatus": [ "CONFIRMED", "PENDING", "CANCELLED", "CHECKED_IN", "BOARDED" ], "PaymentStatus": [ "PENDING", "COMPLETED", "REFUNDED", "FAILED" ] } }