Skip to content
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

Merged
merged 5 commits into from Apr 6, 2023
Merged

Conversation

zentol
Copy link
Contributor

@zentol zentol commented Apr 5, 2023

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.

@zentol zentol requested a review from dmvk April 5, 2023 13:54
@flinkbot
Copy link
Collaborator

flinkbot commented Apr 5, 2023

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Member

@dmvk dmvk left a 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"

@dmvk
Copy link
Member

dmvk commented Apr 6, 2023

nvm, it's correct, it just doesn't align with the HTML docs

@zentol
Copy link
Contributor Author

zentol commented Apr 6, 2023

If I understand it correctly we should be able to pass anything in the rawjson, for example "string"

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.

Copy link
Member

@dmvk dmvk left a comment

Choose a reason for hiding this comment

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

LGTM 👍 Great stuff!

@zentol zentol merged commit 8ee6653 into apache:master Apr 6, 2023
@zentol zentol deleted the 31735 branch April 6, 2023 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants