Adds 'discontinued' to OAS meta #192331
Merged
Adds 'discontinued' to OAS meta #192331
Conversation
This file contains 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
TinaHeiligers
added
Feature:http
Team:Core
|
@elasticmachine merge upstream |
TinaHeiligers
commented
Sep 9, 2024
packages/kbn-router-to-openapispec/src/process_versioned_router.ts
Outdated
Show resolved
Hide resolved
TinaHeiligers
commented
Sep 9, 2024
...to-openapispec/src/oas_converter/kbn_config_schema/post_process_mutations/mutations/utils.ts
Outdated
Show resolved
Hide resolved
jloleysens
reviewed
Sep 10, 2024
...to-openapispec/src/oas_converter/kbn_config_schema/post_process_mutations/mutations/utils.ts
Outdated
Show resolved
Hide resolved
…g_schema/post_process_mutations/mutations/utils.ts fix discontinued value Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
|
@elasticmachine merge upstream |
|
Pinging @elastic/kibana-core (Team:Core) |
Ikuni17
approved these changes
Sep 10, 2024
TinaHeiligers
added
the
release_note:skip
|
@elasticmachine merge upstream |
TinaHeiligers
commented
Sep 11, 2024
packages/kbn-router-to-openapispec/src/__snapshots__/generate_oas.test.ts.snap
Outdated
Show resolved
Hide resolved
...to-openapispec/src/oas_converter/kbn_config_schema/post_process_mutations/mutations/utils.ts
Outdated
Show resolved
Hide resolved
|
@elasticmachine merge upstream |
jloleysens
approved these changes
Sep 12, 2024
There was a problem hiding this comment.
Great job @TinaHeiligers , left a few nits up to you, otherwise looks good to go!
| * | ||
| * @remarks This will be surfaced in OAS documentation. | ||
| */ | ||
| 'x-discontinued'?: string; |
There was a problem hiding this comment.
Nit: What do you think about defining route definitions and kbn/config-schema meta as { discontinued: '...' } instead of { 'x-discontinued': '...' }. Just saves a few keystrokes and slightly awkward string syntax 'my-field-name'. Then when we render it out we just map it to x-discontinued.
There was a problem hiding this comment.
I prefer consistency with the final output but can add a brief explanation to the field's description.
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
💚 Build Succeeded
Metrics [docs]Unknown metric groupsAPI count
ESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: |
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
TinaHeiligers
added
backport:prev-minor
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Sep 13, 2024
## Summary In this PR, we add support for a discontinued field to our router conversion logic at the operation level. `discontinued` indicates the version or date when the deprecation will be removed, as a string. Closes elastic#192292 --------- Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com> (cherry picked from commit 303d8f2)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Sep 13, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [Adds 'discontinued' to OAS meta (#192331)](#192331) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Christiane (Tina) Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2024-09-13T00:06:41Z","message":"Adds 'discontinued' to OAS meta (#192331)\n\n## Summary\r\n\r\nIn this PR, we add support for a discontinued field to our router\r\nconversion logic at the operation level. `discontinued` indicates the\r\nversion or date when the deprecation will be removed, as a string.\r\n\r\nCloses https://github.com/elastic/kibana/issues/192292\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>\r\nCo-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>","sha":"303d8f27e4c8cdfd541e7e6b27548cbffaf454fd","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:http","Team:Core","release_note:skip","v9.0.0","Feature:OAS","v8.16.0"],"title":"Adds 'discontinued' to OAS meta","number":192331,"url":"https://github.com/elastic/kibana/pull/192331","mergeCommit":{"message":"Adds 'discontinued' to OAS meta (#192331)\n\n## Summary\r\n\r\nIn this PR, we add support for a discontinued field to our router\r\nconversion logic at the operation level. `discontinued` indicates the\r\nversion or date when the deprecation will be removed, as a string.\r\n\r\nCloses https://github.com/elastic/kibana/issues/192292\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>\r\nCo-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>","sha":"303d8f27e4c8cdfd541e7e6b27548cbffaf454fd"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192331","number":192331,"mergeCommit":{"message":"Adds 'discontinued' to OAS meta (#192331)\n\n## Summary\r\n\r\nIn this PR, we add support for a discontinued field to our router\r\nconversion logic at the operation level. `discontinued` indicates the\r\nversion or date when the deprecation will be removed, as a string.\r\n\r\nCloses https://github.com/elastic/kibana/issues/192292\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>\r\nCo-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>","sha":"303d8f27e4c8cdfd541e7e6b27548cbffaf454fd"}},{"branch":"8.x","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
In this PR, we add support for a discontinued field to our router conversion logic at the operation level.
discontinuedindicates the version or date when the deprecation will be removed, as a string.Closes #192292