Struct DeprecatedField 

pub struct DeprecatedField {
    pub field_name: String,
    pub replacement: Option<String>,
}

A transparent wrapper that marks a schema field as deprecated in the generated OpenAPI output.

The inner value is the field name (a string) that is being deprecated. Optionally carries a replacement hint shown in documentation.

Serializes/deserializes the field name transparently.

Examples

use api_bones::openapi::DeprecatedField;

let d = DeprecatedField::new("legacy_id").with_replacement("resource_id");
assert_eq!(d.field_name(), "legacy_id");
assert_eq!(d.replacement(), Some("resource_id"));

Fields

field_name: String

The name of the deprecated field.

replacement: Option<String>

Optional migration hint pointing to the replacement field or endpoint.

Implementations

impl DeprecatedField

pub fn new(field_name: impl Into<String>) -> Self

Create a new DeprecatedField marker.

Examples

use api_bones::openapi::DeprecatedField;

let d = DeprecatedField::new("old_id");
assert_eq!(d.field_name(), "old_id");
assert!(d.replacement().is_none());

pub fn with_replacement(self, replacement: impl Into<String>) -> Self

Attach a replacement hint (builder-style).

Examples

use api_bones::openapi::DeprecatedField;

let d = DeprecatedField::new("old_id").with_replacement("resource_id");
assert_eq!(d.replacement(), Some("resource_id"));

pub fn field_name(&self) -> &str

The deprecated field name.

pub fn replacement(&self) -> Option<&str>

The optional replacement hint.

Trait Implementations

impl Clone for DeprecatedField

fn clone(&self) -> DeprecatedField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeprecatedField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeprecatedField

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeprecatedField

fn eq(&self, other: &DeprecatedField) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeprecatedField

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DeprecatedField

impl StructuralPartialEq for DeprecatedField