Skip to content

Commit f47ccdc

Browse files
authored
feat: add middleware management API specs (#196)
1 parent 896716e commit f47ccdc

File tree

3 files changed

+739
-0
lines changed

3 files changed

+739
-0
lines changed

docs/middleware.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Middleware Management API
2+
3+
## Overview
4+
5+
The Middleware Management API provides REST endpoints for dynamically managing middleware components in proTES at runtime. This API allows administrators and developers to add, configure, update, and remove middleware without service restarts.
6+
7+
## Background
8+
9+
proTES uses a middleware architecture to process task execution requests. Previously, middleware configuration was static and required service restarts for any changes. The Middleware Management API enables dynamic runtime configuration, making it easier to adapt the service to changing requirements and deploy new middleware components.
10+
11+
## API Specification
12+
13+
The Middleware Management API is defined using OpenAPI 3.0 specification. For comprehensive, interactive documentation with the ability to explore endpoints, request/response schemas, and examples, please visit:
14+
15+
**[Swagger Editor - Middleware Management API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/elixir-cloud-aai/proTES/refs/heads/dev/pro_tes/api/middleware_management.yaml)**
16+
17+
The interactive documentation provides:
18+
- Complete endpoint definitions with request/response examples
19+
- Detailed schema specifications for all data models
20+
- Parameter descriptions and validation rules
21+
- Error response definitions
22+
- The ability to test API calls directly
23+
24+
## File Structure
25+
26+
```
27+
pro_tes/
28+
├── api/
29+
│ └── middleware_management.yaml (OpenAPI specification)
30+
└── config.yaml (References the specification)
31+
32+
docs/
33+
└── middleware.md (This documentation)
34+
```

0 commit comments

Comments
 (0)