New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[FLINK-31735][docs] Document 'plan' field as object #22357
Conversation
flink-runtime/src/main/java/org/apache/flink/runtime/rest/messages/job/JobDetailsInfo.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the open api spec, we have
RawJson:
type: object
is that actually correct? If I understand it correctly we should be able to pass anything in the rawjson, for example "string"
nvm, it's correct, it just doesn't align with the HTML docs |
Technically you are correct, but we only use RawJson for objects. Should this change the docs will be wrong again. There isn't much of a point in using this for other data types though, so I'm not worried. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍 Great stuff!
Fixes an issue where
plan
field of the JobDetailsInfo was documented as a string, when in fact we write the json plan as a raw object.