Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-18240

[DOCS] FHIR component - documentation issues

    XMLWordPrintableJSON

Details

    • Task
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • 3.14.0
    • 3.18.3, 3.19.0
    • camel-fhir
    • None
    • Unknown

    Description

      • Api operation contains incomplete URL in the description:
      • [PROPOSITION] Each API method contains method signatures. They are shown as one long string which is not readable very well. I.E.
        • 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); 

          Would be much more readable if each parameter would be on separate line:

        • 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); 
      • APIs read, update, validate - their methods are missing descriptions at all
      • All API operation's methods - Alias column is always empty --> could be erased from tables.

      Attachments

        Issue Links

          Activity

            People

              davsclaus Claus Ibsen
              mmajerni Mario Majernik
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: