[OAS] Beautify generated operation ids #198132
Merged
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
jloleysens
added
Team:Core
Contributor
Author
|
/ci |
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
Contributor
Author
|
/ci |
Contributor
Author
|
/ci |
Contributor
|
Pinging @elastic/kibana-core (Team:Core) |
afharo
approved these changes
Oct 30, 2024
| .replace(/[\/]+$/, '') | ||
| .toLowerCase(); | ||
|
|
||
| const removePrefixes = ['internal/api/', 'internal/', 'api/']; // longest to shortest |
Member
There was a problem hiding this comment.
super-nit: this could be a constant outside the function.
Contributor
💛 Build succeeded, but was flaky
Failed CI StepsTest FailuresMetrics [docs]
History
|
Contributor
|
Starting backport for target branches: 8.16, 8.x https://github.com/elastic/kibana/actions/runs/11600057357 |
Contributor
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
lcawl
pushed a commit
to jloleysens/kibana
that referenced
this pull request
Oct 31, 2024
(cherry picked from commit e53d68c)
lcawl
pushed a commit
to jloleysens/kibana
that referenced
this pull request
Oct 31, 2024
(cherry picked from commit e53d68c) # Conflicts: # oas_docs/bundle.json # oas_docs/bundle.serverless.json # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # packages/kbn-router-to-openapispec/src/__snapshots__/generate_oas.test.ts.snap # packages/kbn-router-to-openapispec/src/process_versioned_router.test.ts
jloleysens
added a commit
that referenced
this pull request
Oct 31, 2024
# Backport This will backport the following commits from `main` to `8.x`: - [OAS] Beautify generated operation ids (#198132) (e53d68c) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Jean-Louis Leysens","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-30T19:11:24Z","message":"[OAS] Beautify generated operation ids (#198132)","sha":"e53d68c26d6c1f5330ee196938c650a786919a70"},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
jloleysens
added a commit
that referenced
this pull request
Oct 31, 2024
# Backport This will backport the following commits from `main` to `8.16`: - [OAS] Beautify generated operation ids (#198132) (e53d68c) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Jean-Louis Leysens","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-30T19:11:24Z","message":"[OAS] Beautify generated operation ids (#198132)","sha":"e53d68c26d6c1f5330ee196938c650a786919a70"},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: lcawl <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Summary
Updates the logic for extracting operation IDs to something more usable. Note: for now we do not consider
versionwhen generating these.Related https://github.com/elastic/docs-projects/issues/253
Notes
oas_docs/bundle.jsonfor new output