Nested objects in yaml become AnonymousSchema

[fr-th]

Greetings,

I noticed when generating C# models based on a provided yaml contract that, if nested objects were present in the specifications this would result in AnonymousSchema being created. :

Contract :

...
property1: 
  type: string
  nullable: true
nestedObjectName:
  type: object
  properties:
    objectProperty1:
      type: string
      nullable: true
    objectProperty2:
      type: string
      nullable: true
restOfProperties:
  type: string
  nullable: true
...

Results in :

...
public string? Property1{ get; set; }
public AnonymousSchema_212? NestedObjectName{ get; set; }
public string? RestOfProperties { get; set; }
...

And the object :

public partial class AnonymousSchema_212
{
  public string? ObjectProperty1{ get; set; }
  public string? ObjectProperty2{ get; set; }
}

This is not great for code readability afterwards.
I wanted to know if there was a way around that or a solution to improve that ? I did not find any in the documentation so far.

Could it be possible to generate the class using the name of the property, maybe with a prefix/suffix to avoid issue ?

Thanks in advance

[jonaslagoni]

The current interpretation of names is done with title, $id, and a custom extension called x-modelgen-inferred-name (although I see its bugged for AsyncAPI inputs) in that order. This means you can set the following:

...
property1: 
  type: string
  nullable: true
nestedObjectName:
+  title: nestedObjectName
+  $id: nestedObjectName
+  x-modelgen-inferred-name: nestedObjectName
  type: object 
  properties:
    objectProperty1:
      type: string
      nullable: true
    objectProperty2:
      type: string
      nullable: true
restOfProperties:
  type: string
  nullable: true
...

If you cant change the input document, you can change the naming formatting behavior i.e. map the name to something else: https://modelina.org/examples?selectedExample=overwrite-naming-formatting, although not optimal.

Could it be possible to generate the class using the name of the property, maybe with a prefix/suffix to avoid issue ?

The general problem when it comes to naming of models is the possibility of "clashing" one or more models together, that are NOT supposed to be named the same thing. Especially with larger inputs.

So property names are not the best determiner of naming strategy as they are never really unique, but if you see a better way of doing it feel free to propose it ✌️

[fr-th]

Thanks for you reply. I'll see with the provider if they can adapt the document to add the title or $id field.

I see that I'm lucky that the properties are even generated with proper name, as the detected models also seem to suggest anonymous_schema:

If the document cannot be change, I'll think of something and propose a solution.

Have a nice day :)