forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[8.16] [OpenAPI] Add redocly lint configuration (elastic#199360) (ela…
…stic#199555) # Backport This will backport the following commits from `main` to `8.16`: - [[OpenAPI] Add redocly lint configuration (elastic#199360)](elastic#199360) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-11-08T20:07:55Z","message":"[OpenAPI] Add redocly lint configuration (elastic#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Feature:OAS","v8.16.0","backport:version","v8.17.0"],"number":199360,"url":"https://github.com/elastic/kibana/pull/199360","mergeCommit":{"message":"[OpenAPI] Add redocly lint configuration (elastic#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199360","number":199360,"mergeCommit":{"message":"[OpenAPI] Add redocly lint configuration (elastic#199360)","sha":"907d19b7b82598ab070901f772323b71b583bc65"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> NOTE: I've also removed the serverless commands from the makefile, since they're not relevant to this branch. This PR will encounter CI failures until elastic#199571 is merged.
- Loading branch information
Showing
4 changed files
with
59 additions
and
29 deletions.
There are no files selected for viewing
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
File renamed without changes.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| extends: | ||
| - recommended | ||
| rules: | ||
| # Built-in rules | ||
| # Descriptions | ||
| parameter-description: warn | ||
| tag-description: warn | ||
| operation-description: off | ||
| # Document info | ||
| info-contact: warn | ||
| info-license: warn | ||
| # Examples | ||
| no-invalid-media-type-examples: | ||
| severity: warn | ||
| allowAdditionalProperties: false | ||
| no-invalid-schema-examples: | ||
| severity: warn | ||
| allowAdditionalProperties: false | ||
| # Operations | ||
| operation-operationId: error | ||
| operation-operationId-unique: error | ||
| operation-operationId-url-safe: warn | ||
| operation-summary: warn | ||
| # Parameters | ||
| path-parameters-defined: warn | ||
| # Paths | ||
| no-ambiguous-paths: warn | ||
| no-identical-paths: error | ||
| path-excludes-patterns: | ||
| severity: error | ||
| patterns: | ||
| - ^\/internal | ||
| # Responses | ||
| operation-4xx-response: off | ||
| operation-2xx-response: off | ||
| # Schema | ||
| spec: off | ||
| spec-strict-refs: off | ||
| # Tags | ||
| operation-tag-defined: off | ||
| tags-alphabetical: off | ||
| operation-singular-tag: off | ||
| # Custom rules | ||
| rule/operation-summary-length: | ||
| subject: | ||
| type: Operation | ||
| property: summary | ||
| message: Operation summary must have a minimum of 5 and maximum of 45 characters | ||
| severity: warn | ||
| assertions: | ||
| maxLength: 45 | ||
| minLength: 5 |
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