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

conduit-docs: conduit_processors_filter_tags.md #10

Merged
merged 2 commits into from
Mar 14, 2023
Merged

Conversation

shiqizng
Copy link
Contributor

@shiqizng shiqizng commented Mar 13, 2023

tag is one of the config field for filter processor. It would be convenient to have a list of supported tags in the conduit docs.
the doc would have a table like this,

filter tag transaction field
aca ApplyData.AssetClosingAmount
apid ApplyData.ApplicationID
ca ApplyData.ClosingAmount
caid ApplyData.ConfigAsset
lsig.msig.thr SignedTxn.Lsig.Msig.Threshold
lsig.msig.v SignedTxn.Lsig.Msig.Version
msig.thr SignedTxn.Msig.Threshold
msig.v SignedTxn.Msig.Version
rc ApplyData.CloseRewards
rr ApplyData.ReceiverRewards
...

@shiqizng shiqizng requested a review from winder March 13, 2023 19:41
@codecov
Copy link

codecov bot commented Mar 13, 2023

Codecov Report

Merging #10 (6f4c231) into master (9c7f525) will decrease coverage by 1.31%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master      #10      +/-   ##
==========================================
- Coverage   67.23%   65.92%   -1.31%     
==========================================
  Files          32       32              
  Lines        1819     1855      +36     
==========================================
  Hits         1223     1223              
- Misses        529      565      +36     
  Partials       67       67              
Impacted Files Coverage Δ
...gins/processors/filterprocessor/fields/searcher.go 77.50% <ø> (ø)
...plugins/processors/filterprocessor/gen/generate.go 34.28% <0.00%> (-7.10%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@shiqizng shiqizng requested a review from Eric-Warehime March 13, 2023 19:48
@shiqizng shiqizng changed the title write a tags file conduit-docs: conduit_processors_filter_tags.md Mar 13, 2023
@shiqizng shiqizng self-assigned this Mar 13, 2023
Copy link
Contributor

@Eric-Warehime Eric-Warehime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Be sure to take a look at the output file to be certain that the formatting is how you want. I found the docs' markdown formatting to be particular about how it wanted things setup. Our docs automation also does some stuff that potentially impacts the final output.

Copy link
Contributor

@winder winder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Too bad we're using reflection instead of ast.Inspect -- we'd be able to get the field comments too.

@shiqizng shiqizng merged commit 3c92877 into master Mar 14, 2023
@shiqizng shiqizng deleted the shiqi/filtertags branch March 14, 2023 19:15
tzaffi pushed a commit to tzaffi/conduit that referenced this pull request May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants