OpenApiParameter

Home
API Reference
Moka
Docs
Plugins
Openapi
OpenApiParameter

Class Sealed

public sealed class OpenApiParameter

Namespace: Moka.Docs.Plugins.OpenApi

Represents a parameter (path, query, header, or cookie) on an endpoint.

Properties

Name	Description
`Description`	Human-readable description.
`In`	Parameter location: `path`, `query`, `header`, or `cookie`.
`Name`	Parameter name.
`Required`	Whether this parameter is required.
`SchemaType`	Schema type description (e.g. `string`, `integer (int64)`).

Description

string OpenApiParameter.Description { get; set; }

Human-readable description.

In

string OpenApiParameter.In { get; set; }

Parameter location: path, query, header, or cookie.

Name

string OpenApiParameter.Name { get; set; }

Parameter name.

Required

bool OpenApiParameter.Required { get; set; }

Whether this parameter is required.

SchemaType

string OpenApiParameter.SchemaType { get; set; }

Schema type description (e.g. string, integer (int64)).

View Source

/// <summary>
///     Represents a parameter (path, query, header, or cookie) on an endpoint.
/// </summary>
public sealed class OpenApiParameter
{
    /// <summary>Parameter name.</summary>
    public string Name { get; set; } = "";
    /// <summary>Parameter location: <c>path</c>, <c>query</c>, <c>header</c>, or <c>cookie</c>.</summary>
    public string In { get; set; } = "";
    /// <summary>Human-readable description.</summary>
    public string Description { get; set; } = "";
    /// <summary>Whether this parameter is required.</summary>
    public bool Required { get; set; }
    /// <summary>Schema type description (e.g. <c>string</c>, <c>integer (int64)</c>).</summary>
    public string SchemaType { get; set; } = "";
}