Skip to content

Conversation

@ryanaidilp
Copy link
Contributor

Release v1.1.0

This release includes comprehensive API documentation improvements and workflow automation enhancements.

🚀 What's New

✨ Added

  • Complete API documentation overhaul with backend implementation accuracy
  • Enhanced national historical data documentation with pagination parameters
  • Provincial data documentation with ODP/PDP tracking fields
  • GitFlow workflow automation following pico-api-go pattern
  • Comprehensive statistics and reproduction rate fields in API responses

🔧 Changed

  • Redesigned documentation sections with clean table-based layout
  • Improved authentication section with detailed rate limiting headers

🐛 Fixed

  • Workflow syntax and formatting improvements
  • Removed outdated API parameters from provinces endpoint documentation
  • Resolved changelog script multiline parsing issues

🏠 Maintenance

  • Added trailing newlines to all source files for consistency
  • Removed unnecessary files and cleaned up repository

📋 Documentation Improvements

  • Complete API Reference: Updated to match Go backend API v2.4.0 implementation
  • Enhanced Provincial Data: Added comprehensive ODP (Orang Dalam Pengawasan) and PDP (Pasien Dalam Pengawasan) tracking
  • Pagination Documentation: Added missing cputime unlimited
    filesize unlimited
    datasize unlimited
    stacksize 7MB
    coredumpsize 0kB
    addressspace unlimited
    memorylocked unlimited
    maxproc 2666
    descriptors 1048575, , , parameters
  • Response Structures: Complete field documentation with statistics and reproduction rates
  • Rate Limiting: Detailed header specifications and usage guidance

🔄 Workflow Automation

  • Automated release branch preparation
  • GitFlow-compliant branching strategy
  • Changelog generation improvements
  • Version bumping automation

🧪 Testing

  • Build passes successfully
  • All documentation reflects actual API implementation
  • Changelog generation works properly
  • No breaking changes to existing functionality

Ready for production deployment! 🚀

ryanaidilp and others added 20 commits September 8, 2025 13:30
chore(backmerge): bacmerge v1.0.0 to develop
- 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
…on-endpoints

feat: redesign API documentation with comprehensive endpoint coverage
…tern

- Add release-branch-creation.yml workflow for automated release preparation
- Update release-automation.yml to handle tag creation and back-merge to develop
- Create generate_changelog.rb script for automated changelog generation
- Support release branches (with develop version bump) and hotfix branches (no develop bump)
- Automatically create PRs for release preparation and develop version bumps
- Follow semantic versioning with minor version increments for develop branch
- Include proper YAML validation and error handling
- Update package.json version to 1.1.0 for next development cycle

This implements the complete GitFlow automation pattern from pico-api-go project,
adapted for JavaScript/Vue.js projects with package.json version management.
- Fix duplicate 'description' keys in translation files causing display issue
- Add comprehensive description paragraph with use cases and guidance
- Replace generic response reference with complete field structure table
- Add usage note section explaining when to use historical vs latest endpoint
- Improve visual design with info boxes and better organization
- Fix YAML formatting and syntax issues
- Add proper newlines to workflow files
- Update workflow configurations
- Add missing trailing newlines to Vue components
- Add missing trailing newlines to JSON translation files
- Add missing trailing newlines to package.json
- Ensure consistent file formatting across codebase
…rical-docs

feat: enhance national historical data documentation
- Add comprehensive pagination parameters (limit, offset, page, all) to national historical endpoint
- Include complete province response structure with ODP/PDP tracking data
- Add statistics fields including percentages and reproduction rate calculations
- Update authentication section with detailed rate limiting headers information
- Replace generic response references with complete field structures
- Ensure documentation accuracy matches Go backend API v2.3.0 implementation
…latest-swagger

feat: update API documentation to match latest backend implementation
- Update version to 1.1.0 in package.json

- Generate release changelog

This commit prepares the release/v1.1.0 branch for release.
@ryanaidilp ryanaidilp self-assigned this Sep 8, 2025
@ryanaidilp ryanaidilp merged commit 7ab6afb into main Sep 8, 2025
2 checks passed
github-actions bot added a commit that referenced this pull request Sep 8, 2025
Automated back-merge of release v1.1.0 from main branch.

Original PR: #13
Merged commit: 7ab6afb
Tag created: v1.1.0
Branch: chore/back-merge-v1.1.0-to-develop
@github-actions github-actions bot deleted the release/v1.1.0 branch September 8, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants