Share via


ApiParameterDescription Class

Describes a parameter on the API defined by relative URI path and HTTP method.

Inheritance Hierarchy

System.Object
  System.Web.Http.Description.ApiParameterDescription

Namespace:  System.Web.Http.Description
Assembly:  System.Web.Http (in System.Web.Http.dll)

Syntax

'Declaration
Public Class ApiParameterDescription
'Usage
Dim instance As ApiParameterDescription
public class ApiParameterDescription
public ref class ApiParameterDescription
type ApiParameterDescription =  class end
public class ApiParameterDescription

The ApiParameterDescription type exposes the following members.

Constructors

  Name Description
Public method ApiParameterDescription Initializes a new instance of the ApiParameterDescription class.

Top

Properties

  Name Description
Public property Documentation Gets or sets the documentation.
Public property Name Gets or sets the name.
Public property ParameterDescriptor Gets or sets the parameter descriptor.
Public property Source Gets or sets the source of the parameter. It may come from the request URI, request body or other places.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Http.Description Namespace