@breadstone/archipel-mcp 0.0.30 → 0.0.32

package/data/packages/platform-openapi/api/Function.SwaggerFeature.md

@@ -9,19 +9,30 @@ editUrl: false
 function SwaggerFeature(metadata): (target) => (...args) => object;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L92)
+Defined in: [decorators/SwaggerFeature.ts:176](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L176)
 
-Decorator to register a module as a Swagger feature.
-This allows the SwaggerMultiDocumentService to automatically discover and create documentation.
+Class decorator that marks a NestJS module as a Swagger feature.
+
+When applied, the decorator:
+1. Attaches the resolved [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) to the class via
+   `Reflect.defineMetadata` (retrievable with [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata)).
+2. Registers the metadata in a process-global store so that
+   [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) can discover all features at bootstrap
+   without requiring an explicit import of every module.
+
+If [path](Interface.ISwaggerFeatureMetadata#path) is not provided, it defaults
+to `docs/{name}`.
 
 ## Parameters
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
+| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | Configuration describing the feature's OpenAPI document. |
 
 ## Returns
 
+A class decorator function.
+
 (`target`) => (...`args`) => `object`
 
 ## Example
@@ -31,12 +42,13 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
   name: 'tip',
   title: 'My App API - Tips',
   description: 'API endpoints for tip management',
-  tag: 'Tip'
+  tag: 'Tip',
+  tags: ['Tip'],
 })
 @Module({
   controllers: [TipController],
   providers: [TipService],
-  exports: [TipService]
+  exports: [TipService],
 })
 export class TipModule {}
 ```

package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md

@@ -9,10 +9,17 @@ editUrl: false
 function getRegisteredSwaggerFeatures(): ISwaggerFeatureMetadata[];
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L120)
+Defined in: [decorators/SwaggerFeature.ts:217](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L217)
 
-Retrieves all Swagger features that have been registered through the decorator.
+Returns all [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) entries that have been registered
+via the [SwaggerFeature](Function.SwaggerFeature) decorator, sorted alphabetically by
+[name](Interface.ISwaggerFeatureMetadata#name).
+
+Typically called once during application bootstrap to build the multi-document
+Swagger setup.
 
 ## Returns
 
 [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)[]
+
+A sorted array of feature metadata. Empty if no features were registered.

package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md

@@ -11,17 +11,20 @@ function getSwaggerFeatureMetadata(target):
   | undefined;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:111](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L111)
+Defined in: [decorators/SwaggerFeature.ts:199](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L199)
 
-Get the Swagger feature metadata from a module class
+Reads the [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) previously attached to a module class
+by the [SwaggerFeature](Function.SwaggerFeature) decorator.
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `target` | (...`args`) => `object` |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `target` | (...`args`) => `object` | The module class to inspect. |
 
 ## Returns
 
   \| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
   \| `undefined`
+
+The feature metadata, or `undefined` if the class was not decorated.

package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md

@@ -5,7 +5,10 @@ editUrl: false
 ---
 # Interface: ISwaggerFeatureMetadata
 
-Defined in: [decorators/SwaggerFeature.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L16)
+Defined in: [decorators/SwaggerFeature.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L35)
+
+Describes a single Swagger feature module that should be exposed as its own
+OpenAPI document via the multi-document setup.
 
 ## Properties
 
@@ -15,7 +18,9 @@ Defined in: [decorators/SwaggerFeature.ts:16](https://github.com/RueDeRennes/arc
 readonly description: string;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L19)
+Defined in: [decorators/SwaggerFeature.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L49)
+
+Short description shown below the title in Swagger UI.
 
 ***
 
@@ -25,7 +30,10 @@ Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/arc
 readonly name: string;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L17)
+Defined in: [decorators/SwaggerFeature.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L40)
+
+Unique machine-readable identifier for this feature (e.g. `'tip'`, `'user'`).
+Used to deduplicate registrations and to derive the default [path](#path).
 
 ***
 
@@ -35,7 +43,16 @@ Defined in: [decorators/SwaggerFeature.ts:17](https://github.com/RueDeRennes/arc
 readonly optional path?: string;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L22)
+Defined in: [decorators/SwaggerFeature.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L69)
+
+URL path segment where the Swagger UI for this feature is served.
+Defaults to `docs/{name}` when omitted.
+
+#### Example
+
+```ts
+`'docs/tips'`
+```
 
 ***
 
@@ -45,7 +62,10 @@ Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/arc
 readonly tag: string;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L20)
+Defined in: [decorators/SwaggerFeature.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L55)
+
+Primary OpenAPI tag applied to every controller that belongs to this feature.
+Controllers are grouped under this tag in the generated document.
 
 ***
 
@@ -55,7 +75,10 @@ Defined in: [decorators/SwaggerFeature.ts:20](https://github.com/RueDeRennes/arc
 readonly tags: string[];
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L21)
+Defined in: [decorators/SwaggerFeature.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L61)
+
+Additional OpenAPI tags to include in the generated document.
+Useful when a feature module spans multiple controller groups.
 
 ***
 
@@ -65,4 +88,7 @@ Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/arc
 readonly title: string;
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)
+Defined in: [decorators/SwaggerFeature.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L46)
+
+Human-readable title displayed in the Swagger UI header
+(e.g. `'My App API - Tips'`).

package/data/packages/platform-openapi/api/Interface.ISwaggerThemeConfig.md

@@ -0,0 +1,59 @@
+---
+title: 'Interface: ISwaggerThemeConfig'
+generated: true
+editUrl: false
+---
+# Interface: ISwaggerThemeConfig
+
+Defined in: [ISwaggerThemeConfig.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/ISwaggerThemeConfig.ts#L11)
+
+Configuration interface for Swagger theme styling.
+Allows customization of primary and secondary branding colors.
+
+## Properties
+
+### faviconUrl?
+
+```ts
+readonly optional faviconUrl?: string;
+```
+
+Defined in: [ISwaggerThemeConfig.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/ISwaggerThemeConfig.ts#L30)
+
+Optional custom favicon URL
+
+***
+
+### logoUrl?
+
+```ts
+readonly optional logoUrl?: string;
+```
+
+Defined in: [ISwaggerThemeConfig.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/ISwaggerThemeConfig.ts#L25)
+
+Optional custom logo URL
+
+***
+
+### primary
+
+```ts
+readonly primary: string;
+```
+
+Defined in: [ISwaggerThemeConfig.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/ISwaggerThemeConfig.ts#L15)
+
+Primary branding color (hex format, e.g., '#e6492a')
+
+***
+
+### secondary
+
+```ts
+readonly secondary: string;
+```
+
+Defined in: [ISwaggerThemeConfig.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/ISwaggerThemeConfig.ts#L20)
+
+Secondary branding color (hex format, e.g., '#c7206a')

package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md

@@ -9,4 +9,7 @@ editUrl: false
 const SWAGGER_FEATURE_METADATA_KEY: "swagger:feature" = 'swagger:feature';
 ```
 
