[Fleet] Make API responses consistent #119494

juliaElastic · 2021-11-23T15:52:15Z

Summary

Fixes #119182

Making Fleet API GET responses consistent, so that they all return items:
- /api/fleet/enrollment-api-keys
- /api/fleet/agents
Updated openapi spec.

EDIT: as discussed it is a kibana convention to use underscore. Updated following APIs to underscore and deprecated old ones:
enrollment-api-keys to enrollment_api_keys
agent-status to agent_status
service-tokens to service_tokens
Note: check-permissions will be removed anyway, so not worth changing that.

EDIT:
further changes for consistency:
changing /epm/packages/{pkgkey} endpoint to /epm/packages/{packageName}/{version}
changing response[] to items[] or item here:

/epm/packages/
/epm/packages/{pkgkey}
/epm/categories
/epm/packages/_bulk
/epm/packages/limited

Update documentation with changed API paths (epm pkgkey mentioned in many places)

For maintainers

This was checked for breaking API changes and was labeled appropriately

elasticmachine · 2021-11-23T15:52:20Z

Pinging @elastic/fleet (Team:Fleet)

juliaElastic · 2021-11-23T15:56:33Z

x-pack/plugins/fleet/common/types/rest_spec/agent.ts

-    page: number;
-    perPage: number;
-    kuery?: string;
+  query: ListWithKuery & {


There is a slight difference here as page and perPage are optional in ListWithKuery, hopefully not a problem. I feel it's still better to use the common interface.

nchaulet · 2021-11-23T19:58:29Z

I do not think we can make that change without breaking the agent setup on cloud. Elastic agent on cloud is calling the setup API and this API to get enrollemtn tokens https://github.com/elastic/beats/blob/15366ffee58fe2012daf524a7845026011faf4a1/x-pack/elastic-agent/pkg/agent/cmd/container.go#L453

juliaElastic · 2021-11-24T08:24:31Z

@nchaulet thanks for pointing this out! should I updated in beats repo?

nchaulet · 2021-11-24T14:21:26Z

@nchaulet thanks for pointing this out! should I updated in beats repo?

I think it will make sense to create an issue in the beats repo to see how the migration could work, I am not sure what retro compatibility we should keep here

juliaElastic · 2021-11-24T15:05:16Z

@nchaulet raised this: elastic/elastic-agent#111

criamico · 2021-11-24T16:08:10Z

I think that this should be labeled as release_note:breaking

juliaElastic · 2021-11-29T08:24:05Z

@elasticmachine merge upstream

kibanamachine · 2021-11-29T08:24:36Z

expected head sha didn’t match current head ref.

criamico

LGTM for the fleet changes 👍

juliaElastic · 2021-11-30T13:24:01Z

@elasticmachine merge upstream

patrykkopycinski

LGTM

kibana-ci · 2021-12-08T11:33:02Z

💛 Build succeeded, but was flaky

Test Failures

[job] [logs] Security Solution Tests / Detection rules, machine learning Creates and activates a new ml rule

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	547	549	+2

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`fleet`	1144	1143	-1

Async chunks

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

id	before	after	diff
`fleet`	643.4KB	643.5KB	+50.0B
`securitySolution`	4.6MB	4.6MB	-9.0B
total			+41.0B

Page load bundle

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

id	before	after	diff
`fleet`	108.0KB	109.1KB	+1.1KB

Unknown metric groups

API count

id	before	after	diff
`fleet`	1251	1255	+4

History

💔 Build elastic/beats#11809 failed 023af3e
💔 Build elastic/beats#11768 failed 9aa9a61
💔 Build elastic/beats#11729 failed 154322e
💔 Build elastic/beats#11676 failed 1c60944
💔 Build elastic/beats#11643 failed ad53433

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

cc @juliaElastic

* make apis consistent * UI and test fixes * test fixes * fixed test * fix tests * fix test * removed deprecated shared_id from openapi spec * added back list prop as deprecated * renamed apis with hyphens * openapi update * fix checks * fix test * renamed epm api path and response * fix tests * fix ml * moved splitPkgKey * fixed edit package policy page * fixed storybook * fix prettier after conflict * fix tests * fix tests * fix tests * fix test * fix test * added back semver validation * fix test * pkgVersion optional * fix tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

kibanamachine · 2021-12-08T12:07:38Z

💚 Backport successful

Status	Branch	Result
✅	8.0

This backport PR will be merged automatically after passing CI.

* [Fleet] Make API responses consistent (#119494) * make apis consistent * UI and test fixes * test fixes * fixed test * fix tests * fix test * removed deprecated shared_id from openapi spec * added back list prop as deprecated * renamed apis with hyphens * openapi update * fix checks * fix test * renamed epm api path and response * fix tests * fix ml * moved splitPkgKey * fixed edit package policy page * fixed storybook * fix prettier after conflict * fix tests * fix tests * fix tests * fix test * fix test * added back semver validation * fix test * pkgVersion optional * fix tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> * fixed tests Co-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com> Co-authored-by: Julia Bardi <julia.bardi@elastic.co>

* make apis consistent * UI and test fixes * test fixes * fixed test * fix tests * fix test * removed deprecated shared_id from openapi spec * added back list prop as deprecated * renamed apis with hyphens * openapi update * fix checks * fix test * renamed epm api path and response * fix tests * fix ml * moved splitPkgKey * fixed edit package policy page * fixed storybook * fix prettier after conflict * fix tests * fix tests * fix tests * fix test * fix test * added back semver validation * fix test * pkgVersion optional * fix tests Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

make apis consistent

36d275b

juliaElastic requested a review from a team as a code owner November 23, 2021 15:52

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Nov 23, 2021

juliaElastic self-assigned this Nov 23, 2021

juliaElastic added auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v8.0.0 v8.1.0 labels Nov 23, 2021

juliaElastic commented Nov 23, 2021

View reviewed changes

UI and test fixes

83275b3

test fixes

bc0662f

juliaElastic requested a review from a team as a code owner November 24, 2021 08:22

juliaElastic requested review from joeypoon and parkiino November 24, 2021 08:22

juliaElastic mentioned this pull request Mar 7, 2022

Accommodate enrollment-api-keys API change in kibana fleet API elastic/elastic-agent#111

Closed

juliaElastic added release_note:breaking and removed release_note:skip Skip the PR/issue when compiling release notes labels Nov 24, 2021

Merge branch 'main' into make-api-consistent

174476c

criamico approved these changes Nov 29, 2021

View reviewed changes

kibanamachine and others added 2 commits November 30, 2021 08:24

Merge branch 'main' into make-api-consistent

b0d66b8

fixed test

d04bbc9

juliaElastic and others added 5 commits December 6, 2021 13:27

fixed edit package policy page

be085f4

fixed storybook

62473c6

Merge branch 'main' into make-api-consistent

e73c8ce

fix prettier after conflict

127eeed

fix tests

877b040

juliaElastic mentioned this pull request Dec 6, 2021

[Fleet] Fix tests after changes in API elastic/e2e-testing#1877

Merged

8 tasks

juliaElastic added 3 commits December 6, 2021 16:51

fix tests

839d545

fix tests

d7930e7

fix test

ad53433

patrykkopycinski approved these changes Dec 7, 2021

View reviewed changes

juliaElastic added 4 commits December 7, 2021 11:12

fix test

1c60944

added back semver validation

154322e

fix test

9aa9a61

pkgVersion optional

023af3e

parkiino approved these changes Dec 7, 2021

View reviewed changes

juliaElastic removed the v8.0.0 label Dec 7, 2021

fix tests

d0d095d

juliaElastic added the v8.0.0 label Dec 8, 2021

juliaElastic merged commit b1a038d into elastic:main Dec 8, 2021

kibanamachine mentioned this pull request Dec 8, 2021

[8.0] [Fleet] Make API responses consistent (#119494) #120753

Merged

juliaElastic deleted the make-api-consistent branch December 8, 2021 12:12

juliaElastic mentioned this pull request Dec 9, 2021

[Fleet] Fix bug caused by API changes #120886

Merged

1 task

dedemorton mentioned this pull request Jan 10, 2022

[DOCS] Adds the 8.0.0-rc1 release notes #120806

Merged

jlind23 mentioned this pull request Mar 28, 2022

Change kibana api paths used in container command elastic/elastic-agent#253

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Make API responses consistent #119494

[Fleet] Make API responses consistent #119494

juliaElastic commented Nov 23, 2021 •

edited

Loading

elasticmachine commented Nov 23, 2021

juliaElastic Nov 23, 2021

nchaulet commented Nov 23, 2021

juliaElastic commented Nov 24, 2021

nchaulet commented Nov 24, 2021

juliaElastic commented Nov 24, 2021

criamico commented Nov 24, 2021

juliaElastic commented Nov 29, 2021

kibanamachine commented Nov 29, 2021

criamico left a comment

juliaElastic commented Nov 30, 2021

patrykkopycinski left a comment

kibana-ci commented Dec 8, 2021

API count

kibanamachine commented Dec 8, 2021

[Fleet] Make API responses consistent #119494

[Fleet] Make API responses consistent #119494

Conversation

juliaElastic commented Nov 23, 2021 • edited Loading

Summary

For maintainers

elasticmachine commented Nov 23, 2021

juliaElastic Nov 23, 2021

Choose a reason for hiding this comment

nchaulet commented Nov 23, 2021

juliaElastic commented Nov 24, 2021

nchaulet commented Nov 24, 2021

juliaElastic commented Nov 24, 2021

criamico commented Nov 24, 2021

juliaElastic commented Nov 29, 2021

kibanamachine commented Nov 29, 2021

criamico left a comment

Choose a reason for hiding this comment

juliaElastic commented Nov 30, 2021

patrykkopycinski left a comment

Choose a reason for hiding this comment

kibana-ci commented Dec 8, 2021

💛 Build succeeded, but was flaky

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

kibanamachine commented Dec 8, 2021

💚 Backport successful

juliaElastic commented Nov 23, 2021 •

edited

Loading