Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

flask restx enum model

How to create an Enum api model in flask restx with one string field without other properties so that the following description is generated in swagger.yml?

definitions:
    Colors:
      type: string
      enum: [black, white, red, green, blue]

enter image description here Maybe some hacks will help? Because now it seems like you can create an api model with properties only

like image 567
Nicolay Avatar asked May 30 '26 09:05

Nicolay


1 Answers

Oh, so I find solution for my question)

Self-answered, lol

You can define api model via json schema description: https://flask-restx.readthedocs.io/en/latest/marshalling.html#define-model-using-json-schema

colors_api_model = api.schema_model('Colors', {
    'enum':
        ['black', 'white', 'red', 'green', 'blue'],
    'type': 'string'
})
like image 147
Nicolay Avatar answered Jun 01 '26 23:06

Nicolay