[DOCS] Fix nullable type linting error in OpenAPI document

[lcawl]

Release notes

[rn:skip]

What does this PR do?

This PR addresses the following linting errors reported

[1] redocly.yaml:29:3 at #/rules/path-excludes-patterns

Property `path-excludes-patterns` is not expected here.

27 | no-ambiguous-paths: warn
28 | no-identical-paths: error
29 | path-excludes-patterns:
30 |   severity: error
31 |   patterns:

Warning was generated by the configuration struct rule.

[2] redocly.yaml:37:3 at #/rules/spec

Property `spec` is not expected here.

35 |  operation-2xx-response: off
36 | # Schema
37 |  spec: off
38 |  spec-strict-refs: off
39 | # Tags

Warning was generated by the configuration struct rule.

...

[2] logstash-api.yaml:2267:15 at #/components/schemas/PipelineReloadStats/properties/reloads/properties/last_error/nullable

Property `nullable` is not expected here.

2265 | last_error:
2266 |   type: string
2267 |   nullable: true
2268 | successes:
2269 |   type: integer

Error was generated by the struct rule.

Why is it important/What is the impact to the user?

The redocly linter's behaviour changed per https://redocly.com/docs/cli/guides/migrate-to-v2 thus the configuration needed to be updated.

nullable: true is the format for OpenAPI 3.0 and that also changed in 3.1 so updates were required in that formatting too.

Checklist

• My code follows the style guidelines of this project
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have made corresponding change to the default configuration files (and/or docker env variables)
• I have added tests that prove my fix is effective or that my feature works

Author's Checklist

N/A

How to test this PR locally

redocly lint logstash-api.yaml --config redocly.yaml

Related issues

N/A

Use cases

N/A

Screenshots

N/A

Logs

N/A

[github-actions]

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

• run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

[karenzone]

LGTM. Thank you!

[github-actions]

@Mergifyio backport 9.0 9.1

[mergify]

backport 9.0 9.1

✅ Backports have been created

• #18020 [9.0] (backport #18018) [DOCS] Fix nullable type linting error in OpenAPI document has been created for branch 9.0 but encountered conflicts
• #18021 [9.1] (backport #18018) [DOCS] Fix nullable type linting error in OpenAPI document has been created for branch 9.1