MissingDocumentationConfigurationException Class
HAKOM.Documentation.Http.Net.Api.Exceptions
Section titled “HAKOM.Documentation.Http.Net.Api.Exceptions”Thrown when an attempt is made to configure the routes for automatically generated OpenAPI documents without having configured it first.
public sealed class MissingDocumentationConfigurationException : HAKOM.ErrorHandling.Core.Net.Api.HakomExceptionInheritance System.Object 🡒 System.Exception 🡒 HakomException 🡒 MissingDocumentationConfigurationException
Remarks
Section titled “Remarks”In order to configure the generation of the OpenApi documents, make sure to call AddDocumentation(this IMvcBuilder, string, string, string, string, string, string, Action<SwaggerGenOptions>).
This exception is identified by error code HK16001.
Properties
Section titled “Properties”MissingDocumentationConfigurationException.EquivalentHttpStatusCode Property
Section titled “MissingDocumentationConfigurationException.EquivalentHttpStatusCode Property”This exception would normally be raised during startup of a service, so there is no status code to respond with as the service will not be in a state to accept requests in the first place.
If the failing service is hosted behind a proxy, that proxy should probably return either a status code 500 (Internal Server Error) or 502 (Bad Gateway).
protected override System.Net.HttpStatusCode EquivalentHttpStatusCode { protected get; }