Stop using the OpenAPI schema to drive the UI (?)

[dantownsend]

Related to piccolo-orm/piccolo#1086

The UI of Piccolo Admin is largely driven by OpenAPI schemas (generated via create_pydantic_model in Piccolo).

We augment the OpenAPI schemas with Piccolo specific metadata (under the extra attribute).

Pydantic allows us to do this, and it has worked pretty well up until now. But other libraries (Litestar) complain if an OpenAPI schema has any custom attributes.

It should be possible to add custom attributes, as long as they start with x-, but we can't work out how to do it and still keep Litestar happy.

Which just leaves us with these options:

1. Completely replace the current schema endpoint with our own custom one.
2. Keep the current /schema endpoint in Piccolo Admin (minus all of the custom attributes), and have a second endpoint (something like /meta) which contains all of the custom attributes. The downside is it means 2 API calls instead of 1.
3. Have our own custom endpoint, but embed the existing schema JSON within it. Something like {"schema": ..., "custom": ...}.

[Compro-Prasad]

Ref: litestar-org/litestar#3762

[Compro-Prasad]

1. Completely replace the current schema endpoint with our own custom one.
2. Keep the current /schema endpoint in Piccolo Admin (minus all of the custom attributes), and have a second endpoint (something like /meta) which contains all of the custom attributes. The downside is it means 2 API calls instead of 1.
3. Have our own custom endpoint, but embed the existing schema JSON within it. Something like {"schema": ..., "custom": ...}.

I think the first one is the way to go. But why is the OpenAPI schema important to drive the UI? What was your plan when you implemented it using OpenAPI schema?

If you think the OpenAPI schema is still useful then having it as a separate endpoint makes sense as you mentioned in the third point.

The second point isn't too bad in today's day and age as most websites already are too bloated. But still, I would like to know why having 2 API calls is important if we could get it done using single endpoint.