Skip to content

Improve EncryptedString documentation #5527

Closed
@loicmathieu

Description

Feature description

EncryptedString is a special type of output that will be automatically encrypted and decrypted so it is stored safely, and can't be decoded in the UI from the debug output functionality.

It's cool.

But it's visible in the documentation, see https://kestra.io/plugins/plugin-gcp/tasks/auth/io.kestra.plugin.gcp.auth.oauthaccesstoken#io.kestra.plugin.gcp.auth.oauthaccesstoken-accesstokenoutput

For an output named token of type EncryptedString, two properties will be emitted (type and value) and replaced at runtime by a single property.
So even if in the documentation you think that token.value exist, it cannot be used in a Pebble expression which should use, simply, token.

Documentation is misleading, we should at least remove the EncryptedBody definition.

We could also, but not mandatory, either replace EncryptedString by String when generating the schema/doc, or add a note to explain what it is and how it works.

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    • Status

      Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions