[jira] [Commented] (CAMEL-18240) [DOCS] FHIR component - documentation issues

["Claus Ibsen (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CAMEL-18240?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17599949#comment-17599949 ] 

Claus Ibsen commented on CAMEL-18240:
-------------------------------------

We scrape the docs from javadoc / source code and if fhir does not provide any then there is nothing to show

> [DOCS] FHIR component - documentation issues
> --------------------------------------------
>
>                 Key: CAMEL-18240
>                 URL: https://issues.apache.org/jira/browse/CAMEL-18240
>             Project: Camel
>          Issue Type: Task
>          Components: camel-fhir
>    Affects Versions: 3.14.0
>            Reporter: Mario Majernik
>            Priority: Minor
>
> * Api *operation* contains incomplete URL in the description:
> ** {code:java}
> API for extended FHIR operations https://www{code}
> ** Docs: https://camel.apache.org/components/3.14.x/fhir-component.html#_api_parameters_13_apis
>  * [PROPOSITION] Each API method contains method signatures. They are shown as one long string which is not readable very well. I.E.
>  ** 
> {code:java}
> org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource, org.hl7.fhir.instance.model.api.IIdType iUrl, 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); {code}
> Would be much more readable if each parameter would be on separate line:
>  * 
>  ** 
> {code:java}
> org.hl7.fhir.instance.model.api.IBaseResource resourceByUrl(Class<org.hl7.fhir.instance.model.api.IBaseResource> resource,
> org.hl7.fhir.instance.model.api.IIdType iUrl,
> 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); {code}
>  * APIs read, update, validate - their methods are missing descriptions at all
>  ** i.e.: [https://camel.apache.org/components/3.14.x/fhir-component.html#_api_validate]
>  * All API operation's methods - Alias column is always empty --> could be erased from tables.
>  ** i.e. method resource and its table:
>  *** https://camel.apache.org/components/3.14.x/fhir-component.html#_api_validate



--
This message was sent by Atlassian Jira
(v8.20.10#820010)