ObsoleteParameterAttribute Class
Allows individual parameters of controllers to be marked as deprecated in the OpenAPI documentation.
public sealed class ObsoleteParameterAttribute : System.AttributeInheritance System.Object 🡒 System.Attribute 🡒 ObsoleteParameterAttribute
Constructors
Section titled “Constructors”ObsoleteParameterAttribute(string, string) Constructor
Section titled “ObsoleteParameterAttribute(string, string) Constructor”Mark a parameter of the current method as deprecated in the OpenAPI documentation.
public ObsoleteParameterAttribute(string parameterName, string description);Parameters
Section titled “Parameters”parameterName System.String
The name of the parameter to mark as deprecated.
description System.String
A description explaining why the parameter is obsolete and what should be used instead.
Properties
Section titled “Properties”ObsoleteParameterAttribute.Description Property
Section titled “ObsoleteParameterAttribute.Description Property”A description telling the documentation reader about why the parameter is obsolete and what should be used instead.
public string Description { get; }Property Value
Section titled “Property Value”ObsoleteParameterAttribute.ParameterName Property
Section titled “ObsoleteParameterAttribute.ParameterName Property”Gets the name of the deprecated parameter.
public string ParameterName { get; }Property Value
Section titled “Property Value”Was this page helpful?Thanks for your feedback!