publish-json

Introduction

Generate a json schema file that defines all Item types, Composite types, and Primitive types in the model as well as defines connections between items.

Requires that dotnet is installed.

Command Line Arguments

Required inputs for the publish-json command (must be specified in order).

• [CogsLocation]

  The location of the folder containing the model.

• [TargetLocation]

  The location of the folder where the output will be created.

Command Line Flags

Optional inputs for the publish-json command.

• -?|-h|--help

  Displays all possible command arguments and flags for the publish-json command.

• -o|--overwrite

  If the [TargetLocation] is not empty, erase all files in the folder before generation.

• -a|--allowAdditionalProperties

  Allows properties not defined in the schema to be added to items.

Command Line Usage

Format

$ publish-json (-h) (-o) (-a) [CogsLocation] [TargetLocation]

Examples

A few examples of how the command line arguments and flags can be used together.

$ publish-json -h
$ publish-json MyCogsModelDirectory MyOutputDirectory
$ publish-json -o -a MyCogsModelDirectory MyOutputDirectory