You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@camel.apache.org by "Zoran Regvart (Jira)" <ji...@apache.org> on 2021/09/17 14:00:12 UTC

[jira] [Commented] (CAMEL-16982) Bindy dataformat documentation - three dataformats documented as one

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

Zoran Regvart commented on CAMEL-16982:
---------------------------------------

There seems to be some special handling of Bindy in the tooling:
{code}
tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java
740:            // special for bindy
741:            if (dataformat.startsWith("bindy")) {
742:                dataformat = "bindy";

tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java
288:                    if ("bindy".equals(dataFormatName)) {
304:                    // for now it's only applied to bindy but can be unlocked for other dataformats if needed
305:                    if ("bindy".equals(dataFormatName)) {
446:        if (name.startsWith("bindy")) {
447:            return "bindy";
455:        if (name.startsWith("bindy")) {

tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PackageDataFormatMojo.java
343:            if ("type".equals(option.getName()) && "bindy".equals(model.getModelName())) {
345:                    case "bindy-csv":
348:                    case "bindy-fixed":
351:                    case "bindy-kvp":
431:        } else if ("bindy-csv".equals(name) || "bindy-fixed".equals(name) || "bindy-kvp".equals(name)) {
432:            return "bindy";
466:    // TODO: split json / bindy into multiple jsons descriptors
485:        } else if ("bindy-csv".equals(name)) {
487:        } else if ("bindy-fixed".equals(name)) {
489:        } else if ("bindy-kvp".equals(name)) {
{code}

> Bindy dataformat documentation - three dataformats documented as one
> --------------------------------------------------------------------
>
>                 Key: CAMEL-16982
>                 URL: https://issues.apache.org/jira/browse/CAMEL-16982
>             Project: Camel
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 3.x
>            Reporter: Zoran Regvart
>            Priority: Major
>             Fix For: 3.x
>
>
> Bindy dataformat is composed of three components which all (currently) have identical options. Our current documentation approach is to use single set of options for
> all three and with the `jsonpathTable2` macro we needed to pick one (see [PR#6096|https://github.com/apache/camel/pull/6096]).
> Should we split into three asciidoc files for each option - that would be in line with how other components are documented?



--
This message was sent by Atlassian Jira
(v8.3.4#803005)