elastic/kibana

[Response Ops][Alerting] Restructure actions FT route definition

Open

#179.086 geöffnet am 20. März 2024

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (8.021 Forks)batch import
Feature:ActionsTeam:ResponseOpsgood first issuetechnical debt

Repository-Metriken

Stars
 (19.065 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 16h) (999 gemergte PRs in 30 T)

Beschreibung

Suggestion from PR review for https://github.com/elastic/kibana/pull/178682 to restructure the way routes are defined in the actions FT plugin. Referencing the route definitions in x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/unsecured_actions_simulation.ts

should we structure this like we do pagerduty, so we don't hardcode the `/api/...` path - which in theory, someday, could become a real API (but doubtful).  Eg, 

- https://github.com/elastic/kibana/blob/main/x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/pagerduty_simulation.ts
- https://github.com/elastic/kibana/blob/main/x-pack/test/alerting_api_integration/common/plugins/actions_simulators/server/plugin.ts

This is mostly pre-existing code, so I'd say we could just create a cleanup issue for it as well ...

Originally posted by @pmuellr in https://github.com/elastic/kibana/pull/178682#discussion_r1532077936

Contributor Guide

Research-Richtung
Untersuche das referenzierte Muster der Routendefinition der Pagerduty Simulation und wende es auf die Datei unsecured actions simulation.ts an. Strukturiere die Routendefinitionen um, um das Hartcodieren des Pfads `/api/` zu vermeiden.
Tech Stack
typescript
Domain
backendtesting
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptKibana plugin structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70