# What this PR does - Adds a `POST /escalation` public endpoint (equivalent to the internal direct paging API endpoint) - Adds public API documentation for teams and organization endpoints <img width="1140" alt="Screenshot 2024-08-15 at 12 49 40" src="https://github.com/user-attachments/assets/e0e8d6bb-f3ac-4f9e-bdf7-e8926949cc3b"> ## Which issue(s) this PR closes Closes https://github.com/grafana/oncall-private/issues/2859 Closes https://github.com/grafana/oncall/issues/2448 ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] Added the relevant release notes label (see labels prefixed w/ `release:`). These labels dictate how your PR will show up in the autogenerated release notes.
169 lines
7.8 KiB
Python
169 lines
7.8 KiB
Python
from django.urls import include, path, re_path
|
|
|
|
from common.api_helpers.optional_slash_router import OptionalSlashRouter, optional_slash_path
|
|
|
|
from .views import UserNotificationPolicyView, auth
|
|
from .views.alert_group import AlertGroupView
|
|
from .views.alert_group_table_settings import AlertGroupTableColumnsViewSet
|
|
from .views.alert_receive_channel import AlertReceiveChannelView
|
|
from .views.alert_receive_channel_template import AlertReceiveChannelTemplateView
|
|
from .views.alerts import AlertDetailView
|
|
from .views.channel_filter import ChannelFilterView
|
|
from .views.direct_paging import DirectPagingAPIView
|
|
from .views.escalation_chain import EscalationChainViewSet
|
|
from .views.escalation_policy import EscalationPolicyView
|
|
from .views.features import FeaturesAPIView
|
|
from .views.integration_heartbeat import IntegrationHeartBeatView
|
|
from .views.labels import AlertGroupLabelsViewSet, LabelsViewSet
|
|
from .views.live_setting import LiveSettingViewSet
|
|
from .views.on_call_shifts import OnCallShiftView
|
|
from .views.organization import (
|
|
CurrentOrganizationView,
|
|
GetChannelVerificationCode,
|
|
GetTelegramVerificationCode,
|
|
OrganizationConfigChecksView,
|
|
SetGeneralChannel,
|
|
)
|
|
from .views.preview_template_options import PreviewTemplateOptionsView
|
|
from .views.public_api_tokens import PublicApiTokenView
|
|
from .views.resolution_note import ResolutionNoteView
|
|
from .views.route_regex_debugger import RouteRegexDebuggerView
|
|
from .views.schedule import ScheduleView
|
|
from .views.shift_swap import ShiftSwapViewSet
|
|
from .views.slack_channel import SlackChannelView
|
|
from .views.slack_team_settings import (
|
|
AcknowledgeReminderOptionsAPIView,
|
|
SlackTeamSettingsAPIView,
|
|
UnAcknowledgeTimeoutOptionsAPIView,
|
|
)
|
|
from .views.team import TeamViewSet
|
|
from .views.telegram_channels import TelegramChannelViewSet
|
|
from .views.user import CurrentUserView, UserView
|
|
from .views.user_group import UserGroupViewSet
|
|
from .views.webhooks import WebhooksView
|
|
|
|
app_name = "api-internal"
|
|
|
|
router = OptionalSlashRouter()
|
|
router.register(r"users", UserView, basename="user")
|
|
router.register(r"teams", TeamViewSet, basename="team")
|
|
router.register(r"alertgroups", AlertGroupView, basename="alertgroup")
|
|
router.register(r"notification_policies", UserNotificationPolicyView, basename="notification_policy")
|
|
router.register(r"escalation_policies", EscalationPolicyView, basename="escalation_policy")
|
|
router.register(r"escalation_chains", EscalationChainViewSet, basename="escalation_chain")
|
|
router.register(r"alert_receive_channels", AlertReceiveChannelView, basename="alert_receive_channel")
|
|
router.register(
|
|
r"alert_receive_channel_templates", AlertReceiveChannelTemplateView, basename="alert_receive_channel_template"
|
|
)
|
|
router.register(r"channel_filters", ChannelFilterView, basename="channel_filter")
|
|
router.register(r"schedules", ScheduleView, basename="schedule")
|
|
router.register(r"webhooks", WebhooksView, basename="webhooks")
|
|
router.register(r"resolution_notes", ResolutionNoteView, basename="resolution_note")
|
|
router.register(r"telegram_channels", TelegramChannelViewSet, basename="telegram_channel")
|
|
router.register(r"slack_channels", SlackChannelView, basename="slack_channel")
|
|
router.register(r"user_groups", UserGroupViewSet, basename="user_group")
|
|
router.register(r"heartbeats", IntegrationHeartBeatView, basename="integration_heartbeat")
|
|
router.register(r"tokens", PublicApiTokenView, basename="api_token")
|
|
router.register(r"live_settings", LiveSettingViewSet, basename="live_settings")
|
|
router.register(r"oncall_shifts", OnCallShiftView, basename="oncall_shifts")
|
|
router.register(r"shift_swaps", ShiftSwapViewSet, basename="shift_swap")
|
|
|
|
urlpatterns = [
|
|
path("", include(router.urls)),
|
|
optional_slash_path("user", CurrentUserView.as_view(), name="api-user"),
|
|
optional_slash_path("set_general_channel", SetGeneralChannel.as_view(), name="api-set-general-log-channel"),
|
|
optional_slash_path("organization", CurrentOrganizationView.as_view(), name="api-organization"),
|
|
optional_slash_path(
|
|
"organization/config-checks",
|
|
OrganizationConfigChecksView.as_view(),
|
|
name="api-organization-config-checks",
|
|
),
|
|
# TODO: remove current_team routes in future release
|
|
optional_slash_path("current_team", CurrentOrganizationView.as_view(), name="api-current-team"),
|
|
optional_slash_path(
|
|
"current_team/get_telegram_verification_code",
|
|
GetTelegramVerificationCode.as_view(),
|
|
name="api-get-telegram-verification-code",
|
|
),
|
|
optional_slash_path(
|
|
"current_team/get_channel_verification_code",
|
|
GetChannelVerificationCode.as_view(),
|
|
name="api-get-channel-verification-code",
|
|
),
|
|
optional_slash_path("slack_settings", SlackTeamSettingsAPIView.as_view(), name="slack-settings"),
|
|
optional_slash_path(
|
|
"slack_settings/acknowledge_remind_options",
|
|
AcknowledgeReminderOptionsAPIView.as_view(),
|
|
name="acknowledge-reminder-options",
|
|
),
|
|
optional_slash_path(
|
|
"slack_settings/unacknowledge_timeout_options",
|
|
UnAcknowledgeTimeoutOptionsAPIView.as_view(),
|
|
name="unacknowledge-timeout-options",
|
|
),
|
|
optional_slash_path("features", FeaturesAPIView.as_view(), name="features"),
|
|
optional_slash_path(
|
|
"preview_template_options", PreviewTemplateOptionsView.as_view(), name="preview_template_options"
|
|
),
|
|
optional_slash_path("route_regex_debugger", RouteRegexDebuggerView.as_view(), name="route_regex_debugger"),
|
|
re_path(r"^alerts/(?P<id>\w+)/?$", AlertDetailView.as_view(), name="alerts-detail"),
|
|
optional_slash_path("direct_paging", DirectPagingAPIView.as_view(), name="direct_paging"),
|
|
]
|
|
|
|
urlpatterns += [
|
|
# For some reason frontend is using url without / at the end. Hacking here to avoid 301's :(
|
|
# TODO: I'm fairly certain this is not needed anymore, it looks like the frontend instead
|
|
# makes calls w/ a trailing slash.. we can probably get rid of social-auth-with-no-slash
|
|
path(r"login/<backend>", auth.overridden_login_social_auth, name="social-auth-with-no-slash"),
|
|
path(r"login/<backend>/", auth.overridden_login_social_auth, name="social-auth"),
|
|
path(r"complete/<backend>/", auth.overridden_complete_social_auth, name="complete-social-auth"),
|
|
path(r"disconnect/<backend>", auth.overridden_disconnect_social_auth, name="disconnect-social-auth"),
|
|
]
|
|
|
|
urlpatterns += [
|
|
re_path(r"^labels/keys/?$", LabelsViewSet.as_view({"get": "get_keys"}), name="get_keys"),
|
|
re_path(
|
|
r"^labels/id/(?P<key_id>[\w\-]+)/?$",
|
|
LabelsViewSet.as_view({"get": "get_key", "put": "rename_key"}),
|
|
name="get_update_key",
|
|
),
|
|
re_path(
|
|
r"^labels/id/(?P<key_id>[\w\-]+)/values/?$", LabelsViewSet.as_view({"post": "add_value"}), name="add_value"
|
|
),
|
|
re_path(
|
|
r"^labels/id/(?P<key_id>[\w\-]+)/values/(?P<value_id>[\w\-]+)/?$",
|
|
LabelsViewSet.as_view({"put": "rename_value", "get": "get_value"}),
|
|
name="get_update_value",
|
|
),
|
|
re_path(r"^labels/?$", LabelsViewSet.as_view({"post": "create_label"}), name="create_label"),
|
|
]
|
|
|
|
# Alert group labels
|
|
urlpatterns += [
|
|
re_path(
|
|
r"^alertgroups/labels/keys/?$",
|
|
AlertGroupLabelsViewSet.as_view({"get": "get_keys"}),
|
|
name="alert_group_labels-get_keys",
|
|
),
|
|
re_path(
|
|
r"^alertgroups/labels/id/(?P<key_id>.+/?$)",
|
|
AlertGroupLabelsViewSet.as_view({"get": "get_key"}),
|
|
name="alert_group_labels-get_key",
|
|
),
|
|
]
|
|
|
|
# Alert group table settings
|
|
urlpatterns += [
|
|
re_path(
|
|
r"^alertgroup_table_settings/?$",
|
|
AlertGroupTableColumnsViewSet.as_view(
|
|
{"get": "get_columns", "put": "update_user_columns", "post": "update_organization_columns"}
|
|
),
|
|
name="alert_group_table-columns_settings",
|
|
),
|
|
re_path(
|
|
r"^alertgroup_table_settings/reset?$",
|
|
AlertGroupTableColumnsViewSet.as_view({"post": "reset_user_columns"}),
|
|
name="alert_group_table-reset_columns_settings",
|
|
),
|
|
]
|