openapiv3/
external_documentation.rs

1use indexmap::IndexMap;
2use serde::{Deserialize, Serialize};
3
4/// Allows referencing an external resource for extended documentation.
5#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
6pub struct ExternalDocumentation {
7    /// A short description of the target documentation.
8    /// CommonMark syntax MAY be used for rich text representation.
9    #[serde(skip_serializing_if = "Option::is_none")]
10    pub description: Option<String>,
11    /// REQUIRED. The URL for the target documentation.
12    /// Value MUST be in the format of a URL.
13    pub url: String,
14    /// Inline extensions to this object.
15    #[serde(flatten, deserialize_with = "crate::util::deserialize_extensions")]
16    pub extensions: IndexMap<String, serde_json::Value>,
17}