DSD-DBS / capella-polarion

Capella-Polarion Bridge - bi-directional integration of the 2 things based on REST API
https://dsd-dbs.github.io/capella-polarion/
3 stars 1 forks source link

Add render options #54

Closed micha91 closed 7 months ago

micha91 commented 7 months ago

We now support additional configuration in the config. To set configurations, the user has to provide the serializers as dict and can configure configuration option, which will be passed to the serializer as optional kwargs. All serializers still work without configuration and should always work in the future without configuration. For now only diagram generating serializers support additional configuration. Using the configuration key render_params the user can provide parameters, which will be used to call the diagram render method. If no render_params are configured the diagram will be generated without any additional parameters. This way we don't have to document default behaviors, as these should be documented in the capellambse documentation anyways. Example configuration for a custom depth of a tree view:

  Class:
    serializer:
      add_tree_diagram:
        render_params:
          depth: 1