moved DELETE agent_config body to query params #200281
Conversation
There was a problem hiding this comment.
Thanks for troubleshooting the issue and changing it to query params. I saw this is recommended approach for sending params in DELETE requests.
You need to manually update API docs and regenerate bundles. See https://github.com/elastic/kibana/blob/main/x-pack/plugins/observability_solution/apm/docs/openapi/apm/paths/api%40apm%40settings%40agent_configuration.yaml
After you're done with bundling APM docs I'm not sure whether you need to build production docs or this is automated process. See https://github.com/elastic/kibana/blob/main/oas_docs/README.md
botelastic
bot
added
ci:project-deploy-observability
|
Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services) |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
| name: config.service.name, | ||
| environment: config.service.environment, | ||
| }, | ||
| query: { |
There was a problem hiding this comment.
@bryce-b this is a public API, I'm not sure if we can just change its signature. I think the APM agents team are the ones using it, have you checked with them?
There was a problem hiding this comment.
Would it be better if I create a new API instead? If they do indeed use it, there won't be a clean way to make this change and continue supporting old agents.
There was a problem hiding this comment.
I suggest keeping the same API but implementing both query and body parameters. With query params overwriting body. That way, we stay backward compatible and can provide a working API for public (we might document only query parameters for simplicity). What do you think? @bryce-b @cauemarcondes
There was a problem hiding this comment.
We have found the root cause of this problem. Lets close this PR, please.
reverted test changes, added additionl spec test
💔 Build Failed
Failed CI StepsHistory
|
|
Root cause of this issue described here : #200722 |
Summary
Resolved #198019. It's unclear why exactly this error was occurring to begin with, I didn't have luck with refactoring the ts-io parameters using
bodyso I opted to move them to the query list.I wasn't sure if the query parameters needed to be listed individually, or if I could re-use the
serviceRttype.Additionally, does the date on the API need to be updated?
Does this count as a breaking change?
Checklist
Check the PR satisfies following conditions.
Reviewers should verify this PR satisfies this list as well.
release_note:breakinglabel should be applied in these situations.release_node:*label is applied per the guidelines