[Rules] [Meta] Road to versioned HTTP APIs #157883

XavierM · 2023-05-16T14:18:17Z

To not introduce any breaking changes or changes in the behavior of Rules and Connectors APIs when upgrading Kibana, we need to do changes in our endpoints. The needed steps to achieve this goal are described in the following section.

Steps

Disconnect API Interface with SO Attributes

The goal of this step is to isolate the SO attributes from the HTTP APIs. Any change in our SO attributes should not reflect a change in our API interfaces. To do that we need to

Create types for domain objects
Create TS interfaces/types for SOs and HTTP routes even if they are the same. Types for SOs should be in the server directory
Explicitly map the SO attributes to the response and vice-versa even if they are the same. No more spreading

APIs:

Rules:

Rule Settings:

GET /internal/alerting/rules/settings/_flapping -> @Zacqary
POST /internal/alerting/rules/settings/_flapping -> @Zacqary

Maintenance Windows:

GET /internal/alerting/rules/maintenance_window/_active (active) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
POST /internal/alerting/rules/maintenance_window/_bulk_get (bulk get) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
GET /internal/alerting/rules/maintenance_window/_find (find) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
POST /internal/alerting/rules/maintenance_window/{id}/_finish (finish) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
POST /internal/alerting/rules/maintenance_window/{id}/_archive (archive, maybe this should be archive/unarchive, 2 routes) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
POST /internal/alerting/rules/maintenance_window (create) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
DELETE /internal/alerting/rules/maintenance_window/{id} (delete) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
GET /internal/alerting/rules/maintenance_window/{id} (get) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446
POST /internal/alerting/rules/maintenance_window/{id} (update) -> @JiaweiWu [RAM][HTTP versioning] Version Maintenance Window Endpoints #162446

elasticmachine · 2023-05-16T14:18:20Z

Pinging @elastic/response-ops (Team:ResponseOps)

JiaweiWu · 2023-06-07T17:58:37Z

PoC PR: #158786

## Summary Resolves: #157883 # Summary: This PR acts as a POC for how we would want to version our rule API types in preparation for the versioning of our HTTP endpoints. There is now an ES persisted type (called `RuleAttributes`, akin to the old `RawRule` type). This type should never be used at the business logic level as we want the ability not to reference saved object attributes directly in the application. Instead, we should transform this saved-object to its corresponding domain object type. HTTP types (`CreateBodyParams`, `RuleResponse`) are now located in `x-pack/plugins/alerting/common/routes/rule` with a versioning structure like: ![image](https://github.com/elastic/kibana/assets/74562234/1c8e886d-8983-40f2-9490-aa3864898535) And follows the guideline here: https://docs.elastic.dev/kibana-dev-docs/versioning-interfaces Domain object types (rule for example) are derived from the `config-schema` schemas using `TypeOf`, this was done to facilitate the reuse of validation schemas that we might want to run for strict IO validation, potentially at the `rulesClient` level. ## API: Only the `createRule` endpoint has been converted for the sake of this POC, other endpoints might have broken types that will be fixed once we have a finalized pattern for dealing with versioned types. At the API route level, I think it would be wise to import versioned types in our APIs, this way, it forces the developer to deal with broken types when we have a breaking change to our rule domain object. The API route level is also responsible for transforming domain objects to response types, usually, this just entails renaming property names from camel case to snake case. in `create_rule_route.ts` ```ts import type { CreateRuleRequestBodyV1, CreateRuleRequestParamsV1 } from '../../../../common/routes/rule/create'; import type { RuleParamsV1 } from '../../../../common/routes/rule/rule_response'; ... // In the Handler: const rulesClient = (await context.alerting).getRulesClient(); const createRuleData: CreateRuleRequestBodyV1<RuleParamsV1> = req.body; const params: CreateRuleRequestParamsV1 = req.params; const createdRule: Rule<RuleParamsV1> = (await rulesClient.create<RuleParamsV1>({ data: transformCreateBodyV1<RuleParamsV1>(createRuleData), options: { id: params?.id }, })) as Rule<RuleParamsV1>; const response: CreateRuleResponseV1<RuleParamsV1> = { body: transformRuleToRuleResponseV1<RuleParamsV1>(createdRule), }; return res.ok(response); ``` ### RulesClient -> Create At the rules client level, we now need to transform saved-objects to the domain objects after we perform CRUD operations on them. We can also consider validating schemas here too since other solutions are using our rules client directly instead of through the API. I don't think we need to version rules client input and output types since the route level types should deal with breaking changes already. Therefore, we can freely import the latest of any domain object types (Rule, for example) ```ts import { Rule, RuleDomain, RuleParams } from '../types'; ``` The flow is the following: ``` 1. calling rulesClient.create() with API body and params. 2. perform schema validation on params 3. perform other validation not achievable using config-schema 4. perform rule create -> returns a `savedObject` type 5. convert `savedObject` ES type to the domain object type (`RuleDomain`) 6. convert the domain object type to a public domain object type (`Rule`) 7. We can also validate the created rule using config-schema ``` # Open questions: - Should we validate input params at both the route and the rules client level? I think we should since our rules client is shared. - How do we want to version and validate rule params? Right now they're typed as generics. - Should we leave all date fields as `string`, even for domain objects? Since config-schema is unable to define a `Date` type. - Should we support partial rule domain object types at all? I can't really think why we should even for `updates`, since we need to reconstruct the overall rule to send back to the client. - Should we have `undefined | null` types in the domain object? I know we need `null` specifically for the ES types since there is a different between updating a field as `undefined` or `null`, but this shouldn't manifest itself in the business logic. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Resolves: #161395 Parent Issue: #157883 Adds versioned types to the rule `bulk_edit` endpoint. This PR also moves around the folder structure slightly, by adding a sub folder for the `data`/`route`/`application` methods: ## Before ![image](https://github.com/elastic/kibana/assets/74562234/3ae19871-cc5c-4180-b099-5fed86c3870b) ## After ![image](https://github.com/elastic/kibana/assets/74562234/bbd67bb4-4899-4f65-966e-64964f994a04) Notice I added a `methods` folder to contain the methods, I did the same for the `data` and `route` folders as well. I think this improves the hierarchy of these modules, If folks are ok with it then I will update the doc with the new folder structure. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Resolves: elastic#161395 Parent Issue: elastic#157883 Adds versioned types to the rule `bulk_edit` endpoint. This PR also moves around the folder structure slightly, by adding a sub folder for the `data`/`route`/`application` methods: ## Before ![image](https://github.com/elastic/kibana/assets/74562234/3ae19871-cc5c-4180-b099-5fed86c3870b) ## After ![image](https://github.com/elastic/kibana/assets/74562234/bbd67bb4-4899-4f65-966e-64964f994a04) Notice I added a `methods` folder to contain the methods, I did the same for the `data` and `route` folders as well. I think this improves the hierarchy of these modules, If folks are ok with it then I will update the doc with the new folder structure. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Meta issue: #157883 - Adds HTTP versioning to the aggregate rules endpoint - Deletes legacy HTTP get aggregate method --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

