From 7e60df84ab2d5ee74f13781b68da286966971319 Mon Sep 17 00:00:00 2001 From: Gino Canessa Date: Mon, 27 Jul 2020 16:36:07 -0500 Subject: [PATCH] Updating readme --- README.md | 36 ++++++++++++++++++++++++------------ docfx/api/index.md | 8 ++++++-- docfx/articles/cli.md | 39 ++++++++++++++++++++++++++------------- 3 files changed, 56 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 9a46650b4..ec0e7715e 100644 --- a/README.md +++ b/README.md @@ -10,28 +10,37 @@ Usage: Options: --fhir-spec-directory The full path to the directory where FHIR - specifications are downloaded and cached. + specifications are downloaded and cached. --output-path File or directory to write output. --verbose Show verbose output. - --offline-mode Offline mode. - (will not download missing specs). + --offline-mode Offline mode . + (will not download missing specs) --language Name of the language to export. - (default: Info|TypeScript|CSharpBasic). + (default: Info|TypeScript|CSharpBasic) --export-keys '|' separated list of items to export. - (not present to export everything) + (not present to export everything) --load-r2 If FHIR R2 should be loaded, which version. - (e.g., 1.0.2 or latest) + (e.g., 1.0.2 or latest) --load-r3 If FHIR R3 should be loaded, which version. - (e.g., 3.0.2 or latest) + (e.g., 3.0.2 or latest) --load-r4 If FHIR R4 should be loaded, which version. - (e.g., 4.0.1 or latest) + (e.g., 4.0.1 or latest). --load-r5 If FHIR R5 should be loaded, which version. - (e.g., 4.4.0 or latest) + (e.g., 4.4.0 or latest) --language-options Language specific options, see documentation for more details. (e.g., CSharpBasic|namespace=myorg.fhir) - --version Show version information. - -?, -h, --help Show help and usage information. + --official-expansions-only True to restrict value-sets exported to only + official expansions. + (default: false) + --fhir-server-url FHIR Server URL to pull a CapabilityStatement + (or Conformance) from. Only supports + application/fhir+json. + --include-experimental If the output should include structures + marked experimental. + (default: false) + --version Show version information + -?, -h, --help Show help and usage information ``` ## Examples @@ -62,10 +71,13 @@ Options: Basic TypeScript bindings, useful for prototyping and small projects. Exported classes are able to serialize to and parse from FHIR JSON. - * CSharpFirely **EXPERIMENTAL** + * CSharpFirely Export base C# classes needed for the Firely-maintained C# API ([FHIR-Net-API](https://github.com/FirelyTeam/fhir-net-api/)). + * OpenAPI **EXPERIMENTAL** + + Export an OpenAPI 2 or 3 JSON version of the standard. # Testing diff --git a/docfx/api/index.md b/docfx/api/index.md index 773147580..3de6b6f19 100644 --- a/docfx/api/index.md +++ b/docfx/api/index.md @@ -69,13 +69,17 @@ Classes used to export different languages from a loaded version of FHIR. Basic TypeScript bindings, useful for prototyping and small projects. Exported classes are able to serialize to and parse from FHIR JSON. - * [CSharpFirely](Microsoft.Health.Fhir.SpecManager.Language.CSharpFirely.html) **EXPERIMENTAL** + * [CSharpFirely](Microsoft.Health.Fhir.SpecManager.Language.CSharpFirely.html) Export base C# classes needed for the Firely-maintained C# API ([FHIR-Net-API](https://github.com/FirelyTeam/fhir-net-api/)). + * [OpenAPI](Microsoft.Health.Fhir.SpecManager.Language.LangOpenApi.html) **EXPERIMENTAL** + + Export an OpenAPI version 2 or 3 JSON document for the selected options. + ## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Manager](Microsoft.Health.Fhir.SpecManager.Manager.html) -Classes used to manage FHIR versions. +Classes used to load and manage FHIR versions. Includes functionality to connect to a FHIR server and pull metadata. ## Library Namespace: [Microsoft.Health.Fhir.SpecManager.Models](Microsoft.Health.Fhir.SpecManager.Models.html) diff --git a/docfx/articles/cli.md b/docfx/articles/cli.md index da0bd42a1..c8dc96321 100644 --- a/docfx/articles/cli.md +++ b/docfx/articles/cli.md @@ -6,29 +6,38 @@ Usage: Options: --fhir-spec-directory The full path to the directory where FHIR - specifications are downloaded and cached. + specifications are downloaded and cached. --output-path File or directory to write output. --verbose Show verbose output. - --offline-mode Offline mode. - (will not download missing specs). + --offline-mode Offline mode . + (will not download missing specs) --language Name of the language to export. - (default: Info|TypeScript|CSharpBasic). + (default: Info|TypeScript|CSharpBasic) --export-keys '|' separated list of items to export. - (not present to export everything) + (not present to export everything) --load-r2 If FHIR R2 should be loaded, which version. - (e.g., 1.0.2 or latest) + (e.g., 1.0.2 or latest) --load-r3 If FHIR R3 should be loaded, which version. - (e.g., 3.0.2 or latest) + (e.g., 3.0.2 or latest) --load-r4 If FHIR R4 should be loaded, which version. - (e.g., 4.0.1 or latest) + (e.g., 4.0.1 or latest). --load-r5 If FHIR R5 should be loaded, which version. - (e.g., 4.4.0 or latest) + (e.g., 4.4.0 or latest) --language-options Language specific options, see documentation for more details. (e.g., CSharpBasic|namespace=myorg.fhir) - --version Show version information. - -?, -h, --help Show help and usage information. -``` + --official-expansions-only True to restrict value-sets exported to only + official expansions. + (default: false) + --fhir-server-url FHIR Server URL to pull a CapabilityStatement + (or Conformance) from. Only supports + application/fhir+json. + --include-experimental If the output should include structures + marked experimental. + (default: false) + --version Show version information + -?, -h, --help Show help and usage information + ``` ## Language Information @@ -44,10 +53,14 @@ Options: Basic TypeScript bindings, useful for prototyping and small projects. Exported classes are able to serialize to and parse from FHIR JSON. - * CSharpFirely **EXPERIMENTAL** + * CSharpFirely Export base C# classes needed for the Firely-maintained C# API ([FHIR-Net-API](https://github.com/FirelyTeam/fhir-net-api/)). + * OpenAPI **EXPERIMENTAL** + + Export an OpenAPI 2 or 3 JSON version of the standard. + ## CLI Examples