No "date-time" format on basic string filter

[jwulf]

It's on the Advanced filter, but not on the Basic one....

Seems like a docs rendering issue. It's defined on the schema, and shows up fine in Swagger.

Check pre-processing pipeline in camunda-docs for anything that might be clobbering it.

[tmetzke]

We could try a quick fix that introduces a dedicated component like DateTimeFilterExactMatch instead of an inline definition.

[jwulf]

Same thing for the Search Jobs JobStateEnum in the request.

It pulls the enum values, but claims it is a string:

It gets it right for the response:

[jwulf]

I think the way to deal with this is to dive into the generator and contribute a patch upstream, because it is across all the polymorphic filters.

[tmetzke]

I think the way to deal with this is to dive into the generator and contribute a patch upstream, because it is across all the polymorphic filters.

I believe it's a minor issue right now. We should fix it for sure, but it doesn't have the highest priority right now. Fixing it upstream is desirable indeed. If we can easily fix it locally first (maybe in a timeboxed attempt) that buys us time, of course.

[jwulf]

There are two components to the docusaurus builder:

1. A schema extractor — docusaurus-plugin-openapi-docs

• converts the OpenAPI YAML to a JSON Schema
• builds MDX (React + markdown + JSON)

2. A theme for a React renderer — docusaurus-theme-openapi-docs

• from MDX renders the JSON schema as HTML

The format for the oneOf primitive arm is present in the JSON Schema generated by the extractor. This is visible in the mdx file, for example: camunda-docs/docs/apis-tools/orchestration-cluster-api-rest/specifications/search-jobs.api.mdx.

However, the theme plugin is not rendering it.

So the theme plugin needs to be patched.

[jwulf]

Upstream PR open.

Before:

After:

[jwulf]

In the interim, while we wait for this be merged, I have opened a PR for the docs to use a build of the theme PR fork.