[Synthetics] Global params Public APIs

[shahzad31]

Summary

fixes #167048
Part of #169547

Global params Public APIs !!

Local testing

set this config to set default version, production already sets it.

server.versioned.versionResolution: oldest

Following API have been made public

1. Get a parameter by ID
2. Get List of params
3. Create a param
4. Edit a param
5. Delete a parm

Docs can be tested locally by node scripts/docs --open

[github-actions]

Documentation preview:

• ✨ Changed pages

[apmmachine]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
• /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
• run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

[elasticmachine]

Pinging @elastic/uptime (Team:uptime)

[justinkambic]

Trying to follow the docs, I can't interact with the API. It looks like the original ~/internal/synthetics/params path is still in place to edit the params. This should correspond to the docs, if I'm understanding the intention here correctly.

[justinkambic]

Summary

Functionality LGTM - I have some concerns about the docs, a couple are nit but I think we need to have another pass on these to make sure we're giving people the best explanation of using the API that we can give.

Concerns

There are comments detailing the specific places in the diff I think we can improve.

1. The docs for Edit do not seem to reflect the reality of using the API for editing params. It specifies that we can include a param's ID in the path, and it shows this in an example. When I try that I get a 404. If I include the ID in the body of the request, the API behaves in the expected manner.
2. Let's include example request code for POST and DELETE like we have for the PUT route.
3. (Optional) I think it might be worth mentioning that kbn-xsrf header is required? That can be a real head scratcher as it's specific to Kibana, unlike something like Content-Type header which is standard. If we don't include it in other docs though, I guess we don't have to here.

Testing log

1. created some params, example:

2. created multiple params in same request 3. Fetch params, all and by id 4. Edit a param 5. Delete a param 6. I ensured that cross-space params showed up, and those configured not to share spaces are encapsulated within the appropriate space.

[justinkambic]

LGTM!!

[kibana-ci]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: dc132e4

Failed CI Steps

• Investigations - Security Solution Cypress Tests #7

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
synthetics	864.9KB	865.0KB	+128.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
synthetics	19.3KB	19.4KB	+49.0B

History

• 💔 Build #171474 failed 3780a56
• 💔 Build #171461 failed 68b5821
• 💔 Build #171316 failed 7ae7ca2
• 💔 Build #171308 failed 6963f0f
• 💚 Build #171072 succeeded eb5f7c1

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream