manual fix

Author: ks6088ts

README.md

@@ -1,3 +1,9 @@
+[![test](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/test.yaml?query=branch%3Amain)
+[![docker](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/docker.yaml/badge.svg?branch=main)](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/docker.yaml?query=branch%3Amain)
+[![docker-release](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/docker-release.yaml/badge.svg)](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/docker-release.yaml)
+[![ghcr-release](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/ghcr-release.yaml/badge.svg)](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/ghcr-release.yaml)
+[![docs](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/github-pages.yaml/badge.svg)](https://github.com/ks6088ts-labs/template-fastapi/actions/workflows/github-pages.yaml)
+
 # template-fastapi
 
 A comprehensive FastAPI template with Azure cloud services integration, Agent-based workflows, and multi-service API architecture.
@@ -24,7 +30,7 @@ A comprehensive FastAPI template with Azure cloud services integration, Agent-ba
 
 ```bash
 # Clone the repository
-git clone <repository-url>
+git clone https://github.com/ks6088ts-labs/template-fastapi.git
 cd template-fastapi
 
 # Install dependencies
@@ -56,17 +62,20 @@ The API will be available at http://localhost:8000 with interactive documentatio
 ## API Services
 
 ### Core Services
+
 - **Items API** (`/items/`): CRUD operations for item management
 - **Files API** (`/files/`): File upload, download, and management with Azure Blob Storage
 - **Restaurants API** (`/foodies/`): Restaurant discovery with geospatial search
 - **Speech API** (`/speeches/`): Batch transcription jobs using Azure AI Speech
 
 ### Agent Services
+
 - **LangGraph Agents** (`/agents/langgraph/`): AI agents with custom tools
 - **Azure AI Foundry** (`/agents/azure-ai-foundry/`): Thread-based conversations
 - **Chat Interface** (`/chats/`): Real-time WebSocket chat with agent integration
 
 ### Demo & Utilities
+
 - **Demo Endpoints** (`/demos/`): Dice rolling, flaky endpoints for testing
 - **Health & Monitoring**: Application Insights integration with OpenTelemetry
 
@@ -103,9 +112,6 @@ make docker-build
 
 # Run container
 docker run -p 8000:8000 --env-file .env ks6088ts/template-fastapi:latest
-
-# Docker Compose (if available)
-docker-compose up
 ```
 
 ## Development

docs/external-specification.md

@@ -1,3 +1,6 @@
+> [!CAUTION]
+> These design documents are generated by AI and may not be fully accurate or complete. They are intended to provide a starting point for understanding the system architecture and design patterns used in the template-fastapi application.
+
 # External API Specification
 
 ## Overview
@@ -13,6 +16,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: Core CRUD operations for item management with Azure CosmosDB backend.
 
 **Endpoints**:
+
 - `GET /items/` - List all items with pagination
 - `GET /items/{item_id}` - Retrieve specific item
 - `POST /items/` - Create new item
@@ -21,10 +25,11 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 - `GET /items/search/?q={query}` - Search items by text
 
 **Data Model**:
+
 ```json
 {
   "id": "string",
-  "name": "string", 
+  "name": "string",
   "description": "string",
   "price": 0.0,
   "tax": 0.0
@@ -38,6 +43,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: File upload, storage, and retrieval using Azure Blob Storage.
 
 **Endpoints**:
+
 - `GET /files/` - List files with optional prefix filter
 - `POST /files/upload` - Upload single file
 - `POST /files/upload-multiple` - Upload multiple files
@@ -47,6 +53,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 - `DELETE /files/` - Delete multiple files (request body)
 
 **Features**:
+
 - Automatic content type detection
 - File metadata tracking
 - Bulk operations support
@@ -58,6 +65,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: Restaurant management with geospatial search capabilities.
 
 **Endpoints**:
+
 - `GET /restaurants/` - List restaurants with pagination
 - `GET /restaurants/{id}` - Get restaurant details
 - `POST /restaurants/` - Create new restaurant
@@ -67,6 +75,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 - `GET /restaurants/near/?latitude={lat}&longitude={lng}` - Geospatial proximity search
 
 **Search Features**:
+
 - Text-based vector search using embeddings
 - Location-based proximity search with configurable radius
 - Pagination support for all list operations
@@ -78,6 +87,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: Batch audio transcription using Azure AI Speech Services.
 
 **Endpoints**:
+
 - `GET /transcriptions/` - List all transcription jobs
 - `POST /transcriptions/` - Create transcription job
 - `GET /transcriptions/{job_id}` - Get job status
@@ -86,38 +96,45 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 - `DELETE /transcriptions/{job_id}` - Delete job
 
 **Workflow**:
+
 1. Submit audio URLs for batch processing
 2. Monitor job status (Created → Running → Succeeded/Failed)
 3. Retrieve transcription results when complete
 
 ### 5. Agent-Based Conversation API
 
 #### LangGraph Agents
+
 **Base Path**: `/agents/langgraph/`
 
 **Purpose**: AI agents with custom tools for mathematical calculations, web search, and time queries.
 
 **Endpoints**:
+
 - `GET /tools` - List available agent tools
 
 **Available Tools**:
+
 - Calculator: Mathematical expression evaluation
 - Current Time: Timezone-aware time queries
 - Search: Web search capabilities
 
 #### Azure AI Foundry Agents
+
 **Base Path**: `/agents/azure-ai-foundry/`
 
 **Purpose**: Thread-based conversational AI using Azure AI Foundry platform.
 
 **Agent Management**:
+
 - `GET /` - List agents
 - `POST /` - Create agent
 - `GET /{agent_id}` - Get agent details
 - `DELETE /{agent_id}` - Delete agent
 - `POST /{agent_id}/chat` - Chat with agent
 
 **Thread Management**:
+
 - `GET /threads/` - List conversation threads
 - `POST /threads/` - Create new thread
 - `GET /threads/{thread_id}` - Get thread details
@@ -130,10 +147,12 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: WebSocket-based real-time chat with HTML interface.
 
 **Endpoints**:
+
 - `GET /` - Chat interface (HTML page)
 - `WebSocket /ws/{client_id}` - Real-time messaging
 
 **Features**:
+
 - Real-time bidirectional communication
 - Multi-client support
 - Agent integration capabilities
@@ -145,6 +164,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 **Purpose**: Demonstration endpoints for testing and monitoring.
 
 **Endpoints**:
+
 - `GET /roll_dice` - Random dice roll (1-6)
 - `GET /flaky/{failure_rate}` - Configurable failure simulation (0-100%)
 - `GET /flaky/exception` - Guaranteed exception endpoint
@@ -153,43 +173,51 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 ## Azure Cloud Services Integration
 
 ### Azure CosmosDB
+
 - **Purpose**: Primary database for items and restaurant data
 - **Features**: Global distribution, automatic scaling, vector search support
 - **Configuration**: Connection string in `AZURE_COSMOSDB_CONNECTION_STRING`
 
 ### Azure Blob Storage
+
 - **Purpose**: File storage and management
 - **Features**: Hierarchical namespace, metadata support, CDN integration
 - **Configuration**: Connection string in `AZURE_BLOB_STORAGE_CONNECTION_STRING`
 
 ### Azure OpenAI Service
+
 - **Purpose**: LLM capabilities for agents and embeddings
 - **Models**: GPT-4o for chat, text-embedding-3-small for search
 - **Configuration**: Endpoint and API key in environment variables
 
 ### Azure AI Speech
+
 - **Purpose**: Batch audio transcription
 - **Features**: Multi-language support, custom vocabulary, speaker diarization
 - **Configuration**: API key and endpoint in environment variables
 
 ### Azure AI Foundry
+
 - **Purpose**: Enterprise AI agent platform
 - **Features**: Thread-based conversations, tool integration, model selection
 - **Configuration**: Project endpoint and API key
 
 ### Azure Application Insights
+
 - **Purpose**: Application monitoring and telemetry
 - **Features**: Request tracing, performance monitoring, custom metrics
 - **Configuration**: Connection string enables automatic instrumentation
 
 ## Authentication & Security
 
 ### Current Implementation
+
 - No authentication required (template/development setup)
 - Internal service-to-service authentication via API keys
 - Azure services authenticate via connection strings
 
 ### Production Recommendations
+
 - Implement OAuth 2.0 / JWT authentication
 - Use Azure Active Directory integration
 - Enable API rate limiting
@@ -199,6 +227,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 ## Error Handling
 
 ### Standard HTTP Status Codes
+
 - `200` - Success
 - `201` - Created
 - `400` - Bad Request (validation errors)
@@ -207,6 +236,7 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 - `500` - Internal Server Error
 
 ### Error Response Format
+
 ```json
 {
   "detail": "Error description in Japanese/English",
@@ -218,28 +248,33 @@ The template-fastapi application provides a comprehensive REST API built with Fa
 ## Monitoring & Observability
 
 ### Structured Logging
+
 - Configurable log levels via `LOG_LEVEL` environment variable
 - JSON-structured logs for production deployment
 - Request/response logging with correlation IDs
 
 ### Metrics & Tracing
+
 - OpenTelemetry integration with Azure Application Insights
 - Custom metrics for business operations
 - Distributed tracing across service boundaries
 
 ### Health Checks
+
 - Built-in FastAPI health monitoring
 - Azure service dependency health checks
 - Container readiness and liveness probes
 
 ## API Versioning & Compatibility
 
 ### Current Version
+
 - API Version: 1.0
 - No explicit versioning in URLs (future consideration)
 - Backward compatibility maintained for minor updates
 
 ### Future Considerations
+
 - URL-based versioning (`/v1/`, `/v2/`)
 - Header-based versioning
-- Feature flags for gradual rollouts
+- Feature flags for gradual rollouts