Merge pull request #11 from crowdsecurity/feature/examples

Feature/examples
crowdsecurity · Dec 9, 2020 · 34dfe76 · 34dfe76
2 parents c740b3d + 00524f9
commit 34dfe76
Show file tree

Hide file tree

Showing 196 changed files with 1,942 additions and 3,521 deletions.
diff --git a/.github/workflows/superlinter.yml b/.github/workflows/superlinter.yml
@@ -2,7 +2,6 @@ name: Super-Linter
 
 on:
     push:
-    pull_request:
 
 jobs:
   super-lint:

diff --git a/.gitignore b/.gitignore
@@ -1,14 +1,14 @@
 # Composer
-/vendor/
+vendor
 
 # Systems
 .DS_Store
 
 #Tools
 super-linter.log
-.phpdoc
 .php_cs.cache
 
 # App
 /var/
-.bouncer-key
+.bouncer-key
+.cache
diff --git a/.phpdoc-md b/.phpdoc-md
@@ -0,0 +1,16 @@
+<?php
+return (object)[
+    'rootNamespace' => 'CrowdSecBouncer', 
+    'destDirectory' => 'docs/api',
+    'format' => 'github',
+    'classes' => [
+        '\CrowdSecBouncer\ApiCache',
+        '\CrowdSecBouncer\ApiClient',
+        '\CrowdSecBouncer\Bouncer',
+        '\CrowdSecBouncer\BouncerException',
+        '\CrowdSecBouncer\Configuration',
+        '\CrowdSecBouncer\Constants',
+        '\CrowdSecBouncer\Remediation',
+        '\CrowdSecBouncer\RestClient',
+    ],
+];
diff --git a/.phpdoc-template/base.html.twig b/.phpdoc-template/base.html.twig
diff --git a/.phpdoc-template/class.html.twig b/.phpdoc-template/class.html.twig
diff --git a/.phpdoc-template/components/admonition.css.twig b/.phpdoc-template/components/admonition.css.twig
diff --git a/.phpdoc-template/components/back-to-top.css.twig b/.phpdoc-template/components/back-to-top.css.twig
diff --git a/.phpdoc-template/components/back-to-top.html.twig b/.phpdoc-template/components/back-to-top.html.twig
diff --git a/.phpdoc-template/components/breadcrumbs.css.twig b/.phpdoc-template/components/breadcrumbs.css.twig
diff --git a/.phpdoc-template/components/breadcrumbs.html.twig b/.phpdoc-template/components/breadcrumbs.html.twig
diff --git a/.phpdoc-template/components/class-graph.css.twig b/.phpdoc-template/components/class-graph.css.twig
diff --git a/.phpdoc-template/components/class-title.html.twig b/.phpdoc-template/components/class-title.html.twig
diff --git a/.phpdoc-template/components/constant-signature.html.twig b/.phpdoc-template/components/constant-signature.html.twig
diff --git a/.phpdoc-template/components/constant.html.twig b/.phpdoc-template/components/constant.html.twig
diff --git a/.phpdoc-template/components/constants.html.twig b/.phpdoc-template/components/constants.html.twig
diff --git a/.phpdoc-template/components/description.css.twig b/.phpdoc-template/components/description.css.twig
diff --git a/.phpdoc-template/components/description.html.twig b/.phpdoc-template/components/description.html.twig
diff --git a/.phpdoc-template/components/element-found-in.css.twig b/.phpdoc-template/components/element-found-in.css.twig
diff --git a/.phpdoc-template/components/element-found-in.html.twig b/.phpdoc-template/components/element-found-in.html.twig
diff --git a/.phpdoc-template/components/element-header.html.twig b/.phpdoc-template/components/element-header.html.twig
diff --git a/.phpdoc-template/components/element.css.twig b/.phpdoc-template/components/element.css.twig
diff --git a/.phpdoc-template/components/file-title.html.twig b/.phpdoc-template/components/file-title.html.twig
diff --git a/.phpdoc-template/components/function.html.twig b/.phpdoc-template/components/function.html.twig
diff --git a/.phpdoc-template/components/functions.html.twig b/.phpdoc-template/components/functions.html.twig
diff --git a/.phpdoc-template/components/header-title.css.twig b/.phpdoc-template/components/header-title.css.twig
diff --git a/.phpdoc-template/components/header-title.html.twig b/.phpdoc-template/components/header-title.html.twig