Skip to content

Commit

Permalink
feat: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@shahargl
shahargl committed Sep 1, 2024
1 parent afe9972 commit 2121585
Show file tree
Hide file tree
Showing 8 changed files with 125 additions and 136 deletions.
Binary file removed docs/images/singletenant.png
View file
Binary file not shown.
233 changes: 112 additions & 121 deletions docs/mint.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,207 +233,198 @@
{
"group": "providers",
"pages": [
"docs/api-ref/providers/get-providers",
"docs/api-ref/providers/get-installed-providers",
"docs/api-ref/providers/get-alerts-configuration",
"docs/api-ref/providers/get-logs",
"docs/api-ref/providers/get-alerts-schema",
"docs/api-ref/providers/get-alert-count",
"docs/api-ref/providers/add-alert",
"docs/api-ref/providers/test-provider",
"docs/api-ref/providers/delete-provider",
"docs/api-ref/providers/validate-provider-scopes",
"docs/api-ref/providers/update-provider",
"docs/api-ref/providers/install-provider",
"docs/api-ref/providers/install-provider-oauth2",
"docs/api-ref/providers/invoke-provider-method",
"docs/api-ref/providers/install-provider-webhook",
"docs/api-ref/providers/get-webhook-settings"
"api-ref/providers/get-providers",
"api-ref/providers/get-installed-providers",
"api-ref/providers/get-alerts-configuration",
"api-ref/providers/get-logs",
"api-ref/providers/get-alerts-schema",
"api-ref/providers/get-alert-count",
"api-ref/providers/add-alert",
"api-ref/providers/test-provider",
"api-ref/providers/delete-provider",
"api-ref/providers/validate-provider-scopes",
"api-ref/providers/update-provider",
"api-ref/providers/install-provider",
"api-ref/providers/install-provider-oauth2",
"api-ref/providers/invoke-provider-method",
"api-ref/providers/install-provider-webhook",
"api-ref/providers/get-webhook-settings"
]
},
{
"group": "actions",
"pages": [
"docs/api-ref/actions/get-actions",
"docs/api-ref/actions/create-actions",
"docs/api-ref/actions/put-action",
"docs/api-ref/actions/delete-action"
"api-ref/actions/get-actions",
"api-ref/actions/create-actions",
"api-ref/actions/put-action",
"api-ref/actions/delete-action"
]
},
{
"group": "healthcheck",
"pages": [
"docs/api-ref/healthcheck/healthcheck"
"api-ref/healthcheck/healthcheck"
]
},
{
"group": "alerts",
"pages": [
"docs/api-ref/alerts/get-all-alerts",
"docs/api-ref/alerts/delete-alert",
"docs/api-ref/alerts/get-alert-history",
"docs/api-ref/alerts/assign-alert",
"docs/api-ref/alerts/receive-generic-event",
"docs/api-ref/alerts/webhook-challenge",
"docs/api-ref/alerts/receive-event",
"docs/api-ref/alerts/get-alert",
"docs/api-ref/alerts/enrich-alert",
"docs/api-ref/alerts/unenrich-alert",
"docs/api-ref/alerts/search-alerts",
"docs/api-ref/alerts/get-alert-audit"
"api-ref/alerts/get-all-alerts",
"api-ref/alerts/delete-alert",
"api-ref/alerts/get-alert-history",
"api-ref/alerts/assign-alert",
"api-ref/alerts/receive-generic-event",
"api-ref/alerts/webhook-challenge",
"api-ref/alerts/receive-event",
"api-ref/alerts/get-alert",
"api-ref/alerts/enrich-alert",
"api-ref/alerts/unenrich-alert",
"api-ref/alerts/search-alerts",
"api-ref/alerts/get-alert-audit"
]
},
{
"group": "incidents",
"pages": [
"docs/api-ref/incidents/get-all-incidents",
"docs/api-ref/incidents/create-incident-endpoint",
"docs/api-ref/incidents/get-incident",
"docs/api-ref/incidents/update-incident",
"docs/api-ref/incidents/delete-incident",
"docs/api-ref/incidents/get-incident-alerts",
"docs/api-ref/incidents/add-alerts-to-incident",
"docs/api-ref/incidents/delete-alerts-from-incident",
"docs/api-ref/incidents/confirm-incident"
"api-ref/incidents/get-all-incidents",
"api-ref/incidents/create-incident-endpoint",
"api-ref/incidents/get-incident",
"api-ref/incidents/update-incident",
"api-ref/incidents/delete-incident",
"api-ref/incidents/get-incident-alerts",
"api-ref/incidents/add-alerts-to-incident",
"api-ref/incidents/delete-alerts-from-incident",
"api-ref/incidents/confirm-incident"
]
},
{
"group": "settings",
"pages": [
"docs/api-ref/settings/webhook-settings",
"docs/api-ref/settings/get-users",
"docs/api-ref/settings/create-user",
"docs/api-ref/settings/delete-user",
"docs/api-ref/settings/get-smtp-settings",
"docs/api-ref/settings/update-smtp-settings",
"docs/api-ref/settings/delete-smtp-settings",
"docs/api-ref/settings/test-smtp-settings",
"docs/api-ref/settings/update-api-key",
"docs/api-ref/settings/create-key",
"docs/api-ref/settings/get-keys",
"docs/api-ref/settings/delete-api-key",
"docs/api-ref/settings/get-sso-settings"
"api-ref/settings/webhook-settings",
"api-ref/settings/get-users",
"api-ref/settings/create-user",
"api-ref/settings/delete-user",
"api-ref/settings/get-smtp-settings",
"api-ref/settings/update-smtp-settings",
"api-ref/settings/delete-smtp-settings",
"api-ref/settings/test-smtp-settings",
"api-ref/settings/update-api-key",
"api-ref/settings/create-key",
"api-ref/settings/get-keys",
"api-ref/settings/delete-api-key",
"api-ref/settings/get-sso-settings"
]
},
{
"group": "workflows",
"pages": [
"docs/api-ref/workflows/get-workflows",
"docs/api-ref/workflows/create-workflow",
"docs/api-ref/workflows/export-workflows",
"docs/api-ref/workflows/run-workflow",
"docs/api-ref/workflows/run-workflow-from-definition",
"docs/api-ref/workflows/create-workflow-from-body",
"docs/api-ref/workflows/get-random-workflow-templates",
"docs/api-ref/workflows/get-workflow-by-id",
"docs/api-ref/workflows/update-workflow-by-id",
"docs/api-ref/workflows/delete-workflow-by-id",
"docs/api-ref/workflows/get-raw-workflow-by-id",
"docs/api-ref/workflows/get-workflow-executions-by-alert-fingerprint",
"docs/api-ref/workflows/get-workflow-execution-status",
"docs/api-ref/workflows/get-workflow-executions"
"api-ref/workflows/get-workflows",
"api-ref/workflows/create-workflow",
"api-ref/workflows/export-workflows",
"api-ref/workflows/run-workflow",
"api-ref/workflows/run-workflow-from-definition",
"api-ref/workflows/create-workflow-from-body",
"api-ref/workflows/get-random-workflow-templates",
"api-ref/workflows/get-workflow-by-id",
"api-ref/workflows/update-workflow-by-id",
"api-ref/workflows/delete-workflow-by-id",
"api-ref/workflows/get-raw-workflow-by-id",
"api-ref/workflows/get-workflow-executions-by-alert-fingerprint",
"api-ref/workflows/get-workflow-execution-status",
"api-ref/workflows/get-workflow-executions"
]
},
{
"group": "whoami",
"pages": [
"docs/api-ref/whoami/get-tenant-id"
"api-ref/whoami/get-tenant-id"
]
},
{
"group": "pusher",
"pages": [
"docs/api-ref/pusher/pusher-authentication"
"api-ref/pusher/pusher-authentication"
]
},
{
"group": "status",
"pages": [
"docs/api-ref/status/status"
"api-ref/status/status"
]
},
{
"group": "rules",
"pages": [
"docs/api-ref/rules/get-rules",
"docs/api-ref/rules/create-rule",
"docs/api-ref/rules/update-rule",
"docs/api-ref/rules/delete-rule"
"api-ref/rules/get-rules",
"api-ref/rules/create-rule",
"api-ref/rules/update-rule",
"api-ref/rules/delete-rule"
]
},
{
"group": "preset",
"pages": [
"docs/api-ref/preset/get-presets",
"docs/api-ref/preset/create-preset",
"docs/api-ref/preset/update-preset",
"docs/api-ref/preset/delete-preset",
"docs/api-ref/preset/get-preset-alerts",
"docs/api-ref/preset/create-preset-tab",
"docs/api-ref/preset/delete-tab"
]
},
{
"group": "users",
"pages": [
"docs/api-ref/users/get-users",
"docs/api-ref/users/create-user",
"docs/api-ref/users/update-user",
"docs/api-ref/users/delete-user"
"api-ref/preset/get-presets",
"api-ref/preset/create-preset",
"api-ref/preset/update-preset",
"api-ref/preset/delete-preset",
"api-ref/preset/get-preset-alerts",
"api-ref/preset/create-preset-tab",
"api-ref/preset/delete-tab"
]
},
{
"group": "enrichment",
"pages": [
"docs/api-ref/enrichment/get-rules",
"docs/api-ref/enrichment/update-rule",
"docs/api-ref/enrichment/create-rule",
"docs/api-ref/enrichment/delete-rule",
"docs/api-ref/enrichment/get-extraction-rules",
"docs/api-ref/enrichment/create-extraction-rule",
"docs/api-ref/enrichment/update-extraction-rule",
"docs/api-ref/enrichment/delete-extraction-rule"
"api-ref/enrichment/get-rules",
"api-ref/enrichment/update-rule",
"api-ref/enrichment/create-rule",
"api-ref/enrichment/delete-rule",
"api-ref/enrichment/get-extraction-rules",
"api-ref/enrichment/create-extraction-rule",
"api-ref/enrichment/update-extraction-rule",
"api-ref/enrichment/delete-extraction-rule"
]
},
{
"group": "auth",
"pages": [
"docs/api-ref/auth/get-groups",
"docs/api-ref/auth/create-group",
"docs/api-ref/auth/update-group",
"docs/api-ref/auth/delete-group",
"docs/api-ref/auth/get-permissions",
"docs/api-ref/auth/create-permissions",
"docs/api-ref/auth/get-scopes",
"docs/api-ref/auth/get-roles",
"docs/api-ref/auth/create-role",
"docs/api-ref/auth/update-role",
"docs/api-ref/auth/delete-role",
"docs/api-ref/auth/get-users",
"docs/api-ref/auth/create-user",
"docs/api-ref/auth/update-user",
"docs/api-ref/auth/delete-user"
"api-ref/auth/get-groups",
"api-ref/auth/create-group",
"api-ref/auth/update-group",
"api-ref/auth/delete-group",
"api-ref/auth/get-permissions",
"api-ref/auth/create-permissions",
"api-ref/auth/get-scopes",
"api-ref/auth/get-roles",
"api-ref/auth/create-role",
"api-ref/auth/update-role",
"api-ref/auth/delete-role",
"api-ref/auth/get-users",
"api-ref/auth/create-user",
"api-ref/auth/update-user",
"api-ref/auth/delete-user"
]
},
{
"group": "metrics",
"pages": [
"docs/api-ref/metrics/get-metrics"
"api-ref/metrics/get-metrics"
]
},
{
"group": "dashboard",
"pages": [
"docs/api-ref/dashboard/read-dashboards",
"docs/api-ref/dashboard/create-dashboard",
"docs/api-ref/dashboard/update-dashboard",
"docs/api-ref/dashboard/delete-dashboard"
"api-ref/dashboard/read-dashboards",
"api-ref/dashboard/create-dashboard",
"api-ref/dashboard/update-dashboard",
"api-ref/dashboard/delete-dashboard"
]
},
{
"group": "tags",
"pages": [
"docs/api-ref/tags/get-tags"
"api-ref/tags/get-tags"
]
}
]
Expand Down
1 change: 0 additions & 1 deletion docs/openapi.json
View file

