[OAS][DOCS] Edit linting rule severity#190470
Merged
lcawl merged 2 commits intoelastic:mainfrom Aug 14, 2024
Merged
Conversation
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
lcawl
added
Team:Docs
release_note:skip
Contributor
|
Pinging @elastic/kibana-docs (Team:Docs) |
lcawl
changed the title
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: |
Contributor
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
lcawl
added a commit
to lcawl/kibana
that referenced
this pull request
Aug 14, 2024
(cherry picked from commit 286e0e0)
Member
Author
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
lcawl
added a commit
that referenced
this pull request
Aug 15, 2024
# Backport This will backport the following commits from `main` to `8.15`: - [[OAS][DOCS] Edit linting rule severity (#190470)](#190470) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-08-14T15:15:29Z","message":"[OAS][DOCS] Edit linting rule severity (#190470)","sha":"286e0e0a9fffcb9b90d339551e67cdb1c5c60183","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":190470,"url":"https://github.com/elastic/kibana/pull/190470","mergeCommit":{"message":"[OAS][DOCS] Edit linting rule severity (#190470)","sha":"286e0e0a9fffcb9b90d339551e67cdb1c5c60183"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190470","number":190470,"mergeCommit":{"message":"[OAS][DOCS] Edit linting rule severity (#190470)","sha":"286e0e0a9fffcb9b90d339551e67cdb1c5c60183"}}]}] BACKPORT-->
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 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
Relates to #189962 (comment), which was reverted due to the following linting errors:
The severity level of the
operation-operationId-valid-in-urlrule was changed toerrorin #189262 but per #189962 (comment) and later comments, the URL-encoded operationId values work when we publish the docs, so I've turned off this linting rule.The
path-paramserror is related to optional path parameters, which we discussed in #189962 (comment) and later comments. Since it validates several aspects of path parameters per https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules#path-params, I've reduced its severity rather than turning it off. We can revisit that choice if it becomes too noisy.