Merge branch 'main' into GlebBerjoskin/incident_name_generator

.github/workflows/test-docs.yml

@@ -0,0 +1,40 @@
+name: Test docs
+on:
+  push:
+    paths:
+      - 'keep/**'
+  pull_request:
+    paths:
+      - 'keep/**'
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}-${{ github.job }}
+  cancel-in-progress: true
+env:
+  PYTHON_VERSION: 3.11
+  STORAGE_MANAGER_DIRECTORY: /tmp/storage-manager
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - uses: chartboost/ruff-action@v1
+        with:
+          src: "./keep"
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Install mintlify and validate docs
+        run: |
+          npm i -g mintlify
+          cd docs && mintlify broken-links;
+          cd ../scripts;
+          ./docs_validate_navigation.sh;
+          python3 docs_get_providers_list.py --validate;
+
+          # Todo: validate if openapi schema is matching with the code
+  

.github/workflows/test-pr-e2e.yml

@@ -123,6 +123,12 @@ jobs:
 
           # create the state directory
           # mkdir -p ./state && chown -R root:root ./state && chmod -R 777 ./state
+    
+      - name: Testing if API docs are actual
+        run: |
+          # Keeping this test here to avoid spinning Keep's backend it in the docs-test job
+          ./scripts/docs_validate_openapi_is_actual.sh
+
       - name: Run e2e tests and report coverage
         run: |
           poetry run coverage run --branch -m pytest -s tests/e2e_tests/

docs/api-ref/alerts/get-alert-audit.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /alerts/{fingerprint}/audit
+---

docs/api-ref/alerts/unenrich-alert.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /alerts/unenrich
+---

docs/api-ref/dashboard/create-dashboard.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /dashboard
+---

docs/api-ref/dashboard/delete-dashboard.mdx

@@ -0,0 +1,3 @@
+---
+openapi: delete /dashboard/{dashboard_id}
+---

docs/api-ref/dashboard/read-dashboards.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /dashboard
+---

docs/api-ref/dashboard/update-dashboard.mdx

@@ -0,0 +1,3 @@
+---
+openapi: put /dashboard/{dashboard_id}
+---

docs/api-ref/groups/get-groups.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /groups/
+---

docs/api-ref/incidents/add-alerts-to-incident.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /incidents/{incident_id}/alerts
+---

docs/api-ref/incidents/create-incident-endpoint.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /incidents
+---

docs/api-ref/incidents/delete-alerts-from-incident.mdx

@@ -0,0 +1,3 @@
+---
+openapi: delete /incidents/{incident_id}/alerts
+---

docs/api-ref/incidents/delete-incident.mdx

@@ -0,0 +1,3 @@
+---
+openapi: delete /incidents/{incident_id}
+---

docs/api-ref/incidents/get-all-incidents.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /incidents
+---

docs/api-ref/incidents/get-incident-alerts.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /incidents/{incident_id}/alerts
+---

docs/api-ref/incidents/get-incident.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /incidents/{incident_id}
+---

docs/api-ref/incidents/update-incident-1.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /incidents/{incident_id}/confirm
+---

docs/api-ref/incidents/update-incident.mdx

@@ -0,0 +1,3 @@
+---
+openapi: put /incidents/{incident_id}
+---

docs/api-ref/metrics/get-metrics.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /metrics
+---

docs/api-ref/preset/create-preset-tab.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /preset/{preset_id}/tab
+---

docs/api-ref/preset/delete-tab.mdx

@@ -0,0 +1,3 @@
+---
+openapi: delete /preset/{preset_id}/tab/{tab_id}
+---

docs/api-ref/preset/get-preset-alerts.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /preset/{preset_name}/alerts
+---

docs/api-ref/providers/get-alert-count.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /providers/{provider_type}/{provider_id}/alerts/count
+---

docs/api-ref/tags/get-tags.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /tags
+---

docs/api-ref/topology/get-topology-data.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /topology
+---

docs/api-ref/workflows/create-workflow-from-body.mdx

@@ -0,0 +1,3 @@
+---
+openapi: post /workflows/json
+---

docs/api-ref/workflows/get-random-workflow-templates.mdx

@@ -0,0 +1,3 @@
+---
+openapi: get /workflows/random-templates
+---

docs/cli/commands/extraction-create.mdx

@@ -31,7 +31,7 @@ Usage: keep extraction create [OPTIONS]
   * Default: `0`
   * Usage: `--priority <priority>`
 
-  The priority of the extraction, higher priority means this rule will execute first. [0<=x<=100].
+  The priority of the extraction, higher priority means this rule will execute first. `0<=x<=100`.
 
 * `pre`
   * Type: BOOL

docs/cli/commands/mappings-create.mdx

@@ -45,7 +45,7 @@ Usage: keep mappings create [OPTIONS]
   * Default: `0`
   * Usage: `--priority <priority>`
 
-  The priority of the mapping, higher priority means this rule will execute first. [0<=x<=100].
+  The priority of the mapping, higher priority means this rule will execute first. `0<=x<=100`.
 
 * `help`:
   * Type: BOOL

docs/development/getting-started.mdx

@@ -16,6 +16,45 @@ Next, run
 docker compose -f docker-compose.dev.yml up
 ```
 
+### Install Keep CLI
+
+First, clone Keep repository:
+
+```shell
+git clone https://github.com/keephq/keep.git && cd keep
+```
+
+Install Keep CLI
+
+```shell
+poetry install
+```
+
+From now on, Keep should be installed locally and accessible from your CLI, test it by executing:
+
+```
+keep version
+```
+
+## Enable Auto Completion
+
+**Keep's CLI supports shell auto-completion, which can make your life a whole lot easier 😌**
+
+If you're using zsh
+
+```shell title=~/.zshrc
+eval "$(_KEEP_COMPLETE=zsh_source keep)"
+```
+
+If you're using bash
+
+```bash title=~/.bashrc
+eval "$(_KEEP_COMPLETE=bash_source keep)"
+```
+
+> Using eval means that the command is invoked and evaluated every time a shell is started, which can delay shell responsiveness. To speed it up, write the generated script to a file, then source that.
+
+
 ### Testing
 
 Run unittests: