Skip to content

[CELEBORN-2404] Fix required field typo in SendWorkerEventRequest schema - #3783

Merged
zaynt4606 merged 2 commits into
apache:mainfrom
yew1eb:fix-send-worker-event-request-required
Aug 6, 2026
Merged

[CELEBORN-2404] Fix required field typo in SendWorkerEventRequest schema#3783
zaynt4606 merged 2 commits into
apache:mainfrom
yew1eb:fix-send-worker-event-request-required

Conversation

@yew1eb

@yew1eb yew1eb commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Fix a typo in master_rest_v1.yaml: the SendWorkerEventRequest schema declared worker in its required list, but the actual property name is workers.

Why are the changes needed?

The openapi-generator silently ignores the non-existent worker field, so the generated client compiles fine, but the spec declares a required field that does not exist and Swagger UI misleadingly shows worker as required. The server side validates request.getWorkers.isEmpty, consistent with the workers property.

Does this PR resolve a correctness bug?

  • Yes

Does this PR introduce any user-facing change?

  • Yes

How was this patch tested?

  • Regenerated the openapi client (./build/mvn clean generate-sources -pl openapi/openapi-client): no diff in generated code, as the generator does not emit anything for required.
  • The module builds successfully, which also validates the YAML syntax.

@SteNicholas SteNicholas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yew1eb, please fix the failure of openapi-codegen-check.

@yew1eb

yew1eb commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

@yew1eb, please fix the failure of openapi-codegen-check.

@SteNicholas Fixed.

@zaynt4606 zaynt4606 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@zaynt4606
zaynt4606 merged commit cb58033 into apache:main Aug 6, 2026
108 checks passed
@cxzl25

cxzl25 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

@zaynt4606 We need to use dev/merge_pr.py to merge PR.

SteNicholas pushed a commit that referenced this pull request Aug 6, 2026
### What changes were proposed in this pull request?

Fix a typo in `master_rest_v1.yaml`: the `SendWorkerEventRequest` schema declared `worker` in its `required` list, but the actual property name is `workers`.

### Why are the changes needed?

The openapi-generator silently ignores the non-existent `worker` field, so the generated client compiles fine, but the spec declares a required field that does not exist and Swagger UI misleadingly shows `worker` as required. The server side validates `request.getWorkers.isEmpty`, consistent with the `workers` property.

### Does this PR resolve a correctness bug?

- [ ] Yes

### Does this PR introduce _any_ user-facing change?

- [ ] Yes

### How was this patch tested?

- Regenerated the openapi client (`./build/mvn clean generate-sources -pl openapi/openapi-client`): no diff in generated code, as the generator does not emit anything for `required`.
- The module builds successfully, which also validates the YAML syntax.

Closes #3783 from yew1eb/fix-send-worker-event-request-required.

Authored-by: yew1eb <yew1eb@gmail.com>
Signed-off-by: Nicholas Jiang <programgeek@163.com>
SteNicholas pushed a commit that referenced this pull request Aug 6, 2026
### What changes were proposed in this pull request?

Fix a typo in `master_rest_v1.yaml`: the `SendWorkerEventRequest` schema declared `worker` in its `required` list, but the actual property name is `workers`.

### Why are the changes needed?

The openapi-generator silently ignores the non-existent `worker` field, so the generated client compiles fine, but the spec declares a required field that does not exist and Swagger UI misleadingly shows `worker` as required. The server side validates `request.getWorkers.isEmpty`, consistent with the `workers` property.

### Does this PR resolve a correctness bug?

- [ ] Yes

### Does this PR introduce _any_ user-facing change?

- [ ] Yes

### How was this patch tested?

- Regenerated the openapi client (`./build/mvn clean generate-sources -pl openapi/openapi-client`): no diff in generated code, as the generator does not emit anything for `required`.
- The module builds successfully, which also validates the YAML syntax.

Closes #3783 from yew1eb/fix-send-worker-event-request-required.

Authored-by: yew1eb <yew1eb@gmail.com>
Signed-off-by: Nicholas Jiang <programgeek@163.com>
(cherry picked from commit c0cad19)
Signed-off-by: Nicholas Jiang <programgeek@163.com>
@SteNicholas

SteNicholas commented Aug 6, 2026

Copy link
Copy Markdown
Member

Thanks. Merged to main(v1.0.0) and branch-0.7(v0.7.0).
@cxzl25, I have used dev/merge_pr.py to merge.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants