Fix Typos and Update Comments #787
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tobio
reviewed
Sep 24, 2024
There was a problem hiding this comment.
What's actually returned by the API. Is this a spec issue or does the spec correctly represent a typo in the API?
There was a problem hiding this comment.
I just assumed this was a typo since the other options all return success
Co-authored-by: Toby Brain <[email protected]>
Co-authored-by: Toby Brain <[email protected]>
Co-authored-by: Toby Brain <[email protected]>
Co-authored-by: Toby Brain <[email protected]>
10 tasks
tobio
added a commit
to elastic/kibana
that referenced
this pull request
Sep 26, 2024
## Summary The API [model](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L48) (points [here](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40-L42)) doesn't actually define this field and it's not returned by the server. Related to elastic/terraform-provider-elasticstack#787 (comment) ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]>
kibanamachine
added a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 30, 2024
## Summary The API [model](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L48) (points [here](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40-L42)) doesn't actually define this field and it's not returned by the server. Related to elastic/terraform-provider-elasticstack#787 (comment) ### Checklist Delete any items that are not applicable to this PR. - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [x] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [x] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit be9dd06)
kibanamachine
added a commit
to elastic/kibana
that referenced
this pull request
Sep 30, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [Remove unused field (#194084)](#194084) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Toby Brain","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-26T11:05:44Z","message":"Remove unused field (#194084)\n\n## Summary\n\nThe API\n[model](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L48)\n(points\n[here](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40-L42))\ndoesn't actually define this field and it's not returned by the server.\n\nRelated to\nhttps://github.com/elastic/terraform-provider-elasticstack/pull/787#discussion_r1772562187\n\n\n### Checklist\n\nDelete any items that are not applicable to this PR.\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] Any UI touched in this PR is usable by keyboard only (learn more\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\n- [x] Any UI touched in this PR does not create any new axe failures\n(run axe in browser:\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\n- [x] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This renders correctly on smaller devices using a responsive\nlayout. (You can test this [in your\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\n- [x] This was checked for [cross-browser\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\n\n### For maintainers\n\n- [ ] This was checked for breaking API changes and was [labeled\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"be9dd06f7483a9972f60eea41fd4f00511c864fa","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["v9.0.0","backport:prev-minor"],"title":"Remove unused field","number":194084,"url":"https://github.com/elastic/kibana/pull/194084","mergeCommit":{"message":"Remove unused field (#194084)\n\n## Summary\n\nThe API\n[model](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L48)\n(points\n[here](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40-L42))\ndoesn't actually define this field and it's not returned by the server.\n\nRelated to\nhttps://github.com/elastic/terraform-provider-elasticstack/pull/787#discussion_r1772562187\n\n\n### Checklist\n\nDelete any items that are not applicable to this PR.\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] Any UI touched in this PR is usable by keyboard only (learn more\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\n- [x] Any UI touched in this PR does not create any new axe failures\n(run axe in browser:\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\n- [x] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This renders correctly on smaller devices using a responsive\nlayout. (You can test this [in your\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\n- [x] This was checked for [cross-browser\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\n\n### For maintainers\n\n- [ ] This was checked for breaking API changes and was [labeled\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"be9dd06f7483a9972f60eea41fd4f00511c864fa"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/194084","number":194084,"mergeCommit":{"message":"Remove unused field (#194084)\n\n## Summary\n\nThe API\n[model](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L48)\n(points\n[here](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40-L42))\ndoesn't actually define this field and it's not returned by the server.\n\nRelated to\nhttps://github.com/elastic/terraform-provider-elasticstack/pull/787#discussion_r1772562187\n\n\n### Checklist\n\nDelete any items that are not applicable to this PR.\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] [Flaky Test\nRunner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was\nused on any tests changed\n- [x] Any UI touched in this PR is usable by keyboard only (learn more\nabout [keyboard accessibility](https://webaim.org/techniques/keyboard/))\n- [x] Any UI touched in this PR does not create any new axe failures\n(run axe in browser:\n[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),\n[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))\n- [x] If a plugin configuration key changed, check if it needs to be\nallowlisted in the cloud and added to the [docker\nlist](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)\n- [x] This renders correctly on smaller devices using a responsive\nlayout. (You can test this [in your\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\n- [x] This was checked for [cross-browser\ncompatibility](https://www.elastic.co/support/matrix#matrix_browsers)\n\n### For maintainers\n\n- [ ] This was checked for breaking API changes and was [labeled\nappropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"be9dd06f7483a9972f60eea41fd4f00511c864fa"}}]}] BACKPORT--> Co-authored-by: Toby Brain <[email protected]>
tobio
reviewed
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What and Why