## Summary Resolves: #162179 Parent Issue: #157883 Versions the - `create` - `active` - `bulk_get` - `find` - `finish` - `archive` - `delete` - `get` - `update` `/rules/maintenance_window` maintenance window endpoint. Also adds schema validation to the I/O of each method. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Issue: #179476 Parent issue: #157883 This PR versions the update (`PUT '/api/alerting/rule/{id}'`) route. Still using `config-schema` for now, even though we will eventually switch to `zod` when core is ready with openapi doc generation support in the versioned router. We are now validating update data using the update data schema when calling `rulesClient->update`. We are also validating (but not throwing) the updated rule as well. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Parent Issue: #157883 Issue: #181263 Versions the GET rule endpoint with added input and output validation. ``` GET /internal/alerting/rule/{id} GET /api/alerting/rule/{id} ``` ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios

## Summary Parent Issue: #157883 Issue: #179669 Versions the `PATCH /internal/alerting/rules/_bulk_enable` endpoint with added input and output validation. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Issue: #180079 Parent Issue: #157883 Versions the clone rule API and adds input/output validation ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…180654) ## Summary Issue: #180551 Parent Issue: #157883 Versions the internal and public find API routes. Adds Input validation as well. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Parent Issue: elastic#157883 Issue: elastic#181263 Versions the GET rule endpoint with added input and output validation. ``` GET /internal/alerting/rule/{id} GET /api/alerting/rule/{id} ``` ### Checklist Delete any items that are not applicable to this PR. - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios

## Summary Parent Issue: elastic#157883 Issue: elastic#179669 Versions the `PATCH /internal/alerting/rules/_bulk_enable` endpoint with added input and output validation. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Issue: elastic#180079 Parent Issue: elastic#157883 Versions the clone rule API and adds input/output validation ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…lastic#180654) ## Summary Issue: elastic#180551 Parent Issue: elastic#157883 Versions the internal and public find API routes. Adds Input validation as well. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

