Intent.MetadataSynchronizer.OpenApi.CLI
1.0.0-pre.0
See the version list below for details.
dotnet tool install --global Intent.MetadataSynchronizer.OpenApi.CLI --version 1.0.0-pre.0
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local Intent.MetadataSynchronizer.OpenApi.CLI --version 1.0.0-pre.0
#tool dotnet:?package=Intent.MetadataSynchronizer.OpenApi.CLI&version=1.0.0-pre.0&prerelease
nuke :add-package Intent.MetadataSynchronizer.OpenApi.CLI --version 1.0.0-pre.0
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 ofThe 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
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.
Version | Downloads | Last updated |
---|---|---|
1.0.0-pre.6 | 54 | 6/17/2024 |
1.0.0-pre.5 | 70 | 4/15/2024 |
1.0.0-pre.4 | 62 | 3/28/2024 |
1.0.0-pre.3 | 88 | 9/11/2023 |
1.0.0-pre.2 | 77 | 8/17/2023 |
1.0.0-pre.1 | 81 | 8/13/2023 |
1.0.0-pre.0 | 91 | 8/10/2023 |