OpenApiResponse

Home
API Reference
Moka
Docs
Plugins
Openapi
OpenApiResponse

Class Sealed

public sealed class OpenApiResponse

Namespace: Moka.Docs.Plugins.OpenApi

Represents a single response definition on an endpoint.

Properties

Name	Description
`Description`	Human-readable description of the response.
`Schema`	Schema describing the response body, if any.
`StatusCode`	HTTP status code as a string (e.g. `200`, `404`, `default`).

Description

string OpenApiResponse.Description { get; set; }

Human-readable description of the response.

Schema

OpenApiSchema? OpenApiResponse.Schema { get; set; }

Schema describing the response body, if any.

StatusCode

string OpenApiResponse.StatusCode { get; set; }

HTTP status code as a string (e.g. 200, 404, default).

View Source

/// <summary>
///     Represents a single response definition on an endpoint.
/// </summary>
public sealed class OpenApiResponse
{
    /// <summary>HTTP status code as a string (e.g. <c>200</c>, <c>404</c>, <c>default</c>).</summary>
    public string StatusCode { get; set; } = "";
    /// <summary>Human-readable description of the response.</summary>
    public string Description { get; set; } = "";
    /// <summary>Schema describing the response body, if any.</summary>
    public OpenApiSchema? Schema { get; set; }
}