This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 65868cfe2db8129859270733397070164a5501f4 Author: Claus Ibsen <[email protected]> AuthorDate: Tue Jul 31 07:50:45 2018 +0200 Component docs for camel-fhir --- .../src/main/docs/fhir-component.adoc | 20 +++++++------------- .../src/main/docs/fhirJson-dataformat.adoc | 5 ++--- .../src/main/docs/fhirXml-dataformat.adoc | 5 ++--- .../apache/camel/component/fhir/FhirEndpoint.java | 4 ++-- components/readme.adoc | 9 +++++---- docs/user-manual/en/SUMMARY.md | 2 +- .../fhir/springboot/FhirComponentConfiguration.java | 2 +- .../camel/maven/packaging/PrepareCatalogMojo.java | 7 ++++++- 8 files changed, 26 insertions(+), 28 deletions(-) diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc index e1f4585..203c2f4 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhir-component.adoc @@ -7,30 +7,27 @@ The FHIR component integrates with the http://hapifhir.io/[HAPI-FHIR] library which is an open-source implementation of the http://hl7.org/implement/standards/fhir/[FHIR] (Fast Healthcare Interoperability Resources) specification in Java. - Maven users will need to add the following dependency to their pom.xml for this component: [source,xml] --------------------------------------------- +---- <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-fhir</artifactId> <version>${camel-version}</version> </dependency> --------------------------------------------- - -### URI Format +---- -''''' +=== URI Format The FHIR Component uses the following URI format: ---------------------------------------------------------- - fhir://endpoint-prefix/endpoint?[options] - ---------------------------------------------------------- +[source,text] +---- +fhir://endpoint-prefix/endpoint?[options] +---- Endpoint prefix can be one of: @@ -47,9 +44,6 @@ Endpoint prefix can be one of: * update * validate -### FhirComponent - -*Available as of Camel version 2.23* // component options: START The FHIR component supports 2 options, which are listed below. diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc index c1a16d5..72e73e0 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirJson-dataformat.adoc @@ -5,12 +5,11 @@ - The FHIR-JSON Data Format leverages link:https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/JsonParser.java[HAPI-FHIR's] JSON parser to parse to/from JSON format to/from a HAPI-FHIR's `IBaseResource`. -### FHIR JSON Format Options +=== FHIR JSON Format Options // dataformat options: START The FHIR JSon dataformat supports 14 options, which are listed below. @@ -119,4 +118,4 @@ The component supports 15 options, which are listed below. | *camel.dataformat.fhirjson.suppress-narratives* | If set to true (default is false), narratives will not be included in the encoded values. | false | Boolean |=== -// spring-boot-auto-configure options: END +// spring-boot-auto-configure options: END \ No newline at end of file diff --git a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc index 94d40ac..fafeb3c 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc +++ b/components/camel-fhir/camel-fhir-component/src/main/docs/fhirXml-dataformat.adoc @@ -4,12 +4,11 @@ *Available as of Camel version 2.21* - The FHIR-XML Data Format leverages link:https://github.com/jamesagnew/hapi-fhir/blob/master/hapi-fhir-base/src/main/java/ca/uhn/fhir/parser/XmlParser.java[HAPI-FHIR's] XML parser to parse to/from XML format to/from a HAPI-FHIR's `IBaseResource`. -### FHIR XML Format Options +=== FHIR XML Format Options // dataformat options: START The FHIR XML dataformat supports 14 options, which are listed below. @@ -118,4 +117,4 @@ The component supports 15 options, which are listed below. | *camel.dataformat.fhirxml.suppress-narratives* | If set to true (default is false), narratives will not be included in the encoded values. | false | Boolean |=== -// spring-boot-auto-configure options: END +// spring-boot-auto-configure options: END \ No newline at end of file diff --git a/components/camel-fhir/camel-fhir-component/src/main/java/org/apache/camel/component/fhir/FhirEndpoint.java b/components/camel-fhir/camel-fhir-component/src/main/java/org/apache/camel/component/fhir/FhirEndpoint.java index 7093185..01a438f 100644 --- a/components/camel-fhir/camel-fhir-component/src/main/java/org/apache/camel/component/fhir/FhirEndpoint.java +++ b/components/camel-fhir/camel-fhir-component/src/main/java/org/apache/camel/component/fhir/FhirEndpoint.java @@ -46,10 +46,10 @@ import org.apache.camel.util.component.ApiMethod; import org.apache.camel.util.component.ApiMethodPropertiesHelper; /** - * Represents a FHIR endpoint. + * The fhir component is used for working with the FHIR protocol (health care). */ @UriEndpoint(firstVersion = "2.23.0", scheme = "fhir", title = "FHIR", syntax = "fhir:apiName/methodName", - consumerClass = FhirConsumer.class, label = "api") + consumerClass = FhirConsumer.class, label = "hl7,api") public class FhirEndpoint extends AbstractApiEndpoint<FhirApiName, FhirConfiguration> { private static final String EXTRA_PARAMETERS_PROPERTY = "extraParameters"; diff --git a/components/readme.adoc b/components/readme.adoc index 11594bb..347d1d9 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -2,7 +2,7 @@ Components ^^^^^^^^^^ // components: START -Number of Components: 300 in 203 JAR artifacts (21 deprecated) +Number of Components: 301 in 204 JAR artifacts (21 deprecated) [width="100%",cols="4,1,5",options="header"] |=== @@ -260,6 +260,9 @@ Number of Components: 300 in 203 JAR artifacts (21 deprecated) | link:camel-facebook/src/main/docs/facebook-component.adoc[Facebook] (camel-facebook) + `facebook:methodName` | 2.14 | The Facebook component provides access to all of the Facebook APIs accessible using Facebook4J. +| link:camel-fhir/src/main/docs/fhir-component.adoc[FHIR] (camel-fhir) + +`fhir:apiName/methodName` | 2.23 | The fhir component is used for working with the FHIR protocol (health care). + | link:../camel-core/src/main/docs/file-component.adoc[File] (camel-core) + `file:directoryName` | 1.0 | The file component is used for reading or writing files. @@ -1086,7 +1089,7 @@ Miscellaneous Components ^^^^^^^^^^^^^^^^^^^^^^^^ // others: START -Number of Miscellaneous Components: 45 in 45 JAR artifacts (13 deprecated) +Number of Miscellaneous Components: 44 in 44 JAR artifacts (13 deprecated) [width="100%",cols="4,1,5",options="header"] |=== @@ -1102,8 +1105,6 @@ Number of Miscellaneous Components: 45 in 45 JAR artifacts (13 deprecated) | link:camel-eclipse/src/main/docs/eclipse.adoc[Eclipse] (camel-eclipse) | 2.3 | *deprecated* Camel classpath scanning support for running in Eclipse Desktop Applications -| link:camel-fhir-parent/src/main/docs/fhir-parent.adoc[Fhir Parent] (camel-fhir-parent) | | Camel FHIR parent - | link:camel-groovy-dsl/src/main/docs/groovy-dsl.adoc[Groovy DSL] (camel-groovy-dsl) | 2.19 | *deprecated* Camel Groovy DSL support | link:camel-guice/src/main/docs/guice.adoc[Guice] (camel-guice) | 1.5 | *deprecated* Using Camel with Guice diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 8fa7c51..384fed3 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -198,6 +198,7 @@ * [etcd](etcd-component.adoc) * [Exec](exec-component.adoc) * [Facebook](facebook-component.adoc) + * [FHIR](fhir-component.adoc) * [Flatpack](flatpack-component.adoc) * [FOP](fop-component.adoc) * [Freemarker](freemarker-component.adoc) @@ -409,7 +410,6 @@ * [CDI](cdi.adoc) * [CXF Transport](cxf-transport.adoc) * [Eclipse](eclipse.adoc) - * [Fhir Parent](fhir-parent.adoc) * [Groovy DSL](groovy-dsl.adoc) * [Guice](guice.adoc) * [HawtDB](hawtdb.adoc) diff --git a/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java b/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java index df25ab2..349520f 100644 --- a/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-fhir-starter/src/main/java/org/apache/camel/component/fhir/springboot/FhirComponentConfiguration.java @@ -25,7 +25,7 @@ import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Represents a FHIR endpoint. + * The fhir component is used for working with the FHIR protocol (health care). * * Generated by camel-package-maven-plugin - do not edit this file! */ diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java index 357a5b1..802cdf4 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java @@ -357,6 +357,8 @@ public class PrepareCatalogMojo extends AbstractMojo { target = new File(dir, "camel-box-component/target/classes"); } else if ("camel-servicenow".equals(dir.getName())) { target = new File(dir, "camel-servicenow-component/target/classes"); + } else if ("camel-fhir".equals(dir.getName())) { + target = new File(dir, "camel-fhir-component/target/classes"); } int before = componentFiles.size(); @@ -801,7 +803,8 @@ public class PrepareCatalogMojo extends AbstractMojo { || "camel-olingo2".equals(dir.getName()) || "camel-olingo4".equals(dir.getName()) || "camel-servicenow".equals(dir.getName()) - || "camel-salesforce".equals(dir.getName()); + || "camel-salesforce".equals(dir.getName()) + || "camel-fhir".equals(dir.getName()); if (special || special2) { continue; } @@ -981,6 +984,8 @@ public class PrepareCatalogMojo extends AbstractMojo { target = new File(dir, "camel-box-component/src/main/docs"); } else if ("camel-servicenow".equals(dir.getName())) { target = new File(dir, "camel-servicenow-component/src/main/docs"); + } else if ("camel-fhir".equals(dir.getName())) { + target = new File(dir, "camel-fhir-component/target/classes"); } int before = adocFiles.size();
