You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2022/06/29 11:34:37 UTC
[camel] branch main updated: [DOCS] Update Bean and FHIR components. (#7920)
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new af5d7b1ce19 [DOCS] Update Bean and FHIR components. (#7920)
af5d7b1ce19 is described below
commit af5d7b1ce19438f885cf366b0d1b794b3737bc4c
Author: mmajerni <mm...@redhat.com>
AuthorDate: Wed Jun 29 13:34:31 2022 +0200
[DOCS] Update Bean and FHIR components. (#7920)
---
.../camel-bean/src/main/docs/bean-component.adoc | 2 +-
.../org/apache/camel/component/fhir/fhir.json | 22 +++++++++++-----------
.../ROOT/partials/component-endpoint-options.adoc | 2 +-
3 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/components/camel-bean/src/main/docs/bean-component.adoc b/components/camel-bean/src/main/docs/bean-component.adoc
index 95ee54e0da7..3eeb3ffd195 100644
--- a/components/camel-bean/src/main/docs/bean-component.adoc
+++ b/components/camel-bean/src/main/docs/bean-component.adoc
@@ -22,7 +22,7 @@ The Bean component binds beans to Camel message exchanges.
bean:beanName[?options]
----
-Where *beanID* can be any string which is used to look up the bean in
+Where *beanName* can be any string which is used to look up the bean in
the Registry
// component-configure options: START
diff --git a/components/camel-fhir/camel-fhir-component/src/generated/resources/org/apache/camel/component/fhir/fhir.json b/components/camel-fhir/camel-fhir-component/src/generated/resources/org/apache/camel/component/fhir/fhir.json
index 76fef0d01a8..ad1da6731a0 100644
--- a/components/camel-fhir/camel-fhir-component/src/generated/resources/org/apache/camel/component/fhir/fhir.json
+++ b/components/camel-fhir/camel-fhir-component/src/generated/resources/org/apache/camel/component/fhir/fhir.json
@@ -96,7 +96,7 @@
"timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
"useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." },
"accessToken": { "kind": "parameter", "displayName": "Access Token", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "OAuth access token" },
- "password": { "kind": "parameter", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" },
+ "password": { "kind": "parameter", "displayName": "Password", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Password to use for basic authentication" },
"username": { "kind": "parameter", "displayName": "Username", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.fhir.FhirConfiguration", "configurationField": "configuration", "description": "Username to use for basic authentication" }
},
"apis": {
@@ -115,17 +115,17 @@
"validate": { "consumerOnly": false, "producerOnly": false, "description": "API for validating resources", "methods": { "resource": { "description": "", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.Extr [...]
},
"apiProperties": {
- "capabilities": { "methods": { "ofType": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "type [...]
- "create": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "preferRe [...]
- "delete": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "resource [...]
- "history": { "methods": { "onInstance": { "properties": { "count": { "kind": "parameter", "displayName": "Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only up to theCount number of resources, may be NULL", "optional": true }, "cutoff": { "kind": "parameter", "displayName": "Cutoff", "group": "common", "label": "", " [...]
- "load-page": { "methods": { "byUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "returnTy [...]
- "meta": { "methods": { "add": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { "kind": [...]
- "operation": { "methods": { "onInstance": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id" [...]
- "patch": { "methods": { "patchById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { " [...]
+ "capabilities": { "methods": { "ofType": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/c [...]
+ "create": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel [...]
+ "delete": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel [...]
+ "history": { "methods": { "onInstance": { "properties": { "count": { "kind": "parameter", "displayName": "Count", "group": "common", "label": "", "required": false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired": false, "secret": false, "description": "Request that the server return only up to theCount number of resources, may be NULL", "optional": true }, "cutoff": { "kind": "parameter", "displayName": "Cutoff", "group": "common", "label": "", " [...]
+ "load-page": { "methods": { "byUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel [...]
+ "meta": { "methods": { "add": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/compon [...]
+ "operation": { "methods": { "onInstance": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/ [...]
+ "patch": { "methods": { "patchById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel [...]
"read": { "methods": { "resourceById": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "requi [...]
- "search": { "methods": { "searchByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "url": [...]
- "transaction": { "methods": { "withBundle": { "properties": { "bundle": { "kind": "parameter", "displayName": "Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "Bundle to use in the transaction", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", " [...]
+ "search": { "methods": { "searchByUrl": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "See https://github.com/apache/camel/blob/main/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/ca [...]
+ "transaction": { "methods": { "withBundle": { "properties": { "bundle": { "kind": "parameter", "displayName": "Bundle", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.hl7.fhir.instance.model.api.IBaseBundle", "deprecated": false, "autowired": false, "secret": false, "description": "Bundle to use in the transaction", "optional": false }, "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", " [...]
"update": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "id": { "kind": "parameter", "displayName": "Id", "group": "common", "label": "", "require [...]
"validate": { "methods": { "resource": { "properties": { "extraParameters": { "kind": "parameter", "displayName": "Extra Parameters", "group": "common", "label": "", "required": false, "type": "object", "javaType": "java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, java.lang.Object>", "deprecated": false, "autowired": false, "secret": false, "description": "", "optional": true }, "resource": { "kind": "parameter", "displayName": "Resource", "group": "common", "label" [...]
}
diff --git a/docs/components/modules/ROOT/partials/component-endpoint-options.adoc b/docs/components/modules/ROOT/partials/component-endpoint-options.adoc
index 6d2081f7f99..c69eb1eec4b 100644
--- a/docs/components/modules/ROOT/partials/component-endpoint-options.adoc
+++ b/docs/components/modules/ROOT/partials/component-endpoint-options.adoc
@@ -70,7 +70,7 @@ ifeval::[{apicount} != 0]
== API Parameters ({apicount} APIs)
-The @{doctitle} endpoint is an API based component and has additional parameters based on which API name and API method is used.
+The {doctitle} endpoint is an API based component and has additional parameters based on which API name and API method is used.
The API name and API method is located in the endpoint URI as the `{apiSyntax}` path parameters:
[subs='+attributes']