mirror of
https://github.com/elastic/kibana.git
synced 2025-04-22 08:49:27 -04:00
41a7e61855
# Backport This will backport the following commits from `main` to `8.16`: - [[OpenAPI] Add redocly lint configuration (#199360)](https://github.com/elastic/kibana/pull/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":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T20:07:55Z","message":"[OpenAPI] Add redocly lint configuration (#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 (#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 (#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 https://github.com/elastic/kibana/pull/199571 is merged.
52 lines
No EOL
1.2 KiB
YAML
52 lines
No EOL
1.2 KiB
YAML
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 |