Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Citrus Functions documentation gaps #1086

Closed
picimako opened this issue Jan 2, 2024 · 3 comments
Closed

Citrus Functions documentation gaps #1086

picimako opened this issue Jan 2, 2024 · 3 comments
Labels
good first issue A good point to start from for new contributrs Prio: Medium Type: Documentation

Comments

@picimako
Copy link
Contributor

picimako commented Jan 2, 2024

Hi!

I've been going through the implementations of Citrus function classes and I've found a few things that are missing from the documentation on the website:

  • encodeBase64/decodeBase64: no mention of the optional charset parameter.
  • readFile: no mention of the optional encode base64 and replace dynamic content parameters.
  • jsonPath: no mention of that the jsonPath expression is always the last parameter, and there can be an arbitrary number of json source part parameters before that, that are concatenated into a single json source text.
  • unixTimestamp: there is no section for this in the documentation
@bbortt
Copy link
Collaborator

bbortt commented Jan 3, 2024

hello @picimako, thanks for the remarks. contributions are always welcome, if you're able to do so. especially in the documentation section - we're always having hard times there. please let me know if you're willing to do so, or if I should proceed with the updates if I find time.

@bbortt bbortt added Prio: Medium good first issue A good point to start from for new contributrs Type: Documentation labels Jan 3, 2024
@picimako
Copy link
Contributor Author

picimako commented Jan 3, 2024

@bbortt Yeah, I'll do it gladly.

picimako added a commit to picimako/citrus-fork that referenced this issue Jan 6, 2024
…umentation for encodeBase64, decodeBase64 and jsonPath functions. Also add a new section for the unixTimestamp function.
christophd pushed a commit that referenced this issue Jan 8, 2024
…encodeBase64, decodeBase64 and jsonPath functions. Also add a new section for the unixTimestamp function.
@christophd
Copy link
Member

Fixed with #1088

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good point to start from for new contributrs Prio: Medium Type: Documentation
Projects
None yet
Development

No branches or pull requests

3 participants