Generics produce invalid OpenAPI identifiers

[Eugeny]

Having a generic type with #[derive(Object)] will produce identifiers like PaginatedResponse<SessionSnapshot> which look nice, but are not valid according to the spec:

Component names can only contain the characters A-Z a-z 0-9 - . _

It would be nicer to allow renaming them at the specialization site with an [oai(rename)], or allow forcing the definition to be inlined in the spec.

[sunli829]

It works fine in Swagger UI/Redoc/Rapidoc, maybe some code generation tools don't recognize it. 🙂

[itsbalamurali]

@sunli829 what's the best workaround? Currently, we use openapi-generator. Getting the same issue as @Eugeny did.

[itsbalamurali]

@sunli829 can we transform for example PaginatedResponse<SessionSnapshot> to PaginatedResponseOfSessionSnapshot?

[Eugeny]

Maybe the Object derive macro could also accept an #[oai(generic_name_format="{}<{}>")] and use it to generate the name

[sunli829]

Maybe the Object derive macro could also accept an #[oai(generic_name_format="{}<{}>")] and use to generate the name

This looks good 🙂

[itsbalamurali]

@Eugeny or @sunli829 any plans on landing this sooner?

[sunli829]

Currently the only solution is to avoid using generics. 🙂

[itsbalamurali]

@Eugeny are you interested in implementing this?

[Eugeny]

No, I've already worked around it by just modifying the generated JSON schema in my code.

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[itsbalamurali]

Just pinging to keep the issue alive.

[itsbalamurali]

@sunli829 Do you have some time to look at this?

[sunli829]

This problem can currently only be solved by avoiding the use of generics. 🙂

[itsbalamurali]

pinging to keep the issue alive.

[balaatsky]

ping again :)