api

API Reference

This folder contains the OpenAPI Specification (OAS 3.1) for the devJournal REST API.

Contents

• openapi.yaml - Complete API specification in OpenAPI 3.1 format

Viewing the API Documentation

The API specification is written in OpenAPI 3.1 format and can be viewed using:

• Redocly (VS Code extension) - Renders the YAML in a readable format
• Swagger Editor - https://editor.swagger.io/
• Redoc - https://redocly.github.io/redoc/

API Overview

The devJournal API provides endpoints for:

• Journal Entries - Create, read, update, and delete (soft) time entries
• Entry Commit - Bulk commit draft entries for a specific date
• User Preferences - Manage cross-device synced user preferences (ticket MRU, filters, theme)

Base URLs

• Development: http://localhost:8787
• Production: https://devjournal.troyforster.workers.dev

Authentication

Currently uses Basic HTTP authentication with hardcoded credentials for single-user deployment. See ADR-003: Authentication Strategy for details.

Key Endpoints

Journal Entries

• GET /api/entries - List entries with optional filters
• POST /api/entries - Create new entry (DRAFT status)
• PATCH /api/entries/:id - Update draft entry
• DELETE /api/entries/:id - Soft delete entry
• POST /api/entries/commit - Bulk commit entries for a date

User Preferences

• GET /api/preferences - Retrieve user preferences
• PUT /api/preferences - Update user preferences

Data Model

See the Database Schema for table structures and relationships.

Related Documentation

• Technical Specifications - Database schema, data models
• Architecture - Design decisions and rationale
• ADR-001: Fat-Free Stack - Technology stack choices

---

← Back to Reference