OpenApiDocDescriptor.CreateExternalDocs method (1 of 2)
Creates an OpenApiExternalDocs object from a URL string with optional extensions.
public OpenApiExternalDocs CreateExternalDocs(string url, string? description = null,
IDictionary? extensions = null)
| parameter | description |
|---|---|
| url | The URL for the external documentation. |
| description | An optional description of the external documentation. |
| extensions | Optional extensions for the external documentation. |
Return Value
An OpenApiExternalDocs object.
Exceptions
| exception | condition |
|---|---|
| ArgumentException | Thrown when the URL is null, empty, or whitespace. |
See Also
- class OpenApiDocDescriptor
- namespace Kestrun.OpenApi
OpenApiDocDescriptor.CreateExternalDocs method (2 of 2)
Creates an OpenApiExternalDocs object with optional extensions.
public OpenApiExternalDocs CreateExternalDocs(Uri url, string? description = null,
IDictionary? extensions = null)
| parameter | description |
|---|---|
| url | The URL for the external documentation. |
| description | An optional description of the external documentation. |
| extensions | Optional extensions for the external documentation. |
Return Value
An OpenApiExternalDocs object.
Exceptions
| exception | condition |
|---|---|
| ArgumentException | Thrown when the URL is null, empty, or whitespace. |
See Also
- class OpenApiDocDescriptor
- namespace Kestrun.OpenApi