This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch camel-3.18.x in repository https://gitbox.apache.org/repos/asf/camel.git
commit b1b95f715fb742ece8e84823756c14ee486c5e88 Author: Claus Ibsen <[email protected]> AuthorDate: Wed Sep 7 09:43:49 2022 +0200 CAMEL-18240: [DOCS] FHIR component - documentation issues --- .../org/apache/camel/catalog/components/fhir.json | 16 +-- .../camel/component/fhir/api/FhirDelete.java | 2 +- .../apache/camel/component/fhir/api/FhirRead.java | 113 +++++++++++++++++++++ .../camel/component/fhir/api/FhirUpdate.java | 48 +++++++++ .../camel/component/fhir/api/FhirValidate.java | 12 +++ .../fhir/FhirDeleteEndpointConfiguration.java | 2 +- .../fhir/FhirReadEndpointConfiguration.java | 28 ++--- .../fhir/FhirUpdateEndpointConfiguration.java | 16 +-- .../fhir/FhirValidateEndpointConfiguration.java | 8 +- .../org/apache/camel/component/fhir/fhir.json | 14 +-- 10 files changed, 216 insertions(+), 43 deletions(-) diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/fhir.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/fhir.json index 5f8efb058a5..db0d5079749 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/fhir.json +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/fhir.json @@ -102,17 +102,17 @@ "apis": { "capabilities": { "consumerOnly": false, "producerOnly": false, "description": "API to Fetch the capability statement for the server", "methods": { "ofType": { "description": "Retrieve the conformance statement using the given model type", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } }, "create": { "consumerOnly": false, "producerOnly": false, "description": "API for the create operation, which creates a new resource instance on the server", "methods": { "resource": { "description": "Creates a IBaseResource on the server", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca [...] - "delete": { "consumerOnly": false, "producerOnly": false, "description": "API for the delete operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Deletes the given resource", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] }, "resourceById": { "desc [...] + "delete": { "consumerOnly": false, "producerOnly": false, "description": "API for the delete operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Deletes the given resource", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] }, "resourceById": { "desc [...] "history": { "consumerOnly": false, "producerOnly": false, "description": "API for the history method", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.mo [...] "load-page": { "consumerOnly": false, "producerOnly": false, "description": "API that Loads the previous\/next bundle of resources from a paged set, using the link specified in the link type=next tag within the atom bundle", "methods": { "byUrl": { "description": "Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> r [...] "meta": { "consumerOnly": false, "producerOnly": false, "description": "API for the meta operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server", "methods": { "add": { "description": "Add the elements in the given metadata to the already existing set (do not remove any)", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api. [...] - "operation": { "consumerOnly": false, "producerOnly": false, "description": "API for extended FHIR operations https:\/\/www", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance. [...] + "operation": { "consumerOnly": false, "producerOnly": false, "description": "API for extended FHIR operations", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBas [...] "patch": { "consumerOnly": false, "producerOnly": false, "description": "API for the patch operation, which performs a logical patch on a server resource", "methods": { "patchById": { "description": "Applies the patch to the given resource ID", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", [...] - "read": { "consumerOnly": false, "producerOnly": false, "description": "API method for read operations", "methods": { "resourceById": { "description": "", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.Extr [...] + "read": { "consumerOnly": false, "producerOnly": false, "description": "API method for read operations", "methods": { "resourceById": { "description": "Reads a IBaseResource on the server by id", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map [...] "search": { "consumerOnly": false, "producerOnly": false, "description": "API to search for resources matching a given set of criteria", "methods": { "searchByUrl": { "description": "Perform a search directly by URL", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } }, "transaction": { "consumerOnly": false, "producerOnly": false, "description": "API for sending a transaction (collection of resources) to the server to be executed as a single unit", "methods": { "withBundle": { "description": "Use the given raw text (should be a Bundle resource) as the transaction input", "signatures": [ "String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "org.hl7.fhir.instance.model.a [...] - "update": { "consumerOnly": false, "producerOnly": false, "description": "API for the update operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcom [...] - "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 [...] + "update": { "consumerOnly": false, "producerOnly": false, "description": "API for the update operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Updates a IBaseResource on the server by id", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParam [...] + "validate": { "consumerOnly": false, "producerOnly": false, "description": "API for validating resources", "methods": { "resource": { "description": "Validates the resource", "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.c [...] }, "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 [...] @@ -123,10 +123,10 @@ "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": { " [...] - "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 [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { [...] "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": "", " [...] - "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" [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { " [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "resour [...] } } diff --git a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirDelete.java b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirDelete.java index 70b048ecadc..d2690184f01 100644 --- a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirDelete.java +++ b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirDelete.java @@ -76,7 +76,7 @@ public class FhirDelete { } /** - * Specifies that the delete should be performed as a conditional delete against a given search URL. + * Specifies deleting should be performed as a conditional delete against a given search URL. * * @param url The search URL to use. The format of this URL should be of the form * <code>[ResourceType]?[Parameters]</code>, for example: diff --git a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirRead.java b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirRead.java index 4b356824a19..13663781048 100644 --- a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirRead.java +++ b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirRead.java @@ -18,6 +18,7 @@ package org.apache.camel.component.fhir.api; import java.util.Map; +import ca.uhn.fhir.rest.api.MethodOutcome; import ca.uhn.fhir.rest.client.api.IGenericClient; import ca.uhn.fhir.rest.gclient.IReadExecutable; import ca.uhn.fhir.rest.gclient.IReadIfNoneMatch; @@ -39,6 +40,17 @@ public class FhirRead { this.client = client; } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resource The resource to read (e.g. Patient) + * @param id the {@link IIdType} referencing the resource + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( Class<IBaseResource> resource, IIdType id, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -48,6 +60,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resourceClass the resource to read (e.g. Patient.class) + * @param id the {@link IIdType} referencing the resource + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( String resourceClass, IIdType id, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, Map<ExtraParameters, Object> extraParameters) { @@ -56,6 +79,18 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resource The resource to read (e.g. Patient) + * @param stringId The resource ID + * @param version the resource version + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( Class<IBaseResource> resource, String stringId, String version, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -66,6 +101,18 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resourceClass the resource to read (e.g. Patient.class) + * @param stringId The resource ID + * @param version the resource version + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( String resourceClass, String stringId, String ifVersionMatches, String version, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -76,6 +123,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resource The resource to read (e.g. Patient) + * @param longId The resource ID + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( Class<IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -85,6 +143,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by id + * + * @param resourceClass the resource to read (e.g. Patient) + * @param longId The resource ID + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceById( String resourceClass, Long longId, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, Map<ExtraParameters, Object> extraParameters) { @@ -93,6 +162,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by url + * + * @param resource The resource to read (e.g. Patient) + * @param iUrl the {@link IIdType} referencing the resource by absolute url + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceByUrl( Class<IBaseResource> resource, IIdType iUrl, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -102,6 +182,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by url + * + * @param resourceClass the resource to read (e.g. Patient.class) + * @param iUrl the {@link IIdType} referencing the resource by absolute url + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceByUrl( String resourceClass, IIdType iUrl, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, Map<ExtraParameters, Object> extraParameters) { @@ -110,6 +201,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by url + * + * @param resource The resource to read (e.g. Patient) + * @param url referencing the resource by absolute url + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceByUrl( Class<IBaseResource> resource, String url, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, @@ -119,6 +221,17 @@ public class FhirRead { return processOptionalParams(ifVersionMatches, returnNull, returnResource, throwError, readExecutable); } + /** + * Reads a {@link IBaseResource} on the server by url + * + * @param resourceClass the resource to read (e.g. Patient.class) + * @param url referencing the resource by absolute url + * @param ifVersionMatches a version to match against the newest version on the server. + * @param returnNull return null if version matches + * @param returnResource return the resource if version matches + * @param throwError throw error if the version matches + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public IBaseResource resourceByUrl( String resourceClass, String url, String ifVersionMatches, Boolean returnNull, IBaseResource returnResource, Boolean throwError, Map<ExtraParameters, Object> extraParameters) { diff --git a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirUpdate.java b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirUpdate.java index df8ad38df31..f51333e6db2 100644 --- a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirUpdate.java +++ b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirUpdate.java @@ -38,6 +38,14 @@ public class FhirUpdate { this.client = client; } + /** + * Updates a {@link IBaseResource} on the server by id + * + * @param resource The resource to update (e.g. Patient) + * @param id the {@link IIdType} referencing the resource + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource( IBaseResource resource, IIdType id, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { IUpdateTyped updateTyped = client.update().resource(resource); @@ -46,6 +54,14 @@ public class FhirUpdate { return processOptionalParam(preferReturn, updateExecutable); } + /** + * Updates a {@link IBaseResource} on the server by id + * + * @param resourceAsString The resource body to update + * @param id the {@link IIdType} referencing the resource + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource( String resourceAsString, IIdType id, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { IUpdateTyped updateTyped = client.update().resource(resourceAsString); @@ -54,6 +70,14 @@ public class FhirUpdate { return processOptionalParam(preferReturn, updateExecutable); } + /** + * Updates a {@link IBaseResource} on the server by id + * + * @param resource The resource to update (e.g. Patient) + * @param stringId the ID referencing the resource + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource( IBaseResource resource, String stringId, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { @@ -63,6 +87,14 @@ public class FhirUpdate { return processOptionalParam(preferReturn, updateExecutable); } + /** + * Updates a {@link IBaseResource} on the server by id + * + * @param resourceAsString The resource body to update + * @param stringId the ID referencing the resource + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource( String resourceAsString, String stringId, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { @@ -72,6 +104,14 @@ public class FhirUpdate { return processOptionalParam(preferReturn, updateExecutable); } + /** + * Updates a {@link IBaseResource} on the server by search url + * + * @param resource The resource to update (e.g. Patient) + * @param url Specifies that the update should be performed as a conditional create against a given search URL. + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resourceBySearchUrl( IBaseResource resource, String url, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { IUpdateExecutable updateExecutable = client.update().resource(resource).conditionalByUrl(url); @@ -79,6 +119,14 @@ public class FhirUpdate { return processOptionalParam(preferReturn, updateExecutable); } + /** + * Updates a {@link IBaseResource} on the server by search url + * + * @param resourceAsString The resource body to update + * @param url Specifies that the update should be performed as a conditional create against a given search URL. + * @param preferReturn whether the server include or suppress the resource body as a part of the result + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resourceBySearchUrl( String resourceAsString, String url, PreferReturnEnum preferReturn, Map<ExtraParameters, Object> extraParameters) { IUpdateExecutable updateExecutable = client.update().resource(resourceAsString).conditionalByUrl(url); diff --git a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirValidate.java b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirValidate.java index fa5e323d100..372151e0224 100644 --- a/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirValidate.java +++ b/components/camel-fhir/camel-fhir-api/src/main/java/org/apache/camel/component/fhir/api/FhirValidate.java @@ -34,12 +34,24 @@ public class FhirValidate { this.client = client; } + /** + * Validates the resource + * + * @param resource the {@link IBaseResource} to validate + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource(IBaseResource resource, Map<ExtraParameters, Object> extraParameters) { IValidateUntyped validateUntyped = client.validate().resource(resource); ExtraParameters.process(extraParameters, validateUntyped); return validateUntyped.execute(); } + /** + * Validates the resource + * + * @param resourceAsString raw resource to validate + * @param extraParameters see {@link ExtraParameters} for a full list of parameters that can be passed, may be NULL + */ public MethodOutcome resource(String resourceAsString, Map<ExtraParameters, Object> extraParameters) { IValidateUntyped validateUntyped = client.validate().resource(resourceAsString); ExtraParameters.process(extraParameters, validateUntyped); diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirDeleteEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirDeleteEndpointConfiguration.java index 2f8f0b11184..9cb35853815 100644 --- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirDeleteEndpointConfiguration.java +++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirDeleteEndpointConfiguration.java @@ -16,7 +16,7 @@ import org.apache.camel.spi.UriParams; */ @ApiParams(apiName = "delete", description = "API for the delete operation, which performs a logical delete on a server resource", - apiMethods = {@ApiMethod(methodName = "resource", description="Deletes the given resource", signatures={"org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)"}), @ApiMethod(methodName = "resourceById", description="Deletes the resource by resource type e", signatures={"org.hl7.fhir.instance.model.api.IBaseOperationOutcome [...] + apiMethods = {@ApiMethod(methodName = "resource", description="Deletes the given resource", signatures={"org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)"}), @ApiMethod(methodName = "resourceById", description="Deletes the resource by resource type e", signatures={"org.hl7.fhir.instance.model.api.IBaseOperationOutcome [...] @UriParams @Configurer(extended = true) public final class FhirDeleteEndpointConfiguration extends FhirConfiguration { diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java index 67c10ddb969..2ae6ebe3825 100644 --- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java +++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirReadEndpointConfiguration.java @@ -16,48 +16,48 @@ import org.apache.camel.spi.UriParams; */ @ApiParams(apiName = "read", description = "API method for read operations", - apiMethods = {@ApiMethod(methodName = "resourceById", signatures={"org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "org.hl7.fhir.instance.mode [...] + apiMethods = {@ApiMethod(methodName = "resourceById", description="Reads a IBaseResource on the server by id", signatures={"org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType id, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameter [...] @UriParams @Configurer(extended = true) public final class FhirReadEndpointConfiguration extends FhirConfiguration { @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resourceById", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resourceById", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resource [...] private java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceByUrl", description="The IIdType referencing the resource by absolute url")}) private org.hl7.fhir.instance.model.api.IIdType iUrl; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById", description="The IIdType referencing the resource")}) private org.hl7.fhir.instance.model.api.IIdType id; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="A version to match against the newest version on the server"), @ApiMethod(methodName = "resourceById", description="A version to match against the newest version on the server"), @ApiMethod(methodName = "resourceById", description="A version to match against the newest version on the server"), @ApiMethod(methodName = "resourceById", description="A version to match against the newest version [...] private String ifVersionMatches; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById", description="The resource ID")}) private Long longId; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById", description="The resource to read (e.g. Patient)"), @ApiMethod(methodName = "resourceByUrl", description="The resource to read (e.g. Patient)")}) private Class<org.hl7.fhir.instance.model.api.IBaseResource> resource; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById", description="The resource to read (e.g. Patient)"), @ApiMethod(methodName = "resourceByUrl", description="The resource to read (e.g. Patient.class)")}) private String resourceClass; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="Return null if version matches"), @ApiMethod(methodName = "resourceById", description="Return null if version matches"), @ApiMethod(methodName = "resourceById", description="Return null if version matches"), @ApiMethod(methodName = "resourceById", description="Return null if version matches"), @ApiMethod(methodName = "resourceById", description="Return null if version matches"), @ApiMethod(m [...] private Boolean returnNull; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="Return the resource if version matches"), @ApiMethod(methodName = "resourceById", description="Return the resource if version matches"), @ApiMethod(methodName = "resourceById", description="Return the resource if version matches"), @ApiMethod(methodName = "resourceById", description="Return the resource if version matches"), @ApiMethod(methodName = "resourceById", description="Return the res [...] private org.hl7.fhir.instance.model.api.IBaseResource returnResource; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceById", description="The resource ID")}) private String stringId; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceById"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl"), @ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="Throw error if the version matches"), @ApiMethod(methodName = "resourceById", description="Throw error if the version matches"), @ApiMethod(methodName = "resourceById", description="Throw error if the version matches"), @ApiMethod(methodName = "resourceById", description="Throw error if the version matches"), @ApiMethod(methodName = "resourceById", description="Throw error if the version mat [...] private Boolean throwError; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceByUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceByUrl", description="Referencing the resource by absolute url")}) private String url; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resourceById", description="The resource version")}) private String version; public java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> getExtraParameters() { diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java index 353ed675a58..a59735f73cc 100644 --- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java +++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirUpdateEndpointConfiguration.java @@ -16,30 +16,30 @@ import org.apache.camel.spi.UriParams; */ @ApiParams(apiName = "update", description = "API for the update operation, which performs a logical delete on a server resource", - apiMethods = {@ApiMethod(methodName = "resource", signatures={"ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, 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, String stringId, ca.uhn.fhi [...] + apiMethods = {@ApiMethod(methodName = "resource", description="Updates a IBaseResource on the server by id", signatures={"ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, org.hl7.fhir.instance.model.api.IIdType id, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.mo [...] @UriParams @Configurer(extended = true) public final class FhirUpdateEndpointConfiguration extends FhirConfiguration { @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resourceBySearchUrl"), @ApiMethod(methodName = "resourceBySearchUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resource", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resource", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resource", descripti [...] private java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource", description="The IIdType referencing the resource")}) private org.hl7.fhir.instance.model.api.IIdType id; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resourceBySearchUrl"), @ApiMethod(methodName = "resourceBySearchUrl")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource", description="Whether the server include or suppress the resource body as a part of the result"), @ApiMethod(methodName = "resource", description="Whether the server include or suppress the resource body as a part of the result"), @ApiMethod(methodName = "resource", description="Whether the server include or suppress the resource body as a part of the result"), @ApiMethod(methodName = "resource", description= [...] private ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resourceBySearchUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource", description="The resource to update (e.g. Patient)"), @ApiMethod(methodName = "resourceBySearchUrl", description="The resource to update (e.g. Patient)")}) private org.hl7.fhir.instance.model.api.IBaseResource resource; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resourceBySearchUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource", description="The resource body to update"), @ApiMethod(methodName = "resourceBySearchUrl", description="The resource body to update")}) private String resourceAsString; @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource", description="The ID referencing the resource")}) private String stringId; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceBySearchUrl")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resourceBySearchUrl", description="Specifies that the update should be performed as a conditional create against a given search URL")}) private String url; public java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> getExtraParameters() { diff --git a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java index 2c7030c00cf..f77b718e069 100644 --- a/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java +++ b/components/camel-fhir/camel-fhir-component/src/generated/java/org/apache/camel/component/fhir/FhirValidateEndpointConfiguration.java @@ -16,18 +16,18 @@ import org.apache.camel.spi.UriParams; */ @ApiParams(apiName = "validate", description = "API for validating resources", - apiMethods = {@ApiMethod(methodName = "resource", signatures={"ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)"}), }, aliases = {}) + apiMethods = {@ApiMethod(methodName = "resource", description="Validates the resource", signatures={"ca.uhn.fhir.rest.api.MethodOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)"}), }, aliases = {}) @UriParams @Configurer(extended = true) public final class FhirValidateEndpointConfiguration extends FhirConfiguration { @UriParam - @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource"), @ApiMethod(methodName = "resource")}) + @ApiParam(optional = true, apiMethods = {@ApiMethod(methodName = "resource", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL"), @ApiMethod(methodName = "resource", description="See ExtraParameters for a full list of parameters that can be passed, may be NULL")}) private java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource", description="The IBaseResource to validate")}) private org.hl7.fhir.instance.model.api.IBaseResource resource; @UriParam - @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource")}) + @ApiParam(optional = false, apiMethods = {@ApiMethod(methodName = "resource", description="Raw resource to validate")}) private String resourceAsString; public java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> getExtraParameters() { 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 237d1c47db3..db0d5079749 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 @@ -102,17 +102,17 @@ "apis": { "capabilities": { "consumerOnly": false, "producerOnly": false, "description": "API to Fetch the capability statement for the server", "methods": { "ofType": { "description": "Retrieve the conformance statement using the given model type", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseConformance ofType(Class<org.hl7.fhir.instance.model.api.IBaseConformance> type, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } }, "create": { "consumerOnly": false, "producerOnly": false, "description": "API for the create operation, which creates a new resource instance on the server", "methods": { "resource": { "description": "Creates a IBaseResource on the server", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String url, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca [...] - "delete": { "consumerOnly": false, "producerOnly": false, "description": "API for the delete operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Deletes the given resource", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] }, "resourceById": { "desc [...] + "delete": { "consumerOnly": false, "producerOnly": false, "description": "API for the delete operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Deletes the given resource", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseOperationOutcome resource(org.hl7.fhir.instance.model.api.IBaseResource resource, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] }, "resourceById": { "desc [...] "history": { "consumerOnly": false, "producerOnly": false, "description": "API for the history method", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle onInstance(org.hl7.fhir.instance.model.api.IIdType id, Class<org.hl7.fhir.instance.model.api.IBaseBundle> returnType, Integer count, java.util.Date cutoff, org.hl7.fhir.instance.mo [...] "load-page": { "consumerOnly": false, "producerOnly": false, "description": "API that Loads the previous\/next bundle of resources from a paged set, using the link specified in the link type=next tag within the atom bundle", "methods": { "byUrl": { "description": "Load a page of results using the given URL and bundle type and return a DSTU1 Atom bundle", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle byUrl(String url, Class<org.hl7.fhir.instance.model.api.IBaseBundle> r [...] "meta": { "consumerOnly": false, "producerOnly": false, "description": "API for the meta operations, which can be used to get, add and remove tags and other Meta elements from a resource or across the server", "methods": { "add": { "description": "Add the elements in the given metadata to the already existing set (do not remove any)", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseMetaType add(org.hl7.fhir.instance.model.api.IBaseMetaType meta, org.hl7.fhir.instance.model.api. [...] "operation": { "consumerOnly": false, "producerOnly": false, "description": "API for extended FHIR operations", "methods": { "onInstance": { "description": "Perform the operation across all versions of a specific resource (by ID and type) on the server", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource onInstance(org.hl7.fhir.instance.model.api.IIdType id, String name, org.hl7.fhir.instance.model.api.IBaseParameters parameters, Class<org.hl7.fhir.instance.model.api.IBas [...] "patch": { "consumerOnly": false, "producerOnly": false, "description": "API for the patch operation, which performs a logical patch on a server resource", "methods": { "patchById": { "description": "Applies the patch to the given resource ID", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome patchById(String patchBody, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", [...] - "read": { "consumerOnly": false, "producerOnly": false, "description": "API method for read operations", "methods": { "resourceById": { "description": "", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map<org.apache.camel.component.fhir.api.Extr [...] + "read": { "consumerOnly": false, "producerOnly": false, "description": "API method for read operations", "methods": { "resourceById": { "description": "Reads a IBaseResource on the server by id", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseResource resourceById(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, Long longId, String ifVersionMatches, Boolean returnNull, org.hl7.fhir.instance.model.api.IBaseResource returnResource, Boolean throwError, java.util.Map [...] "search": { "consumerOnly": false, "producerOnly": false, "description": "API to search for resources matching a given set of criteria", "methods": { "searchByUrl": { "description": "Perform a search directly by URL", "signatures": [ "org.hl7.fhir.instance.model.api.IBaseBundle searchByUrl(String url, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)" ] } } }, "transaction": { "consumerOnly": false, "producerOnly": false, "description": "API for sending a transaction (collection of resources) to the server to be executed as a single unit", "methods": { "withBundle": { "description": "Use the given raw text (should be a Bundle resource) as the transaction input", "signatures": [ "String withBundle(String stringBundle, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "org.hl7.fhir.instance.model.a [...] - "update": { "consumerOnly": false, "producerOnly": false, "description": "API for the update operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParameters)", "ca.uhn.fhir.rest.api.MethodOutcom [...] - "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 [...] + "update": { "consumerOnly": false, "producerOnly": false, "description": "API for the update operation, which performs a logical delete on a server resource", "methods": { "resource": { "description": "Updates a IBaseResource on the server by id", "signatures": [ "ca.uhn.fhir.rest.api.MethodOutcome resource(String resourceAsString, String stringId, ca.uhn.fhir.rest.api.PreferReturnEnum preferReturn, java.util.Map<org.apache.camel.component.fhir.api.ExtraParameters, Object> extraParam [...] + "validate": { "consumerOnly": false, "producerOnly": false, "description": "API for validating resources", "methods": { "resource": { "description": "Validates the resource", "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.c [...] }, "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 [...] @@ -123,10 +123,10 @@ "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": { " [...] - "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 [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { [...] "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": "", " [...] - "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" [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "id": { " [...] + "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": "See ExtraParameters for a full list of parameters that can be passed, may be NULL", "optional": true }, "resour [...] } }
