Intent.MetadataSynchronizer.OpenApi.CLI 1.0.0-pre.3

Intent OpenApi Metadata Synchronizer

The Intent OpenApi Metadata Synchronizer CLI tool can be used to synchronize an OpenApi (3.*) file into an Intent Architect Services package.

This tool can be useful for creating Intent Architect Service Packages based on Open API / Swagger definitions.

Pre-requisites

Latest Long Term Support (LTS) version of .NET.

Installation

The tool is available as a .NET Tool and can be installed with the following command:

dotnet tool install Intent.MetadataSynchronizer.OpenApi.CLI --global --prerelease

[!NOTE] If dotnet tool install fails with an error to the effect of The required NuGet feed can't be accessed, perhaps because of an Internet connection problem. and it shows a private NuGet feed URL, you can try add the --ignore-failed-sources command line option (source).

You should see output to the effect of:

You can invoke the tool using the following command: intent-openapi-metadata-synchronizer
Tool 'intent.metadatasynchronizer.openapi.cli' (version 'x.x.x') was successfully installed.

Usage

intent-openapi-metadata-synchronizer [options]

Options

Configuration file

The --config-file option expects the name of a file containing configuration options to be used as an alternative to adding them as CLI options. A template for the configuration file can be generated using the --generate-config-file option. The content of the generated template is as follows:

{
    "OpenApiSpecificationFile": null,
    "IslnFile": null,
    "ApplicationName":  null,
    "PackageId":  null,
    "TargetFolderId":  null,
    "ServiceType": "CQRS",
    "IsAzureFunctions": false,
    "AllowRemoval": true
}