Repository navigation
fix(openapi): resolve redocly lint warnings - #25
Merged
Merged
Conversation
![redocly[bot]](https://avatars.githubusercontent.com/in/348054?s=60&v=4){kind=small}
There was a problem hiding this comment.
AI Review: 🟢 Completed
Redocly Agent has reviewed your changes and found 1 potential issue(s).
Note
Low Risk
Documentation and schema refinement only. Resolves Redocly CLI lint warnings without altering backend code or runtime endpoint behavior.
Overview
Addresses Redocly CLI lint rules (spec-ref-siblings, operation-4xx-response) across the OpenAPI 3.2 specification:
- Removes illegal sibling keywords next to parameter
$refentries, migrating examples into parameter components using OAS 3.2examples.<name>.dataValue. - Introduces a dedicated
OrderItemsFiltercomponent withrequired: trueforGET /order-items. - Simplifies single-element
allOfreferences inOrderandOrderItemschemas to direct$refwith sibling keywords. - Documents the
404response onGET /.well-known/oauth-authorization-server. - Adds
CHANGELOG.md, registers it insidebars.yaml, and bumps the API version to1.0.1.
Changed pages
* /openapi/cafe
+ /changelog (new)
⚙️ Configuration or theme changed
vadyvas
marked this pull request as draft
October 14, 2026 14:22
vadyvas
changed the title
vadyvas
requested review from
DmitryAnansky
and removed request for
RomanHotsiy
October 14, 2026 14:37
vadyvas
marked this pull request as ready for review
October 14, 2026 14:39
…r orders
Redocly CLI 2.60 validates Reference Objects per OAS 3.2: only `summary`
and `description` may sit next to `$ref`. Remove the `example` and
`required` siblings, keep the description overrides, and move examples
into the parameter components as `examples` + `dataValue`.
- replace `GET /order-items` (required `filter=orderId:…`) with
`GET /orders/{orderId}/items`, reusing the `OrderId` parameter
- add `examples` to every parameter, including a new one for `menuItemId`
- add a `404` response to the RFC 8414 metadata endpoint
(operation-4xx-response)
- flatten single-branch `allOf` in `Order.status` and `OrderItem.menuItem`
to `$ref` with sibling keywords (JSON Schema 2020-12)
Note: the live server does not serve `/orders/{orderId}/items` yet.
vadyvas
force-pushed
the
fix/redocly-lint-ref-siblings
branch
from
October 14, 2026 14:41
6edc71b to
83ce9fa
Compare
The release only fixes lint warnings and documents existing behavior, so it is a patch, not a minor bump. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
DmitryAnansky
approved these changes
Oct 14, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes the lint warnings that Redocly CLI 2.60 reports. It changes only the API description.
spec-ref-siblings: OpenAPI does not allowexampleorrequirednext to a$ref.exampleswithdataValue.GET /order-itemsgets its own required filter component,OrderItemsFilter.operation-4xx-response:GET /.well-known/oauth-authorization-serverdocuments a404response.Order.statusandOrderItem.menuItemuse$refwith sibling keywords instead of anallOfwith one item.The PR also adds a changelog page and sets the version to
1.0.1. No endpoint changes.Verification
npm run lintreports 0 problems withrecommendedand withrecommended-strict.