admin/labFusion

Files

History

GSRN 8abc2fd55a

Integration Tests / integration-tests (push) Failing after 19s

Details

Integration Tests / performance-tests (push) Has been skipped

Details

API Docs (Node.js Express) / test (20) (push) Successful in 1m29s

Details

API Docs (Node.js Express) / build (push) Successful in 31s

Details

fix: Clean up whitespace and improve code formatting in API Docs server

### Summary of Changes
- Removed unnecessary whitespace in the `generateUnifiedSpec` function to enhance code readability.
- Standardized formatting in the `operationsSorter` function for consistency.

### Expected Results
- Improved code clarity and maintainability, making it easier for developers to read and understand the API Docs server code.

2025-09-18 12:05:47 +02:00

..

Update CI workflows for Python linting by increasing flake8 line length limit to 150 characters for better readability; adjust service-adapters.yml and ci.yml accordingly; update progress documentation

2025-09-12 22:42:47 +02:00

.eslintignore

Enhance API Docs CI workflow by adding node_modules/.bin to PATH and updating ESLint configuration; include additional ESLint and testing dependencies in package.json

2025-09-12 12:01:26 +02:00

.eslintrc.js

Refactor ESLint configuration in API Docs service to improve code style enforcement by removing quotes and semi colons from array syntax

2025-09-12 13:15:13 +02:00

CLEAN_CODE.md

Update README and documentation; refactor frontend components for improved structure and resilience

2025-09-11 23:46:29 +02:00

jest.config.js

Update CI workflows for Python linting by increasing flake8 line length limit to 150 characters for better readability; adjust service-adapters.yml and ci.yml accordingly; update progress documentation

2025-09-12 22:42:47 +02:00

jest.setup.js

Update CI workflows for Python linting by increasing flake8 line length limit to 150 characters for better readability; adjust service-adapters.yml and ci.yml accordingly; update progress documentation

2025-09-12 22:42:47 +02:00

package-lock.json

chore: Update Docker and Node.js dependencies to latest versions

2025-09-16 11:33:49 +02:00

package.json

chore: Update Docker and Node.js dependencies to latest versions

2025-09-16 11:33:49 +02:00

README.md

update documentation

2025-09-17 23:41:26 +02:00

server.js

fix: Clean up whitespace and improve code formatting in API Docs server

2025-09-18 12:05:47 +02:00

README.md

API Documentation Service

A unified API documentation service that aggregates OpenAPI specifications from all LabFusion services.

Purpose

Provide a single entry point for all API documentation
Aggregate OpenAPI specs from all active services
Display unified Swagger UI for the entire LabFusion ecosystem
Monitor service health and availability

Technology Stack

Language: Node.js
Port: 8083
Dependencies: Express, Swagger UI, Axios

Features

Unified Documentation: Single Swagger UI for all services
Service Health Monitoring: Real-time status of all services
Dynamic Spec Generation: Automatically fetches and merges OpenAPI specs
Service Prefixing: Each service's endpoints are prefixed for clarity
Fallback Handling: Graceful handling of unavailable services

API Endpoints

GET / - Swagger UI interface
GET /openapi.json - Unified OpenAPI specification
GET /services - Service health status
GET /health - Documentation service health

Development Status

✅ Complete - Ready for use with comprehensive testing and clean code implementation

Testing

Unit Tests: Jest test suite with comprehensive coverage
Coverage: Test coverage reporting
CI/CD: Automated testing in Gitea Actions pipeline
Quality: ESLint code quality checks

Clean Code Implementation

Single Purpose: Focused on OpenAPI spec aggregation
Error Handling: Graceful degradation when services are unavailable
Caching: Performance optimization with intelligent caching
Health Monitoring: Real-time service status tracking
Configuration: Environment-based settings management
Documentation: Comprehensive inline documentation