@navios/openapi 0.7.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.9.0] - 2025-12-23
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
|
|
12
|
+
- Updated to support `@navios/core` ^0.9.0
|
|
13
|
+
- Updated to support `@navios/di` ^0.9.0
|
|
14
|
+
|
|
15
|
+
## [0.8.0] - 2025-12-21
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- **Test Import Paths**: Updated `TestContainer` import from `@navios/di` to `@navios/di/testing`
|
|
20
|
+
|
|
21
|
+
### Dependencies
|
|
22
|
+
|
|
23
|
+
- Compatible with `@navios/core` ^0.8.0
|
|
24
|
+
|
|
25
|
+
## [0.7.0] - 2025-12-18
|
|
26
|
+
|
|
27
|
+
### Added
|
|
28
|
+
|
|
29
|
+
- **Core OpenAPI Package**: Initial release of the core OpenAPI package for Navios
|
|
30
|
+
- **OpenAPI 3.1 Support**: Full support for OpenAPI 3.1 specification generation
|
|
31
|
+
- **Automatic Endpoint Discovery**: Automatic discovery of endpoints from Navios controllers
|
|
32
|
+
- **Zod Schema Conversion**: Automatic conversion of Zod schemas to OpenAPI schemas
|
|
33
|
+
- **Decorator System**: Comprehensive decorator system for API documentation:
|
|
34
|
+
- `@ApiTag` - Group endpoints under tags in the documentation
|
|
35
|
+
- `@ApiOperation` - Full operation metadata (summary, description, operationId, deprecated)
|
|
36
|
+
- `@ApiSummary` - Quick summary shorthand decorator
|
|
37
|
+
- `@ApiDeprecated` - Mark endpoints as deprecated with optional reason
|
|
38
|
+
- `@ApiSecurity` - Specify security requirements for endpoints
|
|
39
|
+
- `@ApiExclude` - Exclude endpoints from documentation
|
|
40
|
+
- `@ApiStream` - Specify content type and metadata for stream endpoints
|
|
41
|
+
- **Service Architecture**: Core services for OpenAPI generation:
|
|
42
|
+
- `OpenApiGeneratorService` - Main service for generating OpenAPI specifications
|
|
43
|
+
- `EndpointScannerService` - Discovers endpoints from controllers
|
|
44
|
+
- `MetadataExtractorService` - Extracts decorator metadata from endpoints
|
|
45
|
+
- `SchemaConverterService` - Converts Zod schemas to OpenAPI schemas
|
|
46
|
+
- `PathBuilderService` - Builds OpenAPI path items from endpoint definitions
|
|
47
|
+
- **Schema Metadata Support**: Support for rich schema metadata via Zod `.meta()` method
|
|
48
|
+
- **Endpoint Type Support**: Support for all endpoint types:
|
|
49
|
+
- Standard HTTP endpoints
|
|
50
|
+
- Multipart/form-data endpoints
|
|
51
|
+
- Stream endpoints
|
|
52
|
+
- **Type Safety**: Full TypeScript support with comprehensive type definitions
|
|
53
|
+
- **Provider Package Architecture**: Designed to work with provider packages for runtime-specific UI integration
|
|
54
|
+
|