[Synthetics] [Meta] Road to versioned HTTP APIs

[dominiqueclarke]

Problem

To support serverless, we need to migrate to versioned HTTP APIs as described in the doc.

Appetite: small

Solution

@elastic/uptime

The various steps of the migration are defined in the doc

Release Target: GA

Progress Tracking

Step 1: Remove dependency on public saved objects HTTP APIs

Tasks

Preview Give feedback

1. [Synthetics] Remove dependency on public saved object API #153399
   Team:Uptime - DEPRECATED +1
   

Step 2: HTTP API interfaces must not implicitly include your SO-attribs

The goal is to isolate clients from direct knowledge of your SO-attribs. A change in SO-attribs may necessitate a change in one or more of our HTTP API interfaces, but this should be updated as a separate step.

Tasks

Preview Give feedback

1. [Synthetics] Shared api query schema - Remove fields from QuerySchema #153472
   Team:Uptime - DEPRECATED +1
   
2. [Synthetics] Overview api - isolate api query from saved object interface #153467
   Team:Uptime - DEPRECATED +1
   
3. [Synthetics] Get monitors api - isolate api query from saved object interface #153470
   Team:Uptime - DEPRECATED +1
4. [Synthetics] Get monitor / Get all monitors - Separate out HTTP interface from SO interface #153469
   Team:Uptime - DEPRECATED +1
   
5. [Synthetics] Add / Get private location - isolate api interface from saved object interface #153475
   Team:Uptime - DEPRECATED +1
   
6. [Synthetics] Add / Edit / Get synthetics params API - isolate api interface from saved object interface #153490
   Team:Uptime - DEPRECATED +1
   
7. [Synthetics] Add / Edit monitor API - isolate HTTP interface from SO attributes #153495
   Team:Uptime - DEPRECATED +1
   
8. [Synthetics] Settings - isolate HTTP interface from SO interface #153496
   Team:Uptime - DEPRECATED +1
   

Step 3: HTTP APIs have strict input validation

Tasks

Preview Give feedback

1. [Synthetics] [Spike] Evaluate Synthetics apis for strict input validation #159130
   Team:Uptime - DEPRECATED v8.9.0 +2
   
2. [Synthetics] Inspect api - remove preserve_namespace schema #159585
   Team:Uptime - DEPRECATED bug v8.9.0 +3
   
3. [Synthetics] Evaluate validation schema for bulk project monitor api #159583
   Team:Uptime - DEPRECATED enhancement v8.9.0 +3
4. [Synthetics] Consider validating client strategy for monitor body #159578
   Team:Uptime - DEPRECATED enhancement v8.9.0 +3
5. [Synthetics] Private locations - Clarify types for geo location #159576
   Team:Uptime - DEPRECATED bug v8.9.0 +3
   
6. [Synthetics] Isolate sort field schema from SO fields #159573
   Team:Uptime - DEPRECATED enhancement v8.9.0 +3
7. [Synthetics] Simplify schema for GET /internal/synthetics/journey/{checkGroup} #159591
   Team:Uptime - DEPRECATED enhancement v8.9.0 +3
   

Step 4: Keep HTTP APIs interfaces as “narrow” as possible

Done and covered in step 3

Step 6: Adopt the Elastic serverless HTTP API specification

None required

[elasticmachine]

Pinging @elastic/uptime (Team:uptime)

[shahzad31]

Step 5: Every saved object type must use the new modelVersion on the registerType API to specify up and down transforms

isn't needed anymore so removing it.

[paulb-elastic]

No step 6 items as we have no public API endpoints

[paulb-elastic]

All items complete, closing