Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@GinoCanessa
GinoCanessa committed Jul 27, 2020
1 parent e206a6f commit 7e60df8
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 27 deletions.
36 changes: 24 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,37 @@ Usage:
Options:
--fhir-spec-directory <fhir-spec-directory> The full path to the directory where FHIR
specifications are downloaded and cached.
specifications are downloaded and cached.
--output-path <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 <language> Name of the language to export.
(default: Info|TypeScript|CSharpBasic).
(default: Info|TypeScript|CSharpBasic)
--export-keys <export-keys> '|' separated list of items to export.
(not present to export everything)
(not present to export everything)
--load-r2 <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 <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 <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 <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-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> 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
Expand Down Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions docfx/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
39 changes: 26 additions & 13 deletions docfx/articles/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,38 @@ Usage:
Options:
--fhir-spec-directory <fhir-spec-directory> The full path to the directory where FHIR
specifications are downloaded and cached.
specifications are downloaded and cached.
--output-path <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 <language> Name of the language to export.
(default: Info|TypeScript|CSharpBasic).
(default: Info|TypeScript|CSharpBasic)
--export-keys <export-keys> '|' separated list of items to export.
(not present to export everything)
(not present to export everything)
--load-r2 <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 <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 <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 <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-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> 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

Expand All @@ -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

Expand Down

0 comments on commit 7e60df8

Please sign in to comment.