Overriding field attributes in ModelSchema

[CubicrootXYZ]

I have a Django model

class Assembly:
  id = models.UUIDField(default=uuid4, primary_key=True, editable=False)

and I have defined a ModelSchema like this:

class AssemblyAttributes(ModelSchema):
  class Meta:
    model = Assembly
    fields = ['id']

This will now use the help_text attribute of the id field as descriptions in the OpenAPI schema at /openapi.json, which is not set and therefore no description is set:

"id": {"format": "uuid", "nullable": true, "title": "Id", "type": "string"}

I however want to override/set the description of that field in the OpenAPI schema.

I tried the following without success:

class AssemblyAttributes(ModelSchema):
   id: str = Field(description='The ID')

  class Meta:
    model = Assembly
    fields = ['id']

Any way to achieve this? All I want to change is the description (and ideally the example) attribute of the Assembly.id field so the OpenAPI schema and the Django model can use different values.

[vitalik]

Hi @CubicrootXYZ - can you define what does not work - it does not output description ? how about title (Field(title="my title"))

[CubicrootXYZ]

Hey @vitalik thanks for looking into this, I appreciate your help.

The OpenAPI schema does not contain a description for the id property of the AssemblyAttributes schema. I'd expect it to be set to The ID but the description is not set at all. If I provide a help_text in the Assembly class that text gets added as a description, e.g. the OpenAPI schema for the id property looks like this:

"id": {"description": "Help text for the ID.", "format": "uuid", "nullable": true, "title": "Id", "type": "string"}

I'd still expect it to be

"id": {"description": "The ID.", "format": "uuid", "nullable": true, "title": "Id", "type": "string"}

(as I am overriding it in the AssemblyAttributes class but it is not.

how about title (Field(title="my title"))

That does not work either.