ContextQMD
Back to Poem

Macro parameters

poem-openapi/src/docs/oauth_scopes.md

2.0.01.1 KB
Original Source

Define a OAuth scopes.

Macro parameters

AttributeDescriptionTypeOptional
rename_allRename 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".stringY

Item parameters

AttributeDescriptionTypeOptional
renameRename the scope namestringY

Examples

rust
use poem_openapi::OAuthScopes;

#[derive(OAuthScopes)]
enum GithubScopes {
    /// Read data
    Read,
    /// Write data
    Write,
}