FastAPI: How to generate a readable scheme from IntEnum in openapi.json with the correct keys, not digital ones?

Question

My IntEnum class:

class Role(IntEnum):
    client = 1
    manager = 2
    admin = 3

What I got in generated openapi.json:

{
  enum: [1, 2, 3],
  title: "Role",
  type: "integer"
}

What I need:

{
  enum: {
    client: 1,
    manager: 2,
    admin: 3
  },
  title: "Role",
  type: "integer"
}

Is it possible?🙏🏼

The names in an IntEnum are only used internally. Any reason you can't use a StrEnum? — M.O.
– M.O., Commented Feb 3, 2024 at 12:47
I use this IntEnum as type for field in db and I wouldn't store roles and statuses as strings — Mike Artemiev
– Mike Artemiev, Commented Feb 4, 2024 at 16:32

Mike Artemiev · Accepted Answer · 2024-02-04 16:41:12Z

0

Thanks everyone for your attention, but I found a solution:) I should to override __get_pydantic_json_schema__ method in all my classes where I need custom schema generation.

answered Feb 4, 2024 at 16:41

Mike Artemiev

861 silver badge7 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

rumbarum · Accepted Answer · 2025-08-31 03:24:01Z

0

You can make use of docstring on Enum Class. Fastapi will generate json schema included automatically

class Role(IntEnum):
    """
    1: client 
    2: manager
    3: admin
    """
    client = 1
    manager = 2
    admin = 3

This will generate, on openapi.json

{
...
"type":"object",
"description": 
""" 1: client 
    2: manager
    3: admin
"""
}

answered Aug 31 at 3:24

rumbarum

1,0038 silver badges8 bronze badges

Collectives™ on Stack Overflow

FastAPI: How to generate a readable scheme from IntEnum in openapi.json with the correct keys, not digital ones?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related