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
use crate::*;
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
pub struct OpenAPI {
/// REQUIRED. This string MUST be the semantic version number of the
/// OpenAPI Specification version that the OpenAPI document uses.
/// The openapi field SHOULD be used by tooling specifications and
/// clients to interpret the OpenAPI document. This is not related to
/// the API info.version string.
pub openapi: String,
/// REQUIRED. Provides metadata about the API.
/// The metadata MAY be used by tooling as required.
pub info: Info,
/// An array of Server Objects, which provide connectivity information to a
/// target server. If the servers property is not provided, or is an empty
/// array, the default value would be a Server Object with a url value of /.
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub servers: Vec<Server>,
/// REQUIRED. The available paths and operations for the API.
pub paths: Paths,
/// An element to hold various schemas for the specification.
#[serde(skip_serializing_if = "Option::is_none")]
pub components: Option<Components>,
/// A declaration of which security mechanisms can be used across the API.
/// The list of values includes alternative security requirement objects
/// that can be used. Only one of the security requirement objects need to
/// be satisfied to authorize a request. Individual operations can override
/// this definition.
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub security: Vec<SecurityRequirement>,
/// A list of tags used by the specification with additional metadata.
/// The order of the tags can be used to reflect on their order by the
/// parsing tools. Not all tags that are used by the Operation Object
/// must be declared. The tags that are not declared MAY be organized
/// randomly or based on the tool's logic. Each tag name in the list
/// MUST be unique.
#[serde(default)]
#[serde(skip_serializing_if = "Vec::is_empty")]
pub tags: Vec<Tag>,
/// Additional external documentation.
#[serde(rename = "externalDocs")]
#[serde(skip_serializing_if = "Option::is_none")]
pub external_docs: Option<ExternalDocumentation>,
/// Inline extensions to this object.
#[serde(flatten)]
pub extensions: IndexMap<String, serde_json::Value>,
}