This file was deleted.

1 change: 0 additions & 1 deletion docs/openapi_backup.json
View file

This file was deleted.

14 changes: 8 additions & 6 deletions keep-ui/app/providers/providers-tiles.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,12 +110,14 @@ const ProvidersTiles = ({
return "Connect Provider";
};

const sortedProviders = providers.sort(
(a, b) =>
Number(b.can_setup_webhook) - Number(a.can_setup_webhook) ||
Number(b.supports_webhook) - Number(a.supports_webhook) ||
Number(b.oauth2_url ? true : false) - Number(a.oauth2_url ? true : false)
);
const sortedProviders = providers
.filter(provider => Object.keys(provider.config || {}).length > 0 || (provider.tags && provider.tags.includes('alert')))
.sort(
(a, b) =>
Number(b.can_setup_webhook) - Number(a.can_setup_webhook) ||
Number(b.supports_webhook) - Number(a.supports_webhook) ||
Number(b.oauth2_url ? true : false) - Number(a.oauth2_url ? true : false)
);

return (
<div>
Expand Down
10 changes: 5 additions & 5 deletions keep-ui/app/settings/settings.client.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ export default function SettingsPage() {
return (
<EmptyStateTable
message={`Users management is disabled. See documentation on how to enable it.`}
documentationURL="https://docs.keep.run/docs/authentication/auth-type"
documentationURL="https://docs.keephq.dev/deployment/authentication/overview#authentication-features-comparison"
icon={UsersIcon}
>
<UsersTable users={mockUsers} currentUserEmail={session?.user?.email} authType={authType} isDisabled={true} />
Expand All @@ -149,7 +149,7 @@ export default function SettingsPage() {
<EmptyStateTable
icon={UserGroupIcon}
message={`Groups management is disabled with. See documentation on how to enabled it.`}
documentationURL="https://docs.keep.run/docs/authentication/auth-type"
documentationURL="https://docs.keephq.dev/deployment/authentication/overview#authentication-features-comparison"
>
<GroupsTable groups={mockGroups} onRowClick={() => {}} onDeleteGroup={() => {}} isDisabled={true} />
</EmptyStateTable>
Expand All @@ -167,7 +167,7 @@ export default function SettingsPage() {
<EmptyStateTable
icon={ShieldCheckIcon}
message={`Roles management is disabled with. See documentation on how to enabled it.`}
documentationURL="https://docs.keep.run/docs/authentication/auth-type"
documentationURL="https://docs.keephq.dev/deployment/authentication/overview#authentication-features-comparison"
>
<RolesTable roles={mockRoles} onRowClick={() => {}} onDeleteRole={() => {}} isDisabled={true} />
</EmptyStateTable>
Expand Down Expand Up @@ -199,7 +199,7 @@ export default function SettingsPage() {
<EmptyStateTable
icon={KeyIcon}
message={`API Keys management is disabled with. See documentation on how to enabled it.`}
documentationURL="https://docs.keep.run/docs/authentication/auth-type"
documentationURL="https://docs.keephq.dev/deployment/authentication/overview#authentication-features-comparison"
>
<APIKeysTable
apiKeys={mockApiKeys}
Expand All @@ -217,7 +217,7 @@ export default function SettingsPage() {
return (
<EmptyStateImage
message={`SSO management is disabled with. See documentation on how to enabled it.`}
documentationURL="https://docs.keep.run/docs/authentication/auth-type"
documentationURL="https://docs.keephq.dev/deployment/authentication/overview#authentication-features-comparison"
icon={LockClosedIcon}
imageURL='/sso.png'
/>
Expand Down
1 change: 0 additions & 1 deletion keep/api/api.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,6 @@ def get_app(
app.include_router(status.router, prefix="/status", tags=["status"])
app.include_router(rules.router, prefix="/rules", tags=["rules"])
app.include_router(preset.router, prefix="/preset", tags=["preset"])
app.include_router(users.router, prefix="/users", tags=["users"])
app.include_router(
mapping.router, prefix="/mapping", tags=["enrichment", "mapping"]
)
Expand Down
1 change: 0 additions & 1 deletion openapi.json
View file

This file was deleted.

0 comments on commit 2121585

Please sign in to comment.