Skip to content

middleware.md

Latest commit

 

History

History
34 lines (23 loc) · 1.59 KB

middleware.md

File metadata and controls

34 lines (23 loc) · 1.59 KB

Middleware Management API

Overview

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.

Background

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.

API Specification

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:

Swagger Editor - Middleware Management API

The interactive documentation provides:

  • Complete endpoint definitions with request/response examples
  • Detailed schema specifications for all data models
  • Parameter descriptions and validation rules
  • Error response definitions
  • The ability to test API calls directly

File Structure

pro_tes/
├── api/
│   └── middleware_management.yaml          (OpenAPI specification)
└── config.yaml                             (References the specification)

docs/
└── middleware.md                           (This documentation)