Skip to content

[WIP] docs: adds documentation to operators. #1340

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jcchavezs
Copy link
Member

@jcchavezs jcchavezs commented Apr 2, 2025

This PR starts adding the documentation to operators. Plays in tandem with corazawaf/coraza.io#304.

do not merge yet.

@jcchavezs jcchavezs requested a review from a team as a code owner April 2, 2025 08:56
Copy link

codecov bot commented Apr 2, 2025

Codecov Report

Attention: Patch coverage is 86.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 81.99%. Comparing base (681afa9) to head (4bffe24).
Report is 4 commits behind head on main.

Files with missing lines Patch % Lines
internal/operators/begins_with.go 50.00% 1 Missing ⚠️
internal/seclang/directives.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1340   +/-   ##
=======================================
  Coverage   81.99%   81.99%           
=======================================
  Files         170      170           
  Lines        9803     9803           
=======================================
  Hits         8038     8038           
  Misses       1518     1518           
  Partials      247      247           
Flag Coverage Δ
coraza.rule.case_sensitive_args_keys 81.95% <86.66%> (ø)
coraza.rule.multiphase_valuation 81.99% <86.66%> (ø)
coraza.rule.no_regex_multiline 81.93% <86.66%> (ø)
default 81.99% <86.66%> (ø)
examples+ 16.50% <46.66%> (ø)
examples+coraza.rule.case_sensitive_args_keys 81.95% <86.66%> (ø)
examples+coraza.rule.multiphase_valuation 81.83% <86.66%> (ø)
examples+coraza.rule.no_regex_multiline 81.85% <86.66%> (ø)
examples+memoize_builders 81.95% <86.66%> (ø)
examples+no_fs_access 81.28% <86.66%> (ø)
ftw 81.99% <86.66%> (ø)
memoize_builders 82.08% <86.66%> (ø)
no_fs_access 81.44% <86.66%> (ø)
tinygo 81.96% <86.66%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant