@pixel-brewery/archipel-platform-openapi

Classes

Class	Description
SwaggerFeatureDiscovery	Centralizes the discovery of Swagger features declared across backend modules.
SwaggerFeatureRegistry	Registry service for dynamically discovered Swagger features. Collects feature configurations from @SwaggerFeature decorators.
SwaggerMultiDocumentService	-
SwaggerTheme	The swagger theme class

Interfaces

Interface	Description
ICreateJsonSchemaFromOpenApiModelOptions	Controls conversion of a NestJS Swagger model into self-contained JSON Schema.
IFeatureSwaggerConfig	-
IOpenApiFeatureDocument	One generated feature document together with its registered feature metadata.
ISwaggerFeatureMetadata	Describes a single Swagger feature module that should be exposed as its own OpenAPI document via the multi-document setup.
ISwaggerThemeConfig	Configuration interface for Swagger theme styling. Allows customization of primary and secondary branding colors.

Variables

Variable	Description
APP_VERSION	Application version shown in the Swagger document.
JSON_SCHEMA_FINGERPRINT_ALGORITHM	Stable identifier for the validation-semantic JSON Schema fingerprint.
PLATFORM_OPENAPI_CONFIG_ENTRIES	All configuration entries required by platform-openapi.
SWAGGER_CONTACT_EMAIL	Contact e-mail displayed in the Swagger document.
SWAGGER_CONTACT_NAME	Contact name displayed in the Swagger document.
SWAGGER_CONTACT_URL	Contact URL displayed in the Swagger document.
SWAGGER_FEATURE_METADATA_KEY	Metadata key used by Reflect.defineMetadata to attach ISwaggerFeatureMetadata to a NestJS module class decorated with SwaggerFeature.

Functions

Function	Description
Api	Composite Swagger decorator that wraps all NestJS OpenAPI decorators into a single declaration.
createJsonSchemaFingerprint	Creates a versioned, stable SHA-256 fingerprint for a JSON Schema document.
createJsonSchemaFromOpenApiModel	Creates a self-contained JSON Schema from a NestJS Swagger model.
getRegisteredSwaggerFeatures	Returns all ISwaggerFeatureMetadata entries that have been registered via the SwaggerFeature decorator, sorted alphabetically by name.
getSwaggerFeatureMetadata	Reads the ISwaggerFeatureMetadata previously attached to a module class by the SwaggerFeature decorator.
SwaggerFeature	Class decorator that marks a NestJS module as a Swagger feature.