46 lines
857 B
Markdown
46 lines
857 B
Markdown
# Interface Specification
|
|
|
|
## 1. Introduction
|
|
|
|
### 1.1. Purpose
|
|
|
|
### 1.2. Scope
|
|
|
|
### 1.3. Definitions, Acronyms, and Abbreviations
|
|
|
|
## 2. Interface Overview
|
|
|
|
### 2.1. System Context
|
|
|
|
### 2.2. Interface Diagram
|
|
|
|
## 3. Functional Description
|
|
|
|
### 3.1 Health Check JSON Schema
|
|
|
|
{
|
|
"service_status": "RUNNING | DEGRADED | DOWN",
|
|
"grpc_connection_status": "CONNECTED | DISCONNECTED",
|
|
"last_successful_collection_ts": "2025-11-17T10:52:10Z",
|
|
"http_collection_error_count": 15,
|
|
"endpoints_success_last_30s": 998,
|
|
"endpoints_failed_last_30s": 2
|
|
}
|
|
|
|
### 3.1. Major Functions
|
|
|
|
## 4. Performance Requirements
|
|
|
|
## 5. Detailed Interface Specification
|
|
|
|
### 5.1. Data Model
|
|
|
|
### 5.2. Communication Protocol
|
|
|
|
### 5.3. Endpoint / Method Definitions
|
|
|
|
## 6. Error Handling
|
|
|
|
## 7. Security Considerations
|
|
|
|
## 8. Versioning |