Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Oct 23, 2025

Release notes

[rn:skip]

What does this PR do?

Fixes the following linting error returned from redocly lint logstash-api.yaml --config redocly.yaml:

[1] logstash-api.yaml:2357:27 at #/components/schemas/PipelineQueueStats/properties/queue/oneOf/0/properties/compression/properties/encode/properties/goal

Expected type `Schema` (object) but got `array`

2355 | properties:
2356 |   goal:
2357 |     - enum:
2358 |         - speed
   … |         < 2 more lines >
2361 |   ratio:
2362 |     type: object
2363 |     description: the ratio of event size in bytes to its representation on disk

Error was generated by the struct rule.

The goal property was missing a type.

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

It caused the following error when we uploaded the OpenAPI docs:

04:23:22 PM A JSON schema MUST be of type 'object'. Provided type 'Array' is not valid, we had to ignore this schema.

Thus it seems to have made the OpenAPI document invalid or incomplete.

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

Rerunning redocly lint logstash-api.yaml --config redocly.yaml confirms that the error no longer exists.

Related issues

Use cases

N/A

Screenshots

N/A

Logs

N/A

@lcawl lcawl requested a review from yaauie October 23, 2025 16:57
@lcawl lcawl added docs backport-9.2 Automated backport to the 9.2 branch labels Oct 23, 2025
@lcawl lcawl requested a review from karenzone October 23, 2025 16:57
@github-actions
Copy link
Contributor

🤖 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!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-9.2 Automated backport to the 9.2 branch docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant