Enum SuggestionInput 

pub enum SuggestionInput {
    Endpoint {
        method: String,
        path: String,
        request: Option<Value>,
        response: Option<Value>,
        description: Option<String>,
    },
    Description {
        text: String,
    },
    PartialSpec {
        spec: Value,
    },
    Paths {
        paths: Vec<String>,
    },
}

Input type for spec suggestion

Variants

Endpoint

Single endpoint example with request/response

Fields

method: String

HTTP method

path: String

Path

request: Option<Value>

Request example

response: Option<Value>

Response example

description: Option<String>

Optional description

Description

Text description of the API

Fields

text: String

API description text

PartialSpec

Partial OpenAPI specification

Fields

spec: Value

Partial OpenAPI spec

Paths

List of endpoint paths only

Fields

paths: Vec<String>

List of paths

Trait Implementations

impl Clone for SuggestionInput

fn clone(&self) -> SuggestionInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SuggestionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SuggestionInput

fn deserialize<__D>( __deserializer: __D, ) -> Result<SuggestionInput, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SuggestionInput

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.