feat: redesign API documentation with comprehensive endpoint coverage #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix national endpoint parameters: removed incorrect page/limit, added start_date/end_date/sort - Add new endpoint documentation: root endpoint, health check, provinces, province cases - Update test links to redirect to Swagger UI instead of direct API endpoints - Add comprehensive i18n translations for all new endpoints
- Add comprehensive sidebar navigation for new endpoints - Create RootEndpointSection, HealthCheckSection, ProvincesSection, ProvinceCasesSection components - Update Tailwind config with PICO logo-inspired color palette (sky blue to deep blue gradients) - Replace all blue-* classes with pico-* custom colors throughout the application - Ensure consistent brand alignment with logo design - All components render properly and build successfully
- Remove API simulation functionality, redirect all testing to Swagger UI - Replace complex layouts with clean parameter and response field tables - Standardize documentation structure across all endpoints: * Clean header with HTTP method and endpoint * Parameters table with type, description, and requirement info * Response fields table with comprehensive field descriptions * Single 'Try It' button redirecting to Swagger UI - Improve readability and professional appearance - Maintain consistent PICO brand colors throughout - Simplify component scripts by removing unnecessary API calls
…point - Parameter was dropped from API as latest case data is now always included by default - Update documentation to reflect current API behavior - Clarify in response fields that latest_case is always included
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Complete redesign and expansion of API documentation with comprehensive endpoint coverage and clean table-based layouts.
🆕 New Features
/) - Lists all available API endpoints/health) - API status monitoring/provinces) - All Indonesian provinces data/provinces/cases) - Paginated province case data🎨 Design Improvements
🔧 Technical Updates
📚 Documentation Structure
Each endpoint now features:
🌐 Multilingual Support
🎯 User Experience
✅ Quality Assurance