documentation-update-api

API Documentation Update Guide

This prompt systematically updates API documentation to reflect current endpoints, schemas, authentication methods, and integration patterns while maintaining comprehensive OpenAPI standards.

🎯 OBJECTIVES:

1. UPDATE endpoint documentation to reflect current API implementation
2. SYNCHRONIZE OpenAPI specifications with actual API behavior
3. MAINTAIN authentication and authorization documentation accuracy
4. ENSURE schema accuracy for all request and response types
5. VALIDATE integration examples and client implementation guides

📋 API DOCUMENTATION UPDATE PROCESS:

STEP 1: API Implementation Assessment

Current API Analysis:

echo "🔌 API Implementation Assessment"
echo "==============================="

# Discover API routes
echo "Current API Routes:"
find src/app/api -name "route.ts" -o -name "*.ts" | sort

# Check API configuration
echo "API Configuration:"
find . -name "*api*" -name "*.config.*" 2>/dev/null

# Verify authentication setup
echo "Authentication Implementation:"
find src/ -name "*auth*" -o -name "*jwt*" -o -name "*token*" | head -10

# Check database/data layer
echo "Data Layer Implementation:"
find src/ -name "*schema*" -o -name "*model*" -o -name "*db*" | head -10

# Review middleware and validation
echo "API Middleware:"
find src/ -name "*middleware*" -o -name "*validation*" | head -5

API Change Detection:

• New endpoints added since last documentation update
• Modified endpoints with changed behavior or parameters
• Deprecated endpoints that should be marked or removed
• Authentication changes affecting API access patterns
• Schema modifications affecting request/response structures

Documentation Gap Analysis:

• Undocumented endpoints missing from API documentation
• Outdated schemas not reflecting current data structures
• Missing authentication docs for new auth methods
• Incomplete examples lacking current implementation details
• Broken integration guides that no longer work with current API