1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Define an OpenAPI object
# Macro parameters
| Attribute | Description | Type | Optional |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------|
| rename | Rename the object | string | Y |
| rename_all | Rename all the fields according to the given case convention. The possible values are "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE", "kebab-case", "SCREAMING-KEBAB-CASE". | string | Y |
| default | Default value | bool,string | Y |
| deprecated | Schema deprecated | bool | Y |
| read_only_all | Set all fields openapi readOnly property | bool | Y |
| write_only_all | Set all fields openapi writeOnly property | bool | Y |
| deny_unknown_fields | Always error during parsing when encountering unknown fields. | bool | Y |
| example | Indicates that the object type has implemented `Example` trait | bool | Y |
| external_docs | Specify a external resource for extended documentation | string | Y |
| remote | Derive a remote object | string | Y |
| skip_serializing_if_is_none | Skip serializing field if the value is none. | bool | Y |
| skip_serializing_if_is_empty | Skip serializing field if the value is empty. | bool | Y |
# Field parameters
| Attribute | Description | Type | Optional |
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|----------|
| skip | Skip this field | bool | Y |
| rename | Rename the field | string | Y |
| default | Default value | bool,string | Y |
| read_only | set field openapi readOnly property | bool | Y |
| write_only | set field openapi writeOnly property bool | bool | Y |
| deprecated | Mark this field as deprecated | bool | Y |
| flatten | Similar to serde (flatten) | bool | Y |
| skip_serializing_if_is_none | Skip serializing this field if the value is none. | bool | Y |
| skip_serializing_if_is_empty | Skip serializing this field if the value is empty. | bool | Y |
| skip_serializing_if | Call a function to determine whether to skip serializing this field. | string | Y |
| validator.multiple_of | The value of "multiple_of" MUST be a number, strictly greater than 0. A numeric instance is only valid if division by this value results in an integer. | number | Y |
| validator.maximum | The value of "maximum" MUST be a number, representing an upper limit for a numeric instance. If `exclusive` is `true` and instance is less than the provided value, or else if the instance is less than or exactly equal to the provided value. | { value: `<number>`, exclusive: `<bool>`} | Y |
| validator.minimum | The value of "minimum" MUST be a number, representing a lower limit for a numeric instance. If `exclusive` is `true` and instance is greater than the provided value, or else if the instance is greater than or exactly equal to the provided value. | { value: `<number>`, exclusive: `<bool>`} | Y |
| validator.max_length | The value of "max_length" MUST be a non-negative integer. A string instance is valid against this validator if its length is less than, or equal to, the value. | usize | Y |
| validator.min_length | The value of "min_length" MUST be a non-negative integer. The value of this validator MUST be an integer. This integer MUST be greater than, or equal to, 0. | usize | Y |
| validator.pattern | The value of "pattern" MUST be a string. This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect. A string instance is considered valid if the regular expression matches the instance successfully. | string | Y |
| validator.max_items | The value of "max_items" MUST be an integer. This integer MUST be greater than, or equal to, 0. An array instance is valid if its size is less than, or equal to, the value of this validator. | usize | Y |
| validator.min_items | The value of "min_items" MUST be an integer. This integer MUST be greater than, or equal to, 0. An array instance is valid if its size is greater than, or equal to, the value of this validator. | usize | Y |
| validator.unique_items | The value of "unique_items" MUST be an boolean. If this value is `false`, the instance validates successfully. If this value is `true`, the instance validates successfully if all of its elements are unique. | bool | Y |
| validator.max_properties | The value of this keyword MUST be a non-negative integer. An object instance is valid against "maxProperties" if its number of properties is less than, or equal to, the value of this keyword. | usize | Y |
| validator.min_properties | The value of this keyword MUST be a non-negative integer. An object instance is valid against "minProperties" if its number of properties is greater than, or equal to, the value of this keyword. | usize | Y |
# Examples
```rust
use poem_openapi::Object;
/// Pet
#[derive(Object)]
struct Pet {
/// The id of this pet.
id: String,
/// The name of this pet.
name: String,
}
```