-
Notifications
You must be signed in to change notification settings - Fork 6
feat: add middleware management API specs #196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e41708a
feat: add middleware management OpenAPI spec with 7 endpoints and FOC…
keshxvdayal febdfb9
feat: add middleware management Op
keshxvdayal a772ad9
feat: add middleware management OpenAPI spec with 7 endpoints and FOC…
keshxvdayal 5025c12
fix: enable auth, use PascalCase operationIds, fix schemas and indexes
keshxvdayal e82d18d
feat: suggested changes by alex and copilot are done
keshxvdayal 75b5277
feat: additional suggested changes implemented
keshxvdayal 670b061
feat: issues addressed correctly
keshxvdayal c16a1b0
feat: new issues addressed
keshxvdayal 407254e
feat: old comments addressed
keshxvdayal b8b8f99
feat: new changes addressed successfully
keshxvdayal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # 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](https://editor.swagger.io/?url=https://raw.githubusercontent.com/elixir-cloud-aai/proTES/refs/heads/dev/pro_tes/api/middleware_management.yaml)** | ||
|
|
||
| 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) | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.