github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.11] [HTTP] versionResolution doc comment with information about internal routes (#171971) (#172250)

Browse source 
# Backport

This will backport the following commits from `main` to `8.11`:
- [[HTTP] `versionResolution` doc comment with information about
internal routes
(#171971)](https://github.com/elastic/kibana/pull/171971)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Jean-Louis
Leysens","email":"jeanlouis.leysens@elastic.co"},"sourceCommit":{"committedDate":"2023-11-30T06:39:32Z","message":"[HTTP]
`versionResolution` doc comment with information about internal routes
(#171971)","sha":"df6e8ddaed3d32207d9e4ce7c3d0d961428b60a3","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:http","Team:Core","release_note:skip","v8.1.3","v8.12.0"],"number":171971,"url":"https://github.com/elastic/kibana/pull/171971","mergeCommit":{"message":"[HTTP]
`versionResolution` doc comment with information about internal routes
(#171971)","sha":"df6e8ddaed3d32207d9e4ce7c3d0d961428b60a3"}},"sourceBranch":"main","suggestedTargetBranches":["8.1"],"targetPullRequestStates":[{"branch":"8.1","label":"v8.1.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/171971","number":171971,"mergeCommit":{"message":"[HTTP]
`versionResolution` doc comment with information about internal routes
(#171971)","sha":"df6e8ddaed3d32207d9e4ce7c3d0d961428b60a3"}}]}]
BACKPORT-->

Co-authored-by: Jean-Louis Leysens <jeanlouis.leysens@elastic.co>
This commit is contained in:
Kibana Machine 2023-11-30 02:50:03 -05:00 • committed by GitHub
parent e5a6958001
commit 0e1d6924d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
packages/core/http/core-http-server-internal/src/http_config.ts
View file

@ -174,9 +174,10 @@ const configSchema = schema.object(
versioned: schema.object({
/**
* Which handler resolution algo to use: "newest" or "oldest".
* Which handler resolution algo to use for public routes: "newest" or "oldest".
*
* @note in development we have an additional option "none" which is also the default.
* @note Internal routes always require a version to be specified.
* @note in development we have an additional option "none" which is also the default in dev.
* This prevents any fallbacks and requires that a version specified.
* Useful for ensuring that a given client always specifies a version.
*/