Skip to content
Documentation

HAKOM.Documentation.Http.Net.Api Namespace

Contains the public API surface for configuring and hosting OpenAPI documentation in HAKOM HTTP services.

This namespace provides the controller (DocumentationController), configuration interfaces (IDocumentationConfiguration, IDocumentationBasePath, IDocumentationFileNamePrefix, IDocumentationVersionSeparator), and attributes (CustomSchemaNameAttribute, ObsoleteParameterAttribute) needed to generate, customize and serve versioned OpenAPI specification documents.

mvcBuilder.AddTagDescription("TimeSeries", "Endpoints for reading and writing time series data.", order: 10);
Classes
CustomSchemaNameAttribute Overrides the schema name used for a type in the generated OpenAPI specification.
DocumentationController Provides documentation related endpoints.
ObsoleteParameterAttribute Allows individual parameters of controllers to be marked as deprecated in the OpenAPI documentation.
Interfaces
IDocumentationBasePath Defines the base path under which automatically generated OpenAPI documents should be hosted.
IDocumentationConfiguration Defines how automatically generated OpenAPI documentation should be hosted within a service.
IDocumentationFileNamePrefix Defines the name of the generated OpenAPI document. The final document will consist of this suffixed by the APIs version.
IDocumentationVersionSeparator Defines the string that should be used in the file names of automatically generated documentation files for separation between the file name and its version.
© 2026 Volue.Version v0.6.38017 November 2026