## Summary Parent Issue: #157883 Issue: #181513 Versions the DELETE rule endpoint with added input validation. `DELETE /api/alerting/rule/{id}` ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios

jcger · 2024-10-17T08:38:24Z

continued in #187356

XavierM added Meta Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Alerting/RulesManagement Issues related to the Rules Management UX v8.9.0 labels May 16, 2023

XavierM assigned XavierM and JiaweiWu May 16, 2023

JiaweiWu mentioned this issue May 31, 2023

[RAM] Rule API Type Versioning POC - Create Rule #158786

Merged

1 task

XavierM assigned Zacqary, jcger and guskovaue Jun 28, 2023

JiaweiWu closed this as completed in #158786 Jul 5, 2023

XavierM reopened this Jul 6, 2023

JiaweiWu mentioned this issue Jul 6, 2023

[RAM][HTTP Versioning] Version Bulk Edit Endpoint #161395

Closed

This was referenced Jul 13, 2023

[RAM][HTTP Versioning] Version Rule Bulk Edit Endpoint #161912

Merged

[RAM][HTTP Versioning] Version Maintenance Window Routes #162179

Closed

JiaweiWu mentioned this issue Jul 25, 2023

[RAM][HTTP versioning] Version Maintenance Window Endpoints #162446

Merged

1 task

JiaweiWu added the v8.10.0 label Jul 26, 2023

Zacqary mentioned this issue Aug 7, 2023

[RAM] Add HTTP versioning to resolve, snooze, and unsnooze APIs #163359

Closed

1 task

guskovaue mentioned this issue Aug 8, 2023

[RAM][HTTP Versioning] Version Bulk Delete Endpoint #163392

Closed

guskovaue mentioned this issue Aug 18, 2023

[RAM][HTTP Versioning] bulk delete api versioning #164015

Merged

1 task

This was referenced Aug 29, 2023

[RAM] HTTP Versioning Aggregate Rules Endpoint #164284

Merged

[RAM] HTTP Versioning Rule Mute Alert #165573

Merged

jcger mentioned this issue Sep 6, 2023

Http versioning rule tags #165849

Merged

This was referenced Mar 26, 2024

[RAM] Version rule update API #179476

Closed

[RAM][HTTP Versioning] Version Public Rule Update Route #179587

Merged

[RAM] Version Bulk Enable API #179669

Closed

[RAM][HTTP versioning] Version Bulk Enable Route #179778

Merged

This was referenced Apr 4, 2024

[RAM] Version Clone Rule API #180079

Closed

[RAM][HTTP Versioning] Version Clone Rule Route #180549

Merged

[RAM] Version Find Rule API #180551

Closed

JiaweiWu mentioned this issue Apr 12, 2024

[RAM][HTTP Versioning] Version Internal and Public Find Rules Route #180654

Merged

1 task

This was referenced Apr 18, 2024

[RAM] Version Get Rule API #181104

Closed

[RAM] Version Get Rule API #181263

Closed

[RAM][HTTP Versioning] Version GET Rule Route #181304

Merged

[RAM] Version Delete Rule API #181513

Closed

[RAM][HTTP Versioning] Version DELETE Rule Route #181521

Merged

cnasikas removed v8.9.0 v8.10.0 labels May 1, 2024

cnasikas changed the title ~~[RAM] [Meta] Road to versioned HTTP APIs~~ [Rules] [Meta] Road to versioned HTTP APIs Jul 2, 2024

cnasikas mentioned this issue Jul 2, 2024

[ResponseOps][Rules][Meta] Add OAS support for Rules APIs #187356

Open

cnasikas mentioned this issue Jul 25, 2024

Full End to End OAS Automation for Rule creation Endpoint #178014

Closed

jcger closed this as completed Oct 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rules] [Meta] Road to versioned HTTP APIs #157883

[Rules] [Meta] Road to versioned HTTP APIs #157883

XavierM commented May 16, 2023 •

edited by cnasikas

Loading

elasticmachine commented May 16, 2023

JiaweiWu commented Jun 7, 2023

jcger commented Oct 17, 2024

[Rules] [Meta] Road to versioned HTTP APIs #157883

[Rules] [Meta] Road to versioned HTTP APIs #157883

Comments

XavierM commented May 16, 2023 • edited by cnasikas Loading

Steps

Disconnect API Interface with SO Attributes

APIs:

Rules:

Rule Settings:

Maintenance Windows:

elasticmachine commented May 16, 2023

JiaweiWu commented Jun 7, 2023

jcger commented Oct 17, 2024

XavierM commented May 16, 2023 •

edited by cnasikas

Loading