@oslo-flanders/swagger-generator 3.0.1 → 3.1.0

package/lib/SwaggerGenerationService.js

@@ -129,7 +129,9 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             },
         };
         /* Create embedded (self-contained) variant with all $ref resolved inline */
-        const embeddedComponents = this.resolveRefs(components, schemas);
+        const embeddedComponents = this.configuration.generateEmbedded
+            ? this.resolveRefs(components, schemas)
+            : undefined;
         /* Create Swagger endpoint paths as example */
         const swagger = this.createSwagger(schemas, links);
         /* Only append the language suffix when the generated language differs from the primary language */
@@ -143,7 +145,9 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             for (const label of Object.keys(links))
                 await this.writeOutput(format, links[label], `swagger/components/links/${label}${languageSuffix}${ext}`);
             await this.writeOutput(format, components, `swagger/components${languageSuffix}${ext}`);
-            await this.writeOutput(format, embeddedComponents, `swagger/_embedded${languageSuffix}${ext}`);
+            if (embeddedComponents) {
+                await this.writeOutput(format, embeddedComponents, `swagger/_embedded${languageSuffix}${ext}`);
+            }
             await this.writeOutput(format, swagger, `swagger/example${languageSuffix}${ext}`);
         }
     }

package/lib/SwaggerGenerationServiceRunner.js

@@ -50,6 +50,11 @@ class SwaggerGenerationServiceRunner extends core_1.AppRunner {
             describe: 'Disable the creation of links.',
             default: false,
             boolean: true,
+        })
+            .option('generateEmbedded', {
+            describe: 'Generate the embedded (self-contained) variant with all $ref resolved inline.',
+            default: false,
+            boolean: true,
         })
             .option('expanded', {
             describe: 'Use JSON-LD expanded format instead of default compact format.',

package/lib/config/SwaggerGenerationServiceConfiguration.d.ts

@@ -78,6 +78,10 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
      * Whether to disable the creation of links
      */
     private _disableLinks;
+    /**
+     * Whether to generate the embedded (self-contained) variant with all $ref resolved inline
+     */
+    private _generateEmbedded;
     /**
      * Whether to use expanded JSON-LD format or not
      */
@@ -110,6 +114,7 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
     get excludeProperties(): string[];
     get outputFormat(): OutputFormat[];
     get disableLinks(): boolean;
+    get generateEmbedded(): boolean;
     get expanded(): boolean;
     get excludeClassesExpanded(): string[];
     get excludePropertiesExpanded(): string[];

package/lib/config/SwaggerGenerationServiceConfiguration.js

@@ -30,6 +30,7 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
         this._excludeProperties = params.excludeProperties;
         this._outputFormat = params.outputFormat;
         this._disableLinks = params.disableLinks;
+        this._generateEmbedded = params.generateEmbedded;
         this._expanded = params.expanded;
         this._excludeClassesExpanded = params.excludeClassesExpanded;
         this._excludePropertiesExpanded = (params.excludePropertiesExpanded);
@@ -116,6 +117,9 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
     get disableLinks() {
         return !!this._disableLinks;
     }
+    get generateEmbedded() {
+        return !!this._generateEmbedded;
+    }
     get expanded() {
         return !!this._expanded;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/swagger-generator",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Generate OpenAPI Swagger YAML documentation.",
   "author": "Digitaal Vlaanderen <https://data.vlaanderen.be/id/organisatie/OVO002949>",
   "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-generator-swagger#readme",