Skip to content
Documentation

IDocumentationBasePath Interface

Defines the base path under which automatically generated OpenAPI documents should be hosted.

public interface IDocumentationBasePath

The default path base for automatically generated documentation in an HTTP API.

const string DEFAULT = "documentation";

System.String

The path to use. Must not start or end with a “/”.

string Value { get; }

System.String

Converts this instance to its string representation which is equal to Value.

string? ToString();

System.String
Value

IDocumentationBasePath.TryValidate() Method

Section titled “IDocumentationBasePath.TryValidate() Method”

Validates the value of this instance.

bool TryValidate();

System.Boolean
true if successful, false otherwise.

IDocumentationBasePath.TryValidate(string) Method

Section titled “IDocumentationBasePath.TryValidate(string) Method”

Validates that the given value does not start or end with a “/”.

static bool TryValidate(string value);

value System.String

The path base to validate.

System.Boolean
true if successful, false otherwise.

© 2026 Volue.Version v0.6.38017 November 2026