Skip to content

Commit dcb9649

Browse files
mergify[bot]lcawl
andauthored
[DOCS] Fix nullable type linting error in OpenAPI document (#18018) (#18021)
(cherry picked from commit 34a7c67) Co-authored-by: Lisa Cawley <lcawley@elastic.co>
1 parent 31f762a commit dcb9649

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

docs/static/spec/openapi/logstash-api.yaml

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1702,11 +1702,9 @@ components:
17021702
type: string
17031703
description: A unique identifier for the ephemeral session of the Logstash instance.
17041704
snapshot:
1705-
type: boolean
1706-
nullable: true
1705+
type: [boolean, 'null']
17071706
status:
17081707
$ref: '#/components/schemas/Status'
1709-
17101708
PipelineSettings:
17111709
type: object
17121710
properties:
@@ -2217,19 +2215,16 @@ components:
22172215
type: object
22182216
properties:
22192217
last_error:
2220-
type: string
2221-
nullable: true
2218+
type: [ string, 'null']
22222219
successes:
22232220
type: integer
22242221
format: int64
22252222
last_success_timestamp:
2226-
type: string
2223+
type: [ string, 'null']
22272224
format: date-time
2228-
nullable: true
22292225
last_failure_timestamp:
2230-
type: string
2226+
type: [ string, 'null']
22312227
format: date-time
2232-
nullable: true
22332228
failures:
22342229
type: integer
22352230
format: int64

docs/static/spec/openapi/redocly.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,10 @@ rules:
2626
# Paths
2727
no-ambiguous-paths: warn
2828
no-identical-paths: error
29-
path-excludes-patterns:
30-
severity: error
31-
patterns:
32-
- ^\/internal
3329
# Responses
3430
operation-4xx-response: off
3531
operation-2xx-response: off
3632
# Schema
37-
spec: off
3833
spec-strict-refs: off
3934
# Tags
4035
operation-tag-defined: off
@@ -49,4 +44,11 @@ rules:
4944
severity: warn
5045
assertions:
5146
maxLength: 45
52-
minLength: 5
47+
minLength: 5
48+
rule/path-exclude-pattern:
49+
subject:
50+
type: Paths
51+
message: Do not include internal APIs
52+
assertions:
53+
notPattern: ^\/internal
54+
severity: error

0 commit comments

Comments
 (0)