Skip to content

Commit

Permalink
Update getting started to preview 6. Rebuild docs. (#475)
Browse files Browse the repository at this point in the history
  • Loading branch information
Tratcher authored Oct 16, 2020
1 parent 6311df4 commit b8720ba
Show file tree
Hide file tree
Showing 50 changed files with 7,731 additions and 222 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,60 @@ <h5 id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionEx
</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/master/apiSpec/new?filename=Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddHttpProxy_Microsoft_Extensions_DependencyInjection_IServiceCollection_.md&amp;value=---%0Auid%3A%20Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddHttpProxy(Microsoft.Extensions.DependencyInjection.IServiceCollection)%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/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L24">View Source</a>
</span>
<a id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddHttpProxy_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddHttpProxy*"></a>
<h4 id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddHttpProxy_Microsoft_Extensions_DependencyInjection_IServiceCollection_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddHttpProxy(Microsoft.Extensions.DependencyInjection.IServiceCollection)">AddHttpProxy(IServiceCollection)</h4>
<div class="markdown level1 summary"><p>Registers the <a class="xref" href="Microsoft.ReverseProxy.Service.Proxy.IHttpProxy.html">IHttpProxy</a> service for direct proxying scenarios.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static IServiceCollection AddHttpProxy(this IServiceCollection services)</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="https://docs.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></td>
<td><span class="parametername">services</span></td>
<td></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><a class="xref" href="https://docs.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddProxyConfigFilter__1_Microsoft_Extensions_DependencyInjection_IReverseProxyBuilder_.md&amp;value=---%0Auid%3A%20Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddProxyConfigFilter%60%601(Microsoft.Extensions.DependencyInjection.IReverseProxyBuilder)%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/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L58">View Source</a>
<a href="https://github.com/microsoft/reverse-proxy/blob/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L69">View Source</a>
</span>
<a id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddProxyConfigFilter_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddProxyConfigFilter*"></a>
<h4 id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddProxyConfigFilter__1_Microsoft_Extensions_DependencyInjection_IReverseProxyBuilder_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddProxyConfigFilter``1(Microsoft.Extensions.DependencyInjection.IReverseProxyBuilder)">AddProxyConfigFilter&lt;TService&gt;(IReverseProxyBuilder)</h4>
Expand Down Expand Up @@ -184,7 +232,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddReverseProxy_Microsoft_Extensions_DependencyInjection_IServiceCollection_.md&amp;value=---%0Auid%3A%20Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddReverseProxy(Microsoft.Extensions.DependencyInjection.IServiceCollection)%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/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L22">View Source</a>
<a href="https://github.com/microsoft/reverse-proxy/blob/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L33">View Source</a>
</span>
<a id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddReverseProxy_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddReverseProxy*"></a>
<h4 id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_AddReverseProxy_Microsoft_Extensions_DependencyInjection_IServiceCollection_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.AddReverseProxy(Microsoft.Extensions.DependencyInjection.IServiceCollection)">AddReverseProxy(IServiceCollection)</h4>
Expand Down Expand Up @@ -232,7 +280,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_LoadFromConfig_Microsoft_Extensions_DependencyInjection_IReverseProxyBuilder_Microsoft_Extensions_Configuration_IConfiguration_.md&amp;value=---%0Auid%3A%20Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.LoadFromConfig(Microsoft.Extensions.DependencyInjection.IReverseProxyBuilder%2CMicrosoft.Extensions.Configuration.IConfiguration)%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/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L45">View Source</a>
<a href="https://github.com/microsoft/reverse-proxy/blob/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L56">View Source</a>
</span>
<a id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_LoadFromConfig_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.LoadFromConfig*"></a>
<h4 id="Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions_LoadFromConfig_Microsoft_Extensions_DependencyInjection_IReverseProxyBuilder_Microsoft_Extensions_Configuration_IConfiguration_" data-uid="Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions.LoadFromConfig(Microsoft.Extensions.DependencyInjection.IReverseProxyBuilder,Microsoft.Extensions.Configuration.IConfiguration)">LoadFromConfig(IReverseProxyBuilder, IConfiguration)</h4>
Expand Down Expand Up @@ -291,7 +339,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_Extensions_DependencyInjection_ReverseProxyServiceCollectionExtensions.md&amp;value=---%0Auid%3A%20Microsoft.Extensions.DependencyInjection.ReverseProxyServiceCollectionExtensions%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/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L17" class="contribution-link">View Source</a>
<a href="https://github.com/microsoft/reverse-proxy/blob/master/src/ReverseProxy/Configuration/DependencyInjection/ReverseProxyServiceCollectionExtensions.cs/#L19" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Enum HeaderMatchMode
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum HeaderMatchMode
">
<meta name="generator" content="docfx 2.52.0.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="Microsoft.ReverseProxy.Abstractions.HeaderMatchMode">


<h1 id="Microsoft_ReverseProxy_Abstractions_HeaderMatchMode" data-uid="Microsoft.ReverseProxy.Abstractions.HeaderMatchMode" class="text-break">Enum HeaderMatchMode
</h1>
<div class="markdown level0 summary"><p>How to match header values.</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Microsoft.ReverseProxy.Abstractions.html">Microsoft.ReverseProxy.Abstractions</a></h6>
<h6><strong>Assembly</strong>: Microsoft.ReverseProxy.dll</h6>
<h5 id="Microsoft_ReverseProxy_Abstractions_HeaderMatchMode_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public enum HeaderMatchMode</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<thead>
<tbody>
<tr>
<td id="Microsoft_ReverseProxy_Abstractions_HeaderMatchMode_ExactHeader">ExactHeader</td>
<td><p>The header must match in its entirety, subject to case sensitivity settings.
Only single headers are supported. If there are multiple headers with the same name then the match fails.</p>
</td>
</tr>
<tr>
<td id="Microsoft_ReverseProxy_Abstractions_HeaderMatchMode_Exists">Exists</td>
<td><p>The header must exist and contain any non-empty value.</p>
</td>
</tr>
<tr>
<td id="Microsoft_ReverseProxy_Abstractions_HeaderMatchMode_HeaderPrefix">HeaderPrefix</td>
<td><p>The header must match by prefix, subject to case sensitivity settings.
Only single headers are supported. If there are multiple headers with the same name then the match fails.</p>
</td>
</tr>
</tbody>
</thead></thead></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/master/apiSpec/new?filename=Microsoft_ReverseProxy_Abstractions_HeaderMatchMode.md&amp;value=---%0Auid%3A%20Microsoft.ReverseProxy.Abstractions.HeaderMatchMode%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/master/src/ReverseProxy/Abstractions/RouteDiscovery/Contract/HeaderMatchMode.cs/#L11" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,37 @@ <h5 id="Microsoft_ReverseProxy_Abstractions_ProxyMatch_syntax">Syntax</h5>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_ReverseProxy_Abstractions_ProxyMatch_Headers.md&amp;value=---%0Auid%3A%20Microsoft.ReverseProxy.Abstractions.ProxyMatch.Headers%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/master/src/ReverseProxy/Abstractions/RouteDiscovery/Contract/ProxyMatch.cs/#L40">View Source</a>
</span>
<a id="Microsoft_ReverseProxy_Abstractions_ProxyMatch_Headers_" data-uid="Microsoft.ReverseProxy.Abstractions.ProxyMatch.Headers*"></a>
<h4 id="Microsoft_ReverseProxy_Abstractions_ProxyMatch_Headers" data-uid="Microsoft.ReverseProxy.Abstractions.ProxyMatch.Headers">Headers</h4>
<div class="markdown level1 summary"><p>Only match requests that contain all of these headers.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IReadOnlyList&lt;RouteHeader&gt; Headers { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="Microsoft.ReverseProxy.Abstractions.RouteHeader.html">RouteHeader</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/microsoft/reverse-proxy/new/master/apiSpec/new?filename=Microsoft_ReverseProxy_Abstractions_ProxyMatch_Hosts.md&amp;value=---%0Auid%3A%20Microsoft.ReverseProxy.Abstractions.ProxyMatch.Hosts%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>
Expand Down
Loading

0 comments on commit b8720ba

Please sign in to comment.