Skip to content

Introduce External API, enhance timestamps, and update documentation#112

Merged
chvvkumar merged 5 commits intomainfrom
dev
Feb 5, 2026
Merged

Introduce External API, enhance timestamps, and update documentation#112
chvvkumar merged 5 commits intomainfrom
dev

Conversation

@chvvkumar
Copy link
Owner

@chvvkumar chvvkumar commented Feb 5, 2026

📋 Overview

This pull request introduces a new external REST API for retrieving system status and client information, significantly expanding the system's external integration capabilities. It also enhances existing functionality by adding dates to all timestamps and updating the 'Last Updated' field to display known upcoming device state changes. These new features are accompanied by comprehensive documentation updates, including a dedicated guide for the new external API.

🔄 Changes by Category

  • Features:
    • Added a new external REST API (alpaca/routes/external_api.py) with routes for system status and client information.
    • Implemented date inclusion for all timestamps across the system, affecting alpaca/device.py and other relevant files.
    • Enhanced the 'Last Updated' field in alpaca/device.py to display known upcoming device state changes, with corresponding updates to templates/setup.html for display.
    • Minor adjustments to existing API routes (alpaca/routes/api.py, alpaca/routes/management.py) to support new functionality.
  • Documentation:
    • Created docs/EXTERNAL_API.md with detailed descriptions, endpoint specifications, and usage examples for the new external REST API.
    • Refactored the documentation structure by moving the ASCOM Alpaca SafetyMonitor guide to docs/ALPACA_README.md.
    • Updated the main readme.md to reflect the new documentation structure and include references to the new external API documentation.
  • Configuration:
    • Updated alpaca/__init__.py to register and make the new external API routes accessible.
    • Modified templates/setup.html to integrate and display the enhanced 'Last Updated' information.

📊 Analyzed 5 commit(s) | 🕐 Updated: 2026-02-05T03:39:38.960Z | Generated by GitHub Actions


- Move ASCOM Alpaca SafetyMonitor guide to docs/ALPACA_README.md and update references in main README.
- Add new External REST API documentation in docs/EXTERNAL_API.md with detailed endpoint descriptions and usage examples.
Introduce External API for System Status and Date Timestamps
Enhance 'Last Updated' to show upcoming device state changes
@github-actions github-actions bot changed the title Dev Introduce External API, enhance timestamps, and update documentation Feb 5, 2026
@chvvkumar chvvkumar merged commit f0fc2b1 into main Feb 5, 2026
14 checks passed
@chvvkumar chvvkumar linked an issue Feb 5, 2026 that may be closed by this pull request
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.

A few small improvements for your consideration

1 participant