Class RestApiGovernanceOptions
Namespace: Cephalon.AspNetCore.Hosting
Assembly: Cephalon.AspNetCore.dll
Configures host-level governance for public REST endpoint publication in Cephalon ASP.NET Core hosts.
public sealed class RestApiGovernanceOptionsInheritance
Section titled “Inheritance”object ← RestApiGovernanceOptions
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”These settings describe host-level publication governance for module-owned REST shorthand paths. They intentionally stay out of the engine core because they govern the ASP.NET Core public REST surface.
Constructors
Section titled “Constructors”RestApiGovernanceOptions(IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor>?, IReadOnlyList<RestEndpointSuppressionOptions>?, IReadOnlyList<RestEndpointOverrideOptions>?)
Section titled “ RestApiGovernanceOptions(IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor>?, IReadOnlyList<RestEndpointSuppressionOptions>?, IReadOnlyList<RestEndpointOverrideOptions>?)”Initializes a new instance of the
public RestApiGovernanceOptions(IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor>? authoringPolicies = null, IReadOnlyList<RestEndpointSuppressionOptions>? suppressions = null, IReadOnlyList<RestEndpointOverrideOptions>? overrides = null)Parameters
Section titled “Parameters”authoringPolicies IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor>?
The configured behavior-level authoring policies for REST publication groups.
suppressions IReadOnlyList<RestEndpointSuppressionOptions>?
The configured suppression rules for shorthand REST candidates.
overrides IReadOnlyList<RestEndpointOverrideOptions>?
The configured override rules for shorthand REST candidates.
Fields
Section titled “Fields”SectionName
Section titled “ SectionName”Gets the root configuration section used for REST API governance settings.
public const string SectionName = "RestApi"Field Value
Section titled “Field Value”Properties
Section titled “Properties”AuthoringPolicies
Section titled “ AuthoringPolicies”Gets the configured behavior-level authoring policies for REST publication groups.
public IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor> AuthoringPolicies { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointPublicationGroupAuthoringPolicyDescriptor>
HasValues
Section titled “ HasValues”Gets a value indicating whether any REST governance values were explicitly supplied.
public bool HasValues { get; }Property Value
Section titled “Property Value”Overrides
Section titled “ Overrides”Gets the configured override rules for descriptor-backed REST shorthand candidates.
public IReadOnlyList<RestEndpointOverrideOptions> Overrides { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointOverrideOptions>
Suppressions
Section titled “ Suppressions”Gets the configured suppression rules for descriptor-backed REST shorthand candidates.
public IReadOnlyList<RestEndpointSuppressionOptions> Suppressions { get; }Property Value
Section titled “Property Value”IReadOnlyList<RestEndpointSuppressionOptions>
Methods
Section titled “Methods”FromConfiguration(IConfiguration, string)
Section titled “ FromConfiguration(IConfiguration, string)”Binds and normalizes REST governance settings from configuration.
public static RestApiGovernanceOptions FromConfiguration(IConfiguration configuration, string sectionPath = "RestApi")Parameters
Section titled “Parameters”configuration IConfiguration
The application configuration root.
sectionPath string
The configuration section path to bind.
Returns
Section titled “Returns”The normalized REST governance settings.