Spaces:
Runtime error
Runtime error
File size: 25,656 Bytes
2f5dcf7 | 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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 | """
=============================================================
MIRCHI TRADING API - COMPLETE DOCUMENTATION & DB INSPECTOR
=============================================================
Run: python scripts/api_docs.py
"""
import asyncio, json, os, sys
from pathlib import Path
# Add backend root to path
sys.path.insert(0, str(Path(__file__).parent.parent))
# ─────────────────────────────────────────────────
# SECTION 1 — DATABASE SCHEMA SUMMARY (10 lines)
# ─────────────────────────────────────────────────
DB_SCHEMA_SUMMARY = """
╔══════════════════ DATABASE SCHEMA SUMMARY ══════════════════════════════╗
║ 1. parties — Party master: id, name, phone, city, party_type, ║
║ past_due, is_active, previous_names (JSON) ║
║ 2. mirchi_types — Mirchi varieties: id, name, is_active ║
║ 3. transactions — Awaak/Jawaak bills: bill_number, bill_date, ║
║ bill_type(awaak|jawaak), party_id, total_amount, ║
║ paid_amount, balance_amount, expenses(JSON), ║
║ lot_number, is_mixed, is_return ║
║ 4. transaction_items — Line items: mirchi_name, poti_count, ║
║ poti_weights, net_weight, rate_per_kg, amount ║
║ 5. transaction_payments — Payments per bill: amount, mode, reference, ║
║ is_reversed ║
║ 6. patti_transactions — Patti bills (patti_awaak|patti_jawaak): ║
║ same as transactions + gross_weight, ║
║ verified_net_weight ║
║ 7. patti_transaction_items — Same structure as transaction_items ║
║ 8. party_jama_entries — Standalone payments: party_id, date, amount, ║
║ reference, notes ║
║ 9. stock_ledger — Stock movements: mirchi_name, movement_type ║
║ (IN|OUT|RETURN_IN|RETURN_OUT), quantity_in/out, ║
║ balance_after, lot_number ║
║ 10.bill_number_sequences — Auto-numbering: bill_type, year, batch(A-Z),║
║ current_number (resets at 500 → next batch) ║
╚═════════════════════════════════════════════════════════════════════════╝
"""
# ─────────────────────────────────────────────────
# SECTION 2 — ALL API ENDPOINTS + EXAMPLE RESPONSES
# ─────────────────────────────────────────────────
API_DOCS = {
# ── PARTIES ──────────────────────────────────
"GET /api/parties": {
"desc": "List all parties (with live current_balance)",
"query_params": "party_type, search, skip, limit",
"example_response": {
"success": True,
"data": [
{
"id": "p-abc123",
"name": "रामलाल ट्रेडर्स",
"phone": "9876543210",
"city": "नांदेड",
"party_type": "both",
"past_due": 5000.0,
"current_balance": 12500.50,
"is_active": True
}
],
"total": 1
}
},
"GET /api/parties/{party_id}": {
"desc": "Single party with computed current_balance",
"example_response": {
"success": True,
"data": {
"id": "p-abc123",
"name": "रामलाल ट्रेडर्स",
"phone": "9876543210",
"city": "नांदेड",
"party_type": "both",
"past_due": 5000.0,
"current_balance": 12500.50,
"previous_names": ["रामलाल"],
"notes": "",
"is_active": True
}
}
},
"GET /api/parties/{party_id}/name-history": {
"desc": "Full rename history for a party",
"example_response": {
"party_id": "p-abc123",
"current_name": "रामलाल ट्रेडर्स",
"name_history": ["रामलाल", "रामलाल एंटरप्रायझेस"]
}
},
"POST /api/parties": {
"desc": "Create a new party",
"request_body": {
"name": "श्याम ट्रेडर्स",
"phone": "9988776655",
"city": "लातूर",
"party_type": "jawaak",
"past_due": 0.0
},
"example_response": {
"success": True,
"message": "Party created successfully",
"data": {"id": "p-xyz789", "name": "श्याम ट्रेडर्स"}
}
},
"PUT /api/parties/{party_id}": {
"desc": "Update party (rename auto-saves to history)",
"request_body": {"name": "श्याम एंटरप्रायझेस", "phone": "9988776655"},
"example_response": {"success": True, "message": "Party updated successfully"}
},
"DELETE /api/parties/{party_id}": {
"desc": "Soft-delete a party (sets is_active=False)",
"example_response": {"success": True, "message": "Party deactivated successfully"}
},
# ── MIRCHI TYPES ─────────────────────────────
"GET /api/mirchi-types": {
"desc": "List mirchi varieties",
"query_params": "active_only=true, skip, limit",
"example_response": {
"success": True,
"data": [
{"id": "m-aaa111", "name": "लाल मिरची", "is_active": True},
{"id": "m-bbb222", "name": "हिरवी मिरची", "is_active": True}
],
"total": 2
}
},
"GET /api/mirchi-types/{mirchi_id}": {
"desc": "Single mirchi type by ID",
"example_response": {"success": True, "data": {"id": "m-aaa111", "name": "लाल मिरची", "is_active": True}}
},
"POST /api/mirchi-types": {
"desc": "Create new mirchi type",
"request_body": {"name": "काळी मिरची"},
"example_response": {"success": True, "message": "Mirchi type created successfully", "data": {"id": "m-ccc333", "name": "काळी मिरची"}}
},
"PUT /api/mirchi-types/{mirchi_id}": {
"desc": "Update mirchi type name or active status",
"request_body": {"name": "काळी मिरची XL", "is_active": True},
"example_response": {"success": True, "message": "Mirchi type updated successfully"}
},
"DELETE /api/mirchi-types/{mirchi_id}": {
"desc": "Hard delete a mirchi type",
"example_response": {"success": True, "message": "Mirchi type deleted successfully"}
},
# ── TRANSACTIONS (Awaak / Jawaak) ────────────
"GET /api/transactions": {
"desc": "List all transactions with filters",
"query_params": "bill_type(awaak|jawaak), party_id, search, start_date, end_date, skip, limit",
"example_response": {
"success": True,
"data": [
{
"id": "t-111aaa",
"bill_number": "A2025A001",
"bill_date": "2025-03-15",
"bill_type": "awaak",
"party_id": "p-abc123",
"party_name": "रामलाल ट्रेडर्स",
"subtotal": 15000.0,
"total_amount": 15200.0,
"paid_amount": 10000.0,
"balance_amount": 5200.0,
"lot_number": "LOT001",
"is_mixed": False,
"is_return": False,
"items": [
{
"mirchi_name": "लाल मिरची",
"poti_count": 10,
"net_weight": 500.0,
"rate_per_kg": 30.0,
"amount": 15000.0
}
],
"payments": [
{"amount": 10000.0, "mode": "cash", "paid_at": "2025-03-15"}
]
}
],
"total": 1
}
},
"GET /api/transactions/next-bill-number": {
"desc": "Get next auto-generated bill number",
"query_params": "bill_type=awaak",
"example_response": {"success": True, "bill_number": "A2025A002"}
},
"GET /api/transactions/bill-number-info": {
"desc": "Batch/sequence info for bill numbering",
"query_params": "bill_type=awaak&year=2025",
"example_response": {
"success": True,
"bill_type": "awaak",
"year": 2025,
"current_batch": "A",
"current_number": 2,
"remaining": 498
}
},
"GET /api/transactions/{transaction_id}": {
"desc": "Get single transaction by ID with items & payments",
"example_response": {"success": True, "data": {"id": "t-111aaa", "bill_number": "A2025A001"}}
},
"POST /api/transactions": {
"desc": "Create a new Awaak or Jawaak transaction",
"request_body": {
"bill_type": "awaak",
"bill_date": "2025-03-15",
"party_id": "p-abc123",
"lot_number": "LOT001",
"items": [
{"mirchi_name": "लाल मिरची", "mirchi_id": "m-aaa111", "poti_count": 10, "poti_weights": "[50,50,50,50,50,50,50,50,50,50]", "net_weight": 500.0, "rate_per_kg": 30.0}
],
"expenses": {"hamali": 200, "other": 0},
"payments": [{"amount": 10000.0, "mode": "cash", "paid_at": "2025-03-15"}]
},
"example_response": {
"success": True,
"message": "Transaction created successfully",
"data": {"id": "t-111aaa", "bill_number": "A2025A001", "total_amount": 15200.0}
}
},
"POST /api/transactions/{transaction_id}/payment": {
"desc": "Add payment to a transaction",
"query_params": "amount=5000",
"example_response": {"success": True, "message": "Payment updated successfully"}
},
"POST /api/transactions/{transaction_id}/revert": {
"desc": "Revert a transaction (creates return bill, reverses stock)",
"example_response": {"success": True, "message": "Transaction reverted successfully"}
},
"DELETE /api/transactions/{transaction_id}": {
"desc": "Delete a transaction",
"example_response": {"success": True, "message": "Transaction deleted successfully"}
},
# ── PATTI TRANSACTIONS ────────────────────────
"GET /api/patti-transactions": {
"desc": "List all patti transactions",
"query_params": "bill_type(patti_awaak|patti_jawaak), party_id, search, start_date, end_date, skip, limit",
"example_response": {
"success": True,
"data": [
{
"id": "pt-222bbb",
"bill_number": "PA2025A001",
"bill_type": "patti_awaak",
"party_name": "गणेश पाटील",
"lot_number": "PLOT001",
"gross_weight": 1000.0,
"verified_net_weight": 980.0,
"total_amount": 29400.0,
"balance_amount": 29400.0
}
],
"total": 1
}
},
"GET /api/patti-transactions/lots/available/{mirchi_id}": {
"desc": "Get available patti lots for Jawaak billing (with weight/bag info)",
"example_response": {
"success": True,
"data": [
{
"id": "patti-lot-PLOT001",
"lot_number": "PLOT001",
"mirchi_name": "लाल मिरची",
"gross_weight": 1000.0,
"remaining_quantity": 980.0,
"poti_count": 20,
"display": "PLOT001 | 980kg | 20 पोती"
}
]
}
},
"GET /api/patti-transactions/next-bill-number": {
"desc": "Get next patti bill number",
"query_params": "bill_type=patti_awaak",
"example_response": {"success": True, "bill_number": "PA2025A001"}
},
"POST /api/patti-transactions": {
"desc": "Create a patti_awaak or patti_jawaak transaction",
"request_body": {
"bill_type": "patti_awaak",
"bill_date": "2025-03-15",
"party_id": "p-abc123",
"lot_number": "PLOT001",
"gross_weight": 1000.0,
"verified_net_weight": 980.0,
"items": [
{"mirchi_name": "लाल मिरची", "mirchi_id": "m-aaa111", "poti_count": 20, "net_weight": 980.0, "rate_per_kg": 30.0}
],
"expenses": {"packing": 100, "commission": 200, "hamali": 150}
},
"example_response": {
"success": True,
"message": "Patti transaction created successfully",
"data": {"id": "pt-222bbb", "bill_number": "PA2025A001"}
}
},
"POST /api/patti-transactions/{transaction_id}/payment": {
"desc": "Add payment to patti transaction",
"query_params": "amount=10000",
"example_response": {"success": True, "message": "Payment updated successfully"}
},
"POST /api/patti-transactions/{transaction_id}/revert": {
"desc": "Revert patti transaction (reverses stock from patti holdings)",
"example_response": {"success": True, "message": "Patti transaction reverted successfully"}
},
"DELETE /api/patti-transactions/{transaction_id}": {
"desc": "Delete a patti transaction",
"example_response": {"success": True, "message": "Patti transaction deleted successfully"}
},
# ── STOCK LEDGER ─────────────────────────────
"GET /api/stock-ledger": {
"desc": "List all stock movement entries",
"query_params": "mirchi_name, movement_type(IN|OUT|RETURN_IN|RETURN_OUT), lot_number, start_date, end_date, skip, limit",
"example_response": {
"success": True,
"data": [
{
"id": "sl-333ccc",
"mirchi_name": "लाल मिरची",
"movement_type": "IN",
"quantity_in": 500.0,
"quantity_out": 0.0,
"balance_after": 500.0,
"lot_number": None,
"created_at": "2025-03-15T10:00:00"
}
],
"total": 1
}
},
"GET /api/stock-ledger/summary": {
"desc": "Summary of current stock by mirchi type",
"example_response": {
"success": True,
"data": [
{"mirchi_name": "लाल मिरची", "balance": 500.0, "total_in": 1000.0, "total_out": 500.0}
]
}
},
"GET /api/stock-ledger/lots": {
"desc": "Lot-wise stock summary (patti lot tracking)",
"query_params": "mirchi_name (optional)",
"example_response": {
"success": True,
"data": [
{"mirchi_name": "लाल मिरची", "lot_number": "PLOT001", "balance": 480.0, "total_in": 980.0, "total_out": 500.0}
]
}
},
"GET /api/stock-ledger/available/{mirchi_id}": {
"desc": "Available lots for Jawaak billing (balance > 0)",
"example_response": {
"success": True,
"data": [
{"id": "lot-PLOT001", "lot_number": "PLOT001", "remaining_quantity": 480.0, "poti_count": 9, "display": "PLOT001 | 480kg | ~9 पोती"}
]
}
},
"GET /api/stock-ledger/balance/{mirchi_name}": {
"desc": "Get current balance for a specific mirchi (optionally by lot)",
"query_params": "lot_number (optional)",
"example_response": {
"success": True,
"data": {"mirchi_name": "लाल मिरची", "lot_number": None, "current_balance": 500.0}
}
},
"GET /api/stock-ledger/analysis": {
"desc": "Lot-wise P&L analysis (buy qty/amt vs sell qty/amt)",
"example_response": {
"success": True,
"data": [
{
"lot_number": "LOT001",
"mirchi_name": "लाल मिरची",
"farmer_name": "रामलाल ट्रेडर्स",
"buy_qty": 500.0,
"buy_amt": 15000.0,
"buy_poti": 10,
"sell_qty": 300.0,
"sell_amt": 10500.0,
"sell_poti": 6,
"commission": 0.0,
"is_patti": False
}
]
}
},
"GET /api/stock-ledger/{ledger_id}": {
"desc": "Single stock ledger entry by ID",
"example_response": {"success": True, "data": {"id": "sl-333ccc", "movement_type": "IN"}}
},
# ── PARTY JAMA (Ledger Payments) ─────────────
"GET /api/party-jama": {
"desc": "List all standalone jama (payment) entries",
"query_params": "party_id, start_date, end_date, skip, limit",
"example_response": {
"success": True,
"data": [
{"id": "pj-444ddd", "party_id": "p-abc123", "date": "2025-03-14", "amount": 5000.0, "reference": "UPI-123", "notes": ""}
],
"total": 1
}
},
"GET /api/party-jama/party/{party_id}/balance": {
"desc": "Party's computed balance (transactions + jama)",
"example_response": {
"success": True,
"data": {
"party_id": "p-abc123",
"past_due": 5000.0,
"regular_balance": 7500.0,
"patti_balance": 0.0,
"jama_total": 2000.0,
"current_balance": 10500.0
}
}
},
"GET /api/party-jama/party/{party_id}/ledger": {
"desc": "Full chronological party ledger (bills + jama entries merged)",
"query_params": "start_date, end_date",
"example_response": {
"success": True,
"data": {
"party": {"id": "p-abc123", "name": "रामलाल ट्रेडर्स"},
"entries": [
{"date": "2025-03-10", "type": "transaction", "bill_number": "A2025A001", "debit": 15200.0, "credit": 0, "balance": 15200.0},
{"date": "2025-03-14", "type": "jama", "reference": "UPI-123", "debit": 0, "credit": 5000.0, "balance": 10200.0}
],
"total_debit": 15200.0,
"total_credit": 5000.0,
"closing_balance": 10200.0
}
}
},
"POST /api/party-jama": {
"desc": "Create a standalone jama (payment) entry",
"request_body": {
"party_id": "p-abc123",
"date": "2025-03-15",
"amount": 5000.0,
"reference": "UPI-456",
"notes": "आगाऊ रक्कम"
},
"example_response": {"success": True, "message": "Jama entry created successfully", "data": {"id": "pj-555eee"}}
},
"PUT /api/party-jama/{entry_id}": {
"desc": "Update a jama entry",
"request_body": {"amount": 6000.0, "notes": "सुधारित रक्कम"},
"example_response": {"success": True, "message": "Jama entry updated successfully"}
},
"DELETE /api/party-jama/{entry_id}": {
"desc": "Delete a jama entry",
"example_response": {"success": True, "message": "Jama entry deleted successfully"}
},
# ── MISC ──────────────────────────────────────
"GET /health": {
"desc": "App health check",
"example_response": {"status": "healthy", "app": "Mirchi Trading API", "version": "1.0.0"}
},
"GET /": {
"desc": "Root info endpoint",
"example_response": {"message": "Welcome to Mirchi Trading API", "version": "1.0.0", "docs": "/docs"}
}
}
# ─────────────────────────────────────────────────
# SECTION 3 — LIVE DB TABLE INSPECTION (PostgreSQL)
# ─────────────────────────────────────────────────
async def inspect_database():
"""Connect to PostgreSQL and print table names + column count"""
try:
from sqlalchemy.ext.asyncio import create_async_engine
from sqlalchemy import text
from dotenv import load_dotenv
env_path = Path(__file__).parent.parent / ".env"
load_dotenv(env_path)
db_url = os.getenv("DATABASE_URL", "")
if not db_url:
print("⚠️ DATABASE_URL not found in .env")
return
engine = create_async_engine(db_url, echo=False)
async with engine.connect() as conn:
# Get all tables
tables_result = await conn.execute(text("""
SELECT table_name
FROM information_schema.tables
WHERE table_schema = 'public'
ORDER BY table_name;
"""))
tables = [row[0] for row in tables_result]
print(f"\n{'='*60}")
print(f" LIVE DATABASE TABLES ({len(tables)} tables found)")
print(f"{'='*60}")
for table in tables:
# Get columns for each table
cols_result = await conn.execute(text(f"""
SELECT column_name, data_type, is_nullable, column_default
FROM information_schema.columns
WHERE table_schema = 'public' AND table_name = '{table}'
ORDER BY ordinal_position;
"""))
cols = cols_result.fetchall()
# Get row count
count_result = await conn.execute(text(f'SELECT COUNT(*) FROM "{table}"'))
row_count = count_result.scalar()
print(f"\n📋 {table.upper()} ({row_count} rows)")
print(f" {'Column':<35} {'Type':<25} {'Nullable'}")
print(f" {'-'*35} {'-'*25} {'-'*8}")
for col in cols:
nullable = "YES" if col[2] == "YES" else "NO "
print(f" {col[0]:<35} {col[1]:<25} {nullable}")
await engine.dispose()
except Exception as e:
print(f"\n⚠️ Could not connect to database: {e}")
print(" (Showing schema from models only)\n")
# ─────────────────────────────────────────────────
# MAIN RUNNER
# ─────────────────────────────────────────────────
def print_api_docs():
print(f"\n{'='*70}")
print(" MIRCHI TRADING — ALL API ENDPOINTS + EXAMPLE RESPONSES")
print(f"{'='*70}")
print(f" Base URL: http://localhost:8000\n")
for i, (endpoint, info) in enumerate(API_DOCS.items(), 1):
print(f"\n[{i:02d}] {endpoint}")
print(f" ↳ {info['desc']}")
if "query_params" in info:
print(f" Params: {info['query_params']}")
if "request_body" in info:
body = json.dumps(info['request_body'], ensure_ascii=False, indent=8)
print(f" Body: {body[:200]}{'...' if len(body) > 200 else ''}")
resp = json.dumps(info['example_response'], ensure_ascii=False, indent=8)
resp_short = resp[:300] + ("..." if len(resp) > 300 else "")
print(f" Response: {resp_short}")
print(f" {'─'*65}")
print(f"\n{'='*70}")
print(f" TOTAL ENDPOINTS: {len(API_DOCS)}")
print(f"{'='*70}\n")
async def main():
print(DB_SCHEMA_SUMMARY)
await inspect_database()
print_api_docs()
print("\n✅ Documentation complete. API docs also available at: http://localhost:8000/docs")
if __name__ == "__main__":
asyncio.run(main())
|