Skip to content

feat: update API documentation to match latest backend implementation #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 8, 2025
Merged

feat: update API documentation to match latest backend implementation #10

merged 1 commit into from
Sep 8, 2025

Conversation

@ryanaidilp
Copy link
Contributor

@ryanaidilp ryanaidilp commented Sep 8, 2025

Summary

Comprehensive update to align documentation with the actual Go backend API implementation based on latest Swagger analysis.

Major Updates

🔄 National Historical Endpoint Enhancement

  • Added pagination parameters: cputime unlimited
    filesize unlimited
    datasize unlimited
    stacksize 7MB
    coredumpsize 0kB
    addressspace unlimited
    memorylocked unlimited
    maxproc 2666
    descriptors 1048575, , , with proper defaults and limits
  • Enhanced response structure: Added and fields
  • Complete field documentation: Replaced generic reference with detailed response structure

🏘️ Provincial Data Enhancement

  • ODP/PDP tracking: Added complete Orang Dalam Pengawasan and Pasien Dalam Pengawasan data fields
  • Enhanced daily/cumulative structure: Include active/finished counts for ODP/PDP
  • Province-specific fields: Added province.id and province.name documentation
  • Statistics integration: Added percentage calculations and reproduction rate for provinces

🔒 Authentication & Rate Limiting

  • Response headers documentation: Added and header specifications
  • Detailed rate limit info: 100 requests/minute already documented, added header responses

✅ Technical Validation

  • All changes based on Go backend API analysis (v2.3.0)
  • Build passes successfully with no errors
  • Base URLs and versioning (/api/v1) confirmed accurate
  • Comprehensive field structures replace vague references

Test Plan

  • Build completes without errors
  • All new fields documented with correct types and descriptions
  • Pagination parameters include proper defaults and limits
  • ODP/PDP Indonesian terminology properly explained
  • Rate limiting headers match backend implementation

Impact

  • Developers get accurate, complete API field documentation
  • Integration teams have precise parameter specifications
  • Documentation consistency matches actual backend implementation
  • No breaking changes - purely documentation enhancements

@ryanaidilp
feat: update API documentation to match latest backend implementation
79c1094 
- 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
@ryanaidilp ryanaidilp self-assigned this Sep 8, 2025
@ryanaidilp ryanaidilp merged commit d35f65a into develop Sep 8, 2025
2 checks passed
@ryanaidilp ryanaidilp deleted the feature/update-api-docs-with-latest-swagger branch September 8, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@ryanaidilp ryanaidilp

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ryanaidilp