Skip to content

[Deprecations/Docs] Address uncommented apis#204198

Merged
afharo merged 4 commits intoelastic:mainfrom
afharo:docs/address-uncommented-apis
Dec 16, 2024
Merged

[Deprecations/Docs] Address uncommented apis#204198
afharo merged 4 commits intoelastic:mainfrom
afharo:docs/address-uncommented-apis

Conversation

@afharo
Copy link
Copy Markdown
Member

@afharo afharo commented Dec 13, 2024 •
edited by kibanamachine
Loading

Summary

#203042 highlighted these APIs not having comments.

Checklist

  • Documentation was added for features that require explanation or tutorials

@afharo afharo requested a review from a team as a code owner December 13, 2024 12:05
@afharo afharo added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes backport:prev-minor labels Dec 13, 2024
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Dec 13, 2024

Pinging @elastic/kibana-core (Team:Core)

@afharo afharo self-assigned this Dec 13, 2024
TinaHeiligers
TinaHeiligers approved these changes Dec 16, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@TinaHeiligers TinaHeiligers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@afharo afharo enabled auto-merge (squash) December 16, 2024 10:16
@afharo afharo merged commit 25b171d into elastic:main Dec 16, 2024
@afharo afharo deleted the docs/address-uncommented-apis branch December 16, 2024 12:13
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Dec 16, 2024

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12352390897

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Dec 16, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #36 / Serverless Observability - Deployment-agnostic API integration tests SyntheticsAPITests getSyntheticsMonitors get one monitor should get by id

Metrics [docs]

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
@kbn/core-deprecations-server 13 0 -13
@kbn/core-deprecations-server-internal 3 0 -3
total -16

History

cc @afharo

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 16, 2024
@afharo
[Deprecations/Docs] Address uncommented apis (elastic#204198)
8e04723 
## Summary

elastic#203042 highlighted these APIs not having comments.

### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

(cherry picked from commit 25b171d)
@kibanamachine kibanamachine mentioned this pull request Dec 16, 2024
Merged
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Dec 16, 2024

💚 All backports created successfully

Status Branch Result
✅ 8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Dec 16, 2024
@kibanamachine @afharo
[8.x] [Deprecations/Docs] Address uncommented apis (#204198) (#204375)
a7ce45a 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Deprecations/Docs] Address uncommented apis
(#204198)](#204198)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Alejandro Fernández
Haro","email":"alejandro.haro@elastic.co"},"sourceCommit":{"committedDate":"2024-12-16T12:13:16Z","message":"[Deprecations/Docs]
Address uncommented apis (#204198)\n\n## Summary\n\n#203042 highlighted
these APIs not having comments.\n\n\n### Checklist\n\n\n-
[x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas
added for features that require explanation or
tutorials","sha":"25b171d6d718cee74116c4f3e1169dac12ad9404","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","v9.0.0","backport:prev-minor"],"title":"[Deprecations/Docs]
Address uncommented
apis","number":204198,"url":"https://github.com/elastic/kibana/pull/204198","mergeCommit":{"message":"[Deprecations/Docs]
Address uncommented apis (#204198)\n\n## Summary\n\n#203042 highlighted
these APIs not having comments.\n\n\n### Checklist\n\n\n-
[x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas
added for features that require explanation or
tutorials","sha":"25b171d6d718cee74116c4f3e1169dac12ad9404"}},"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/204198","number":204198,"mergeCommit":{"message":"[Deprecations/Docs]
Address uncommented apis (#204198)\n\n## Summary\n\n#203042 highlighted
these APIs not having comments.\n\n\n### Checklist\n\n\n-
[x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas
added for features that require explanation or
tutorials","sha":"25b171d6d718cee74116c4f3e1169dac12ad9404"}}]}]
BACKPORT-->

Co-authored-by: Alejandro Fernández Haro <alejandro.haro@elastic.co>
JoseLuisGJ pushed a commit to JoseLuisGJ/kibana that referenced this pull request Dec 19, 2024
@afharo @JoseLuisGJ
[Deprecations/Docs] Address uncommented apis (elastic#204198)
89fe9b0 
## Summary

elastic#203042 highlighted these APIs not having comments.


### Checklist


- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TinaHeiligers TinaHeiligers TinaHeiligers approved these changes

Assignees

@afharo afharo

Labels

release_note:skip Skip the PR/issue when compiling release notes Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v8.18.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@afharo @elasticmachine @kibanamachine @TinaHeiligers