poem-openapi 5.1.16

OpenAPI support for Poem.
Documentation 
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

Define an OpenAPI enum

# Macro parameters

| Attribute     | Description                                                                                                                                                                                                           | Type   | Optional |
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|----------|
| rename        | Rename the enum                                                                                                                                                                                                       | string | Y        |
| rename_all    | Rename all the items 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        |
| deprecated    | Schema deprecated                                                                                                                                                                                                     | bool   | Y        |
| external_docs | Specify a external resource for extended documentation                                                                                                                                                                | string | Y        |
| remote        | Derive a remote enum                                                                                                                                                                                                  | string | Y        |

# Item parameters

| Attribute | Description     | Type   | Optional |
|-----------|-----------------|--------|----------|
| rename    | Rename the item | string | Y        |

# Examples

```rust
use poem_openapi::Enum;

#[derive(Enum)]
enum PetStatus {
    Available,
    Pending,
    Sold,
}
```