OpenAPICommonMetadata record
Metadata for OpenAPI documentation related to the route.
public record OpenAPICommonMetadata
Public Members
| name | description |
|---|---|
| OpenAPICommonMetadata() | Initializes a new instance of the OpenAPICommonMetadata class. |
| OpenAPICommonMetadata(…) | Initializes a new instance of the OpenAPICommonMetadata class with the specified pattern. |
| CorsPolicy { get; set; } | The name of the CORS policy to apply to this route. |
| Description { get; set; } | A detailed description of the route for OpenAPI documentation. |
| Enabled { get; set; } | Indicates whether OpenAPI documentation is enabled for this route. |
| Parameters { get; set; } | A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object’s components/parameters. |
| Pattern { get; set; } | The relative path for the route in OpenAPI documentation. |
| Servers { get; set; } | An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value. |
| Summary { get; set; } | A brief summary of the route for OpenAPI documentation. |