salvo-oapi 0.91.1

//! Implements [OpenAPI Request Body][request_body] types.
//!
//! [request_body]: https://spec.openapis.org/oas/latest.html#request-body-object
use indexmap::IndexMap;
use serde::{Deserialize, Serialize};

use super::{Content, Required};
use crate::PropMap;

/// Implements [OpenAPI Request Body][request_body].
///
/// [request_body]: https://spec.openapis.org/oas/latest.html#request-body-object
#[non_exhaustive]
#[derive(Serialize, Deserialize, Default, Clone, Debug, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct RequestBody {
    /// Additional description of [`RequestBody`] supporting markdown syntax.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Map of request body contents mapped by content type e.g. `application/json`.
    #[serde(rename = "content")]
    pub contents: IndexMap<String, Content>,

    /// Determines whether request body is required in the request or not.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<Required>,

    /// Optional extensions "x-something"
    #[serde(skip_serializing_if = "PropMap::is_empty", flatten)]
    pub extensions: PropMap<String, serde_json::Value>,
}

impl RequestBody {
    /// Construct a new empty [`RequestBody`]. This is effectively same as calling
    /// [`RequestBody::default`].
    #[must_use]
    pub fn new() -> Self {
        Default::default()
    }
    /// Add description for [`RequestBody`].
    #[must_use]
    pub fn description<S: Into<String>>(mut self, description: S) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Define [`RequestBody`] required.
    #[must_use]
    pub fn required(mut self, required: Required) -> Self {
        self.required = Some(required);
        self
    }

    /// Add [`Content`] by content type e.g `application/json` to [`RequestBody`].
    #[must_use]
    pub fn add_content<S: Into<String>, C: Into<Content>>(mut self, kind: S, content: C) -> Self {
        self.contents.insert(kind.into(), content.into());
        self
    }

    /// Add openapi extensions (`x-something`) for [`RequestBody`].
    #[must_use]
    pub fn extensions(mut self, extensions: PropMap<String, serde_json::Value>) -> Self {
        self.extensions = extensions;
        self
    }

    /// Fill [`RequestBody`] with values from another [`RequestBody`].
    pub fn merge(&mut self, other: Self) {
        let Self {
            description,
            contents,
            required,
            extensions,
        } = other;
        if let Some(description) = description
            && !description.is_empty()
        {
            self.description = Some(description);
        }
        self.contents.extend(contents);
        if let Some(required) = required {
            self.required = Some(required);
        }
        self.extensions.extend(extensions);
    }
}

#[cfg(test)]
mod tests {
    use assert_json_diff::assert_json_eq;
    use serde_json::json;

    use super::{Content, RequestBody, Required};

    #[test]
    fn request_body_new() {
        let request_body = RequestBody::new();

        assert!(request_body.contents.is_empty());
        assert_eq!(request_body.description, None);
        assert!(request_body.required.is_none());
    }

    #[test]
    fn request_body_builder() -> Result<(), serde_json::Error> {
        let request_body = RequestBody::new()
            .description("A sample requestBody")
            .required(Required::True)
            .add_content(
                "application/json",
                Content::new(crate::Ref::from_schema_name("EmailPayload")),
            );

        assert_json_eq!(
            request_body,
            json!({
              "description": "A sample requestBody",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/EmailPayload"
                  }
                }
              },
              "required": true
            })
        );
        Ok(())
    }

    #[test]
    fn request_body_merge() {
        let mut request_body = RequestBody::new();
        let other_request_body = RequestBody::new()
            .description("Merged requestBody")
            .required(Required::True)
            .add_content(
                "application/json",
                Content::new(crate::Ref::from_schema_name("EmailPayload")),
            );

        request_body.merge(other_request_body);
        assert_json_eq!(
            request_body,
            json!({
              "description": "Merged requestBody",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/EmailPayload"
                  }
                }
              },
              "required": true
            })
        );
    }
}