-Defined in: [decorators/SwaggerFeature.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L7)
+Defined in: [decorators/SwaggerFeature.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L13)
+
+Metadata key used by `Reflect.defineMetadata` to attach [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata)
+to a NestJS module class decorated with [SwaggerFeature](Function.SwaggerFeature).

package/data/packages/platform-openapi/api/index.md

@@ -19,7 +19,8 @@ editUrl: false
 | Interface | Description |
 | ------ | ------ |
 | [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig) | - |
-| [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | - |
+| [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | Describes a single Swagger feature module that should be exposed as its own OpenAPI document via the multi-document setup. |
+| [ISwaggerThemeConfig](Interface.ISwaggerThemeConfig) | Configuration interface for Swagger theme styling. Allows customization of primary and secondary branding colors. |
 
 ## Variables
 
@@ -30,13 +31,13 @@ editUrl: false
 | [SWAGGER\_CONTACT\_EMAIL](Variable.SWAGGER_CONTACT_EMAIL) | Contact e-mail displayed in the Swagger document. |
 | [SWAGGER\_CONTACT\_NAME](Variable.SWAGGER_CONTACT_NAME) | Contact name displayed in the Swagger document. |
 | [SWAGGER\_CONTACT\_URL](Variable.SWAGGER_CONTACT_URL) | Contact URL displayed in the Swagger document. |
-| [SWAGGER\_FEATURE\_METADATA\_KEY](Variable.SWAGGER_FEATURE_METADATA_KEY) | - |
+| [SWAGGER\_FEATURE\_METADATA\_KEY](Variable.SWAGGER_FEATURE_METADATA_KEY) | Metadata key used by `Reflect.defineMetadata` to attach [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) to a NestJS module class decorated with [SwaggerFeature](Function.SwaggerFeature). |
 
 ## Functions
 
 | Function | Description |
 | ------ | ------ |
 | [Api](Function.Api) | Composite Swagger decorator that wraps all NestJS OpenAPI decorators into a single declaration. |
-| [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator. |
-| [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Get the Swagger feature metadata from a module class |
-| [SwaggerFeature](Function.SwaggerFeature) | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |
+| [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Returns all [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) entries that have been registered via the [SwaggerFeature](Function.SwaggerFeature) decorator, sorted alphabetically by [name](Interface.ISwaggerFeatureMetadata#name). |
+| [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Reads the [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) previously attached to a module class by the [SwaggerFeature](Function.SwaggerFeature) decorator. |
+| [SwaggerFeature](Function.SwaggerFeature) | Class decorator that marks a NestJS module as a Swagger feature. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-mcp",
-  "version": "0.0.30",
+  "version": "0.0.32",
   "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
   "type": "commonjs",
   "main": "./src/main.js",