[Fleet] Add meta:{id} to fleet schemas#270560
Conversation
|
Pinging @elastic/fleet (Team:Fleet) |
vishaangelova
left a comment
There was a problem hiding this comment.
LGTM from a docs perspective
(Leaving a couple of suggestions to improve some of the description fields. Please ignore if fixing these is out of scope of this PR.)
jloleysens
left a comment
There was a problem hiding this comment.
Nice work @criamico ! Approving to unblock progress.
Would you mind trying to preview the new OAS on bump.sh before merging? From root you should be able to run make -C oas_docs api-docs-preview.
There was a problem hiding this comment.
Note: changed due to added meta. Not due to runtime/behavioural changes.
There was a problem hiding this comment.
so I guess I can ignore these failure safely?
|
@jloleysens I generated the preview:
|
|
Nice! Does it look as expected? |
It looks ok to me and I can see the new descriptions added. I'm not sure if the The other thing is that the original ticket said:
@jloleysens Can you help me to verify the current changes on this pipeline? I don't know if it's automatically triggered. |
|
@elasticmachine merge upstream |
Saved Objects CI check failed4 issue(s) across 1 type(s). General
Run locallySee the Saved Objects troubleshooting guide and the model versions documentation for details. |
💔 Build Failed
Failed CI Steps
Test Failures
Metrics [docs]
History
cc @criamico |
There was a problem hiding this comment.
CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
|
Starting backport for target branches: 9.4 https://github.com/elastic/kibana/actions/runs/26500455879 |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
Fixes elastic#261258 possibly also elastic#264565 (to be verified) ## Summary Add `meta: { id }` to Fleet body/response schemas Files changed: - `server/types/models/agent_policy.ts` — versioned policy schemas (v3–v6), `new_agent_policy`, `agent_policy`, `agent_policy_response`, `full_agent_policy`, outputs responses - `server/types/rest_spec/agent_policy.ts` — bulk get, copy, delete, full policy, K8s manifest, list outputs, cleanup task request/response schemas - `server/types/models/enrollment_api_key.ts `— `enrollment_api_key` - `server/types/rest_spec/enrollment_api_key.ts` — enrollment key CRUD and bulk delete schemas - `common/types/models/package_policy_schema.ts `— all package policy schemas: new, versioned (v22–v24), simplified, update, response, dry-run, status - `server/types/rest_spec/package_policy.ts` — bulk get, create, delete, upgrade, dry-run schemas - `server/types/rest_spec/epm.ts `— ~40 package management schemas (categories, package info/list/stats, install/delete/bulk operations, etc.) - `server/types/rest_spec/agent.ts` — `action_id_response` / `action_message_response` branches of `ActionIdOrMessageSchema` (resolves items #1 and #2 of elastic#264565) ### Testing Verified locally with: ``` node scripts/capture_oas_snapshot --no-serverless --include-path /api/fleet node scripts/validate_oas_docs node scripts/check_api_contracts --distribution stack ``` It looks like there are no Fleet errors left after this change but the final verification step will be ran in the ci for Terraform --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
|
Friendly reminder: Looks like this PR hasn’t been backported yet. |
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
|
Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync. |
Fixes #261258
possibly also #264565 (to be verified)
Summary
Add
meta: { id }to Fleet body/response schemasFiles changed:
server/types/models/agent_policy.ts— versioned policy schemas (v3–v6),new_agent_policy,agent_policy,agent_policy_response,full_agent_policy, outputs responsesserver/types/rest_spec/agent_policy.ts— bulk get, copy, delete, full policy, K8s manifest, list outputs, cleanup task request/response schemasserver/types/models/enrollment_api_key.ts—enrollment_api_keyserver/types/rest_spec/enrollment_api_key.ts— enrollment key CRUD and bulk delete schemascommon/types/models/package_policy_schema.ts— all package policy schemas: new, versioned (v22–v24), simplified, update, response, dry-run, statusserver/types/rest_spec/package_policy.ts— bulk get, create, delete, upgrade, dry-run schemasserver/types/rest_spec/epm.ts— ~40 package management schemas (categories, package info/list/stats, install/delete/bulk operations, etc.)server/types/rest_spec/agent.ts—action_id_response/action_message_responsebranches ofActionIdOrMessageSchema(resolves items links to styles and js #1 and Change of links to styles and js #2 of [OAS Validation] Fix structural schema issues in Fleet APIs #264565)Testing
Verified locally with:
It looks like there are no Fleet errors left after this change but the final verification step will be ran in the ci for Terraform