restatedev
Schemars of enum variants is not really helpful
Looking at our configuration specification, schemars does not generate helpful output when it comes to specifying the different variants. For example, it is not clear from this description that one needs to put type = "replicated" in order to select the replicated metadata client.
As reported by a community member (https://discord.com/channels/1128210118216007792/1434972333122261003/1434972333122261003):
Another example are https://docs.restate.dev/references/server-config#param-on-max-attempts where the docs don't show the values one can select.
The item just above it on max-attempts has an additional issue, that it appears to take an object containing the key Bounded, like
{ Bounded: 5 }. But in actuality this Rust enum is using serde untagged mode and so the correct configuration method is just to pass a number.
Finally, there seem to be duplicate anchors. If you click the max-attempts link it actually goes to a different max_attempts elsewhere in the page.
This problem is purely on the side of the docs. Mintlify doesn't have any plugin for visualizing the configuration schema well, so we had to manually write something, and I think a few things don't show correctly. I will have a look.
all issues were solved on the side of the docs.
Except for these two:
The item just above it on max-attempts has an additional issue, that it appears to take an object containing the key Bounded, like { Bounded: 5 }. But in actuality this Rust enum is using serde untagged mode and so the correct configuration method is just to pass a number.
--> this requires changes on the runtime side
Finally, there seem to be duplicate anchors. If you click the max-attempts link it actually goes to a different max_attempts elsewhere in the page.
--> this is not easily fixable because it is embedded within the mintlify ResponseField component.