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

Option	Description
--config-file <config-file>	Path to a JSON formatted file containing options to use for execution of this tool as an alternative to using command line options. The --generate-config-file option can be used to generate a file with all the possible fields populated with null.
--generate-config-file	Scaffolds into the current working directory a "config.json" for use with the --config-file option.
--open-api-specification-file <source-open-api-file>	The name of the OpenApi (3.*) file to parse and synchronize into the Intent Architect Package. This can be a Json or Xaml file.
--isln-file <isln-file>	The Intent Architect solution (.isln) file containing the Intent Architect Application into which to synchronize the metadata.
--application-name <application-name>	The name of the Intent Architect Application (as per the Application Settings view) containing the Intent Architect Package into which to synchronize the metadata.
--package-id <package-id>	The id of the Intent Architect Package containing the Intent Architect Package into which to synchronize the metadata.
--target-folder-id <target-folder-id>	The target folder within the Intent Architect package into which to synchronize the metadata. If unspecified then the metadata will be synchronized into the root of the Intent Architect package.
--service-type <service-type>	What paradigm of Service Model woudl you like. Options are CQRS or Service.
--is-azure-functions <bool>	Are these services exposed as AzureFunctions?
--allow-removal <bool>	Remove previously imported data which is no longer being imported?
--version	Show version information
-?, -h, --help	Show help and usage information

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
}