Error in openapi schema for Enum

[szagi3891]

Expected Behavior

A different type is expected for the enum:

"geoRuleType": {
  "type": "string",
  "enum": [
    "DENY",
    "ALLOW"
  ]
}

Actual Behavior

"GeoRuleType": {
  "type": "GeoRuleType",
  "enum": [
    "DENY",
    "ALLOW"
  ]
},

Steps to Reproduce the Problem

1. You have to clone https://github.com/szagi3891/poem-test
2. And then run with cargo run

Specifications

• Version: poem = "1.0.38", poem-openapi = "1.0.41"
• Platform: MacOs
• Subsystem:

{
  "openapi": "3.0.0",
  "info": {
    "title": "Oneof",
    "version": "1.0"
  },
  "servers": [],
  "tags": [],
  "paths": {
    "/api1/hello": {
      "post": {
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "A",
                      "B"
                    ]
                  }
                },
                "oneOf": [
                  {
                    "$ref": "#/components/schemas/A"
                  },
                  {
                    "$ref": "#/components/schemas/B"
                  }
                ],
                "discriminator": {
                  "propertyName": "type"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "integer",
                  "format": "uint64"
                }
              }
            }
          },
          "403": {
            "description": "Permission denied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Forb"
                }
              }
            }
          },
          "500": {
            "description": "Internal error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "GeoRuleType": {
        "type": "GeoRuleType",
        "enum": [
          "DENY",
          "ALLOW"
        ]
      },
      "B": {
        "type": "object",
        "required": [
          "v3",
          "list"
        ],
        "properties": {
          "v3": {
            "type": "number",
            "format": "float32"
          },
          "list": {
            "type": "object",
            "additionalProperties": {
              "type": "integer",
              "format": "uint64"
            }
          },
          "sport": {
            "$ref": "#/components/schemas/SportModel"
          }
        }
      },
      "Forb": {
        "type": "object",
        "required": [
          "message",
          "age"
        ],
        "properties": {
          "message": {
            "type": "string"
          },
          "age": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "A": {
        "type": "object",
        "required": [
          "v1",
          "v2"
        ],
        "properties": {
          "v1": {
            "type": "integer",
            "format": "int32"
          },
          "v2": {
            "type": "string"
          }
        }
      },
      "SportModel": {
        "type": "object",
        "required": [
          "id",
          "name",
          "displayOrder",
          "geoRuleType"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "displayOrder": {
            "type": "integer",
            "format": "uint64"
          },
          "geoRuleType": {
            "$ref": "#/components/schemas/GeoRuleType"
          }
        }
      }
    }
  }
}

[szagi3891]

I have validated this specification on https://editor.swagger.io/
This page returns such an error message:

Structural error at components.schemas.GeoRuleType.type
should be equal to one of the allowed values
allowedValues: array, boolean, integer, number, object, string

[szagi3891]

pub enum State {
    #[serde(rename = "open")]
    Open
}

How to handle the renaming of a field in a poem ?

[sunli829]

Thank you very much, fixed in 1.0.43 🙂

https://docs.rs/poem-openapi/1.0.40/poem_openapi/derive.Enum.html#item-parameters

#[derive(Enum)]
enum MyEnum {
     CreateUser,
     #[oai(rename = "delete_user")]
     DeleteUser,
}

[szagi3891]

Works beautifully :)

And are there any equivalents for these attributes ?
#[serde(untagged)]
#[serde(deny_unknown_fields)]

[szagi3891]

I think it will be good for my API if I get rid of these two attributes untagged and deny_unknown_fields.
Once again, many thanks for your help :)

[sunli829]

#[serde(deny_unknown_fields)]

I want to deny unknown fields by default, what do you think? @szagi3891

[szagi3891]

Yes, it would be nice to have this option.

Would it be possible to make an equivalent for this switch ?
#[serde(untagged)]

[sunli829]

Sorry, can you tell me what #[serde(untagged)] does? 😁

[szagi3891]

https://serde.rs/enum-representations.html#untagged

Then you can have many different variants of objects with different types. Something like OneOf but without the field that defines their type.

[sunli829]

How to define this type in the spec?

[sunli829]

I guess you want this?

#[serde(tag = "type")]
enum Obj {
    A {
        a: i32,
    }
    B {
        b: i32
    }
}

[szagi3891]

This is a sample schema:

"sport": {
   "nullable":true,
   "oneOf":[
      {
         "type":"string"
      },
      {
         "items":{
            "type":"string"
         },
         "type":"array"
      },
      {
         "properties":{
            "ne":{
               "items":{
                  "type":"string"
               },
               "type":"array"
            }
         },
         "type":"object",
         "required":[
            "ne"
         ]
      }
   ]
},

In this case of use, the field that specifies the type of variant of the enum is not used at all

[szagi3891]

This schema above, is generated from such a rustic structure|:

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum EventsQuerySport {
    Simple(Arc<String>),
    Vec(Vec<Arc<String>>),
    Not {
        ne: Vec<Arc<String>>
    }
}

[sunli829]

deny_unknown_fields

Released in v1.0.50 🙂