-
Notifications
You must be signed in to change notification settings - Fork 864
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated docs from commit f21b390 on refs/heads/release/latest
- Loading branch information
1 parent
d89f68b
commit 3e2ce1d
Showing
22 changed files
with
1,117 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
185 changes: 185 additions & 0 deletions
185
api/Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,185 @@ | ||
| <!DOCTYPE html> | ||
| <!--[if IE]><![endif]--> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
| <title>Interface IClusterValidator | ||
| </title> | ||
| <meta name="viewport" content="width=device-width"> | ||
| <meta name="title" content="Interface IClusterValidator | ||
| "> | ||
| <meta name="generator" content="docfx 2.59.4.0"> | ||
|
|
||
| <link rel="shortcut icon" href="../favicon.ico"> | ||
| <link rel="stylesheet" href="../styles/docfx.vendor.css"> | ||
| <link rel="stylesheet" href="../styles/docfx.css"> | ||
| <link rel="stylesheet" href="../styles/main.css"> | ||
| <meta property="docfx:navrel" content="../toc.html"> | ||
| <meta property="docfx:tocrel" content="toc.html"> | ||
|
|
||
|
|
||
|
|
||
| </head> | ||
| <body data-spy="scroll" data-target="#affix" data-offset="120"> | ||
| <div id="wrapper"> | ||
| <header> | ||
|
|
||
| <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> | ||
| <div class="container"> | ||
| <div class="navbar-header"> | ||
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> | ||
| <span class="sr-only">Toggle navigation</span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| </button> | ||
|
|
||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../logo.svg" alt=""> | ||
| </a> | ||
| </div> | ||
| <div class="collapse navbar-collapse" id="navbar"> | ||
| <form class="navbar-form navbar-right" role="search" id="search"> | ||
| <div class="form-group"> | ||
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> | ||
| </div> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div class="subnav navbar navbar-default"> | ||
| <div class="container hide-when-search" id="breadcrumb"> | ||
| <ul class="breadcrumb"> | ||
| <li></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div role="main" class="container body-content hide-when-search"> | ||
|
|
||
| <div class="sidenav hide-when-search"> | ||
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> | ||
| <div class="sidetoggle collapse" id="sidetoggle"> | ||
| <div id="sidetoc"></div> | ||
| </div> | ||
| </div> | ||
| <div class="article row grid-right"> | ||
| <div class="col-md-10"> | ||
| <article class="content wrap" id="_content" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator"> | ||
|
|
||
|
|
||
| <h1 id="Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator" class="text-break">Interface IClusterValidator | ||
| </h1> | ||
| <div class="markdown level0 summary"><p>Provides method to validate cluster configuration.</p> | ||
| </div> | ||
| <div class="markdown level0 conceptual"></div> | ||
| <h6><strong>Namespace</strong>: <a class="xref" href="Yarp.ReverseProxy.Configuration.ClusterValidators.html">Yarp.ReverseProxy.Configuration.ClusterValidators</a></h6> | ||
| <h6><strong>Assembly</strong>: Yarp.ReverseProxy.dll</h6> | ||
| <h5 id="Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator_syntax">Syntax</h5> | ||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public interface IClusterValidator</code></pre> | ||
| </div> | ||
| <h3 id="methods">Methods | ||
| </h3> | ||
| <span class="small pull-right mobile-hide"> | ||
| <span class="divider">|</span> | ||
| <a href="https://github.com/microsoft/reverse-proxy/new/release/latest/apiSpec/new?filename=Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator_ValidateAsync_Yarp_ReverseProxy_Configuration_ClusterConfig_IList_Exception__.md&value=---%0Auid%3A%20Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.ValidateAsync(Yarp.ReverseProxy.Configuration.ClusterConfig%2CIList%7BException%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> | ||
| </span> | ||
| <span class="small pull-right mobile-hide"> | ||
| <a href="https://github.com/microsoft/reverse-proxy/blob/release/latest/src/ReverseProxy/Configuration/ClusterValidators/IClusterValidator.cs/#L19">View Source</a> | ||
| </span> | ||
| <a id="Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator_ValidateAsync_" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.ValidateAsync*"></a> | ||
| <h4 id="Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator_ValidateAsync_Yarp_ReverseProxy_Configuration_ClusterConfig_IList_Exception__" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.ValidateAsync(Yarp.ReverseProxy.Configuration.ClusterConfig,IList{Exception})">ValidateAsync(ClusterConfig, IList<Exception>)</h4> | ||
| <div class="markdown level1 summary"><p>Perform validation on a cluster configuration by adding exceptions to the provided collection.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
| <h5 class="decalaration">Declaration</h5> | ||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">ValueTask ValidateAsync(ClusterConfig cluster, IList<Exception> errors)</code></pre> | ||
| </div> | ||
| <h5 class="parameters">Parameters</h5> | ||
| <table class="table table-bordered table-striped table-condensed"> | ||
| <thead> | ||
| <tr> | ||
| <th>Type</th> | ||
| <th>Name</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td><a class="xref" href="Yarp.ReverseProxy.Configuration.ClusterConfig.html">ClusterConfig</a></td> | ||
| <td><span class="parametername">cluster</span></td> | ||
| <td><p>Cluster configuration to validate</p> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><span class="xref">IList</span><<span class="xref">Exception</span>></td> | ||
| <td><span class="parametername">errors</span></td> | ||
| <td><p>Collection of all validation exceptions</p> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <h5 class="returns">Returns</h5> | ||
| <table class="table table-bordered table-striped table-condensed"> | ||
| <thead> | ||
| <tr> | ||
| <th>Type</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td><span class="xref">ValueTask</span></td> | ||
| <td><p>A ValueTask representing the asynchronous validation operation.</p> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </article> | ||
| </div> | ||
|
|
||
| <div class="hidden-sm col-md-2" role="complementary"> | ||
| <div class="sideaffix"> | ||
| <div class="contribution"> | ||
| <ul class="nav"> | ||
| <li> | ||
| <a href="https://github.com/microsoft/reverse-proxy/new/release/latest/apiSpec/new?filename=Yarp_ReverseProxy_Configuration_ClusterValidators_IClusterValidator.md&value=---%0Auid%3A%20Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/microsoft/reverse-proxy/blob/release/latest/src/ReverseProxy/Configuration/ClusterValidators/IClusterValidator.cs/#L10" class="contribution-link">View Source</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> | ||
| <h5>In This Article</h5> | ||
| <div></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer> | ||
| <div class="grad-bottom"></div> | ||
| <div class="footer"> | ||
| <div class="container"> | ||
| <span class="pull-right"> | ||
| <a href="#top">Back to top</a> | ||
| </span> | ||
|
|
||
| <span>Generated by <strong>DocFX</strong></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </div> | ||
|
|
||
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script> | ||
| <script type="text/javascript" src="../styles/docfx.js"></script> | ||
| <script type="text/javascript" src="../styles/main.js"></script> | ||
| </body> | ||
| </html> |
119 changes: 119 additions & 0 deletions
119
api/Yarp.ReverseProxy.Configuration.ClusterValidators.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| <!DOCTYPE html> | ||
| <!--[if IE]><![endif]--> | ||
| <html> | ||
|
|
||
| <head> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> | ||
| <title>Namespace Yarp.ReverseProxy.Configuration.ClusterValidators | ||
| </title> | ||
| <meta name="viewport" content="width=device-width"> | ||
| <meta name="title" content="Namespace Yarp.ReverseProxy.Configuration.ClusterValidators | ||
| "> | ||
| <meta name="generator" content="docfx 2.59.4.0"> | ||
|
|
||
| <link rel="shortcut icon" href="../favicon.ico"> | ||
| <link rel="stylesheet" href="../styles/docfx.vendor.css"> | ||
| <link rel="stylesheet" href="../styles/docfx.css"> | ||
| <link rel="stylesheet" href="../styles/main.css"> | ||
| <meta property="docfx:navrel" content="../toc.html"> | ||
| <meta property="docfx:tocrel" content="toc.html"> | ||
|
|
||
|
|
||
|
|
||
| </head> | ||
| <body data-spy="scroll" data-target="#affix" data-offset="120"> | ||
| <div id="wrapper"> | ||
| <header> | ||
|
|
||
| <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation"> | ||
| <div class="container"> | ||
| <div class="navbar-header"> | ||
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> | ||
| <span class="sr-only">Toggle navigation</span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| <span class="icon-bar"></span> | ||
| </button> | ||
|
|
||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../logo.svg" alt=""> | ||
| </a> | ||
| </div> | ||
| <div class="collapse navbar-collapse" id="navbar"> | ||
| <form class="navbar-form navbar-right" role="search" id="search"> | ||
| <div class="form-group"> | ||
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> | ||
| </div> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div class="subnav navbar navbar-default"> | ||
| <div class="container hide-when-search" id="breadcrumb"> | ||
| <ul class="breadcrumb"> | ||
| <li></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </header> | ||
| <div role="main" class="container body-content hide-when-search"> | ||
|
|
||
| <div class="sidenav hide-when-search"> | ||
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> | ||
| <div class="sidetoggle collapse" id="sidetoggle"> | ||
| <div id="sidetoc"></div> | ||
| </div> | ||
| </div> | ||
| <div class="article row grid-right"> | ||
| <div class="col-md-10"> | ||
| <article class="content wrap" id="_content" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators"> | ||
|
|
||
| <h1 id="Yarp_ReverseProxy_Configuration_ClusterValidators" data-uid="Yarp.ReverseProxy.Configuration.ClusterValidators" class="text-break">Namespace Yarp.ReverseProxy.Configuration.ClusterValidators | ||
| </h1> | ||
| <div class="markdown level0 summary"></div> | ||
| <div class="markdown level0 conceptual"></div> | ||
| <div class="markdown level0 remarks"></div> | ||
| <h3 id="interfaces">Interfaces | ||
| </h3> | ||
| <h4><a class="xref" href="Yarp.ReverseProxy.Configuration.ClusterValidators.IClusterValidator.html">IClusterValidator</a></h4> | ||
| <section><p>Provides method to validate cluster configuration.</p> | ||
| </section> | ||
| </article> | ||
| </div> | ||
|
|
||
| <div class="hidden-sm col-md-2" role="complementary"> | ||
| <div class="sideaffix"> | ||
| <div class="contribution"> | ||
| <ul class="nav"> | ||
| </ul> | ||
| </div> | ||
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> | ||
| <h5>In This Article</h5> | ||
| <div></div> | ||
| </nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer> | ||
| <div class="grad-bottom"></div> | ||
| <div class="footer"> | ||
| <div class="container"> | ||
| <span class="pull-right"> | ||
| <a href="#top">Back to top</a> | ||
| </span> | ||
|
|
||
| <span>Generated by <strong>DocFX</strong></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </div> | ||
|
|
||
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script> | ||
| <script type="text/javascript" src="../styles/docfx.js"></script> | ||
| <script type="text/javascript" src="../styles/main.js"></script> | ||
| </body> | ||
| </html> |
Oops, something went wrong.