@oslo-flanders/swagger-generator 1.4.0 → 1.5.0

package/README.md

@@ -38,6 +38,7 @@ The service is executed from the CLI and expects the following parameters:
 | `--excludeClasses` | Classes to exclude from the generated Swagger | No | Persoon Organisatie Test |
 | `--excludeProperties` | Properties to exclude from the generated Swagger | No | voornaam achternaam |
 | `--outputFormat` | Output format for the generated files. Can be specified multiple times to generate multiple formats at once. | No | `application/json` (default) or `application/yaml` |
+| `--disableLinks` | Disable the creation of links | No | `true` or `false` (default) |
 | `--silent` | Suppress log messages | No | `true` or `false` (default) |
 
 ## Usage

package/lib/SwaggerGenerationService.d.ts

@@ -13,7 +13,7 @@ export declare class SwaggerGenerationService implements IService {
     private schemaExists;
     init(): Promise<void>;
     run(): Promise<void>;
-    createSwagger(schemas: any, links: any): Object;
+    createSwagger(schemas: any, links?: any): Object;
     createSchemas(): Object;
     createLinks(): Object;
     writeOutput(outputFormat: OutputFormat, obj: Object, outputPath: string): Promise<void>;

package/lib/SwaggerGenerationService.js

@@ -110,7 +110,9 @@ let SwaggerGenerationService = class SwaggerGenerationService {
         var _a;
         /* Create schemas and links once, then write for each output format */
         const schemas = this.createSchemas();
-        const links = this.createLinks();
+        const links = this.configuration.disableLinks
+            ? {}
+            : this.createLinks();
         /* Create self-standing referenceable components */
         const components = {
             openapi: this.configuration.versionSwagger,
@@ -121,7 +123,10 @@ let SwaggerGenerationService = class SwaggerGenerationService {
                 license: this.getLicense(),
                 version: this.configuration.versionAPI,
             },
-            components: { schemas, links },
+            components: {
+                schemas,
+                ...(Object.keys(links).length > 0 ? { links } : {}),
+            },
         };
         /* Create Swagger endpoint paths as example */
         const swagger = this.createSwagger(schemas, links);
@@ -135,7 +140,7 @@ let SwaggerGenerationService = class SwaggerGenerationService {
             await this.writeOutput(format, swagger, `swagger/example${ext}`);
         }
     }
-    createSwagger(schemas, links) {
+    createSwagger(schemas, links = {}) {
         var _a, _b, _c;
         const swagger = {
             openapi: this.configuration.versionSwagger,
@@ -205,7 +210,9 @@ let SwaggerGenerationService = class SwaggerGenerationService {
                                     },
                                 },
                             },
-                            links: filteredLinks,
+                            ...(Object.keys(filteredLinks).length > 0
+                                ? { links: filteredLinks }
+                                : {}),
                         },
                         /* Error codes follow the RFC 7807 */
                         400: {

package/lib/SwaggerGenerationServiceRunner.js

@@ -41,6 +41,11 @@ class SwaggerGenerationServiceRunner extends core_1.AppRunner {
             describe: 'A list of property names to exclude from the output.',
             type: 'string',
             array: true,
+        })
+            .option('disableLinks', {
+            describe: 'Disable the creation of links.',
+            default: false,
+            boolean: true,
         })
             .option('silent', {
             describe: 'All logs are suppressed',

package/lib/config/SwaggerGenerationServiceConfiguration.d.ts

@@ -69,6 +69,10 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
      * Output formats
      */
     private _outputFormat;
+    /**
+     * Whether to disable the creation of links
+     */
+    private _disableLinks;
     createFromCli(params: YargsParams): Promise<void>;
     get input(): string;
     get output(): string;
@@ -87,4 +91,5 @@ export declare class SwaggerGenerationServiceConfiguration implements IConfigura
     get excludeClasses(): string[];
     get excludeProperties(): string[];
     get outputFormat(): OutputFormat[];
+    get disableLinks(): boolean;
 }

package/lib/config/SwaggerGenerationServiceConfiguration.js

@@ -28,6 +28,7 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
         this._excludeClasses = params.excludeClasses;
         this._excludeProperties = params.excludeProperties;
         this._outputFormat = params.outputFormat;
+        this._disableLinks = params.disableLinks;
     }
     get input() {
         if (!this._input) {
@@ -104,6 +105,9 @@ let SwaggerGenerationServiceConfiguration = class SwaggerGenerationServiceConfig
     get outputFormat() {
         return this._outputFormat || [core_1.OutputFormat.Json];
     }
+    get disableLinks() {
+        return !!this._disableLinks;
+    }
 };
 SwaggerGenerationServiceConfiguration = __decorate([
     (0, inversify_1.injectable)()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oslo-flanders/swagger-generator",
-  "version": "1.4.0",
+  "version": "1.5.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",