-
-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto-generated documentation from 8ff2900
- Loading branch information
Showing
16 changed files
with
2,173 additions
and
91 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
132 changes: 104 additions & 28 deletions
132
api/JsonApiDotNetCore.Configuration.JsonApiOptions.html
Large diffs are not rendered by default.
Oops, something went wrong.
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
177 changes: 177 additions & 0 deletions
177
api/JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.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,177 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Interface IJsonApiContentNegotiator </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Interface IJsonApiContentNegotiator "> | ||
|
|
||
| <meta name="description" content="Performs content negotiation for JSON:API requests."> | ||
| <link rel="icon" href="../favicon.ico"> | ||
| <link rel="stylesheet" href="../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../public/main.css"> | ||
| <meta name="docfx:navrel" content="../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/json-api-dotnet/JsonApiDotNetCore/new/master/apiSpec/new?filename=JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator.md&value=---%0Auid%3A%20JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator%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"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
|
|
||
| <script type="module" src="./../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
| </head> | ||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../index.html"> | ||
| <img id="logo" class="svg" src="../logo.svg" alt=""> | ||
|
|
||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator" class="text-break"> | ||
| Interface IJsonApiContentNegotiator <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L9"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.Middleware.html">Middleware</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"><p>Performs content negotiation for JSON:API requests.</p> | ||
| </div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public interface IJsonApiContentNegotiator</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.Negotiate*"></a> | ||
|
|
||
| <h3 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.Negotiate"> | ||
| Negotiate() | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L15"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Validates the Content-Type and Accept HTTP headers from the incoming request. Throws a <a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html">JsonApiException</a> if unsupported. Otherwise, | ||
| returns the list of negotiated JSON:API extensions, which should always be a subset of <a class="xref" href="JsonApiDotNetCore.Configuration.IJsonApiOptions.html#JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions">Extensions</a>.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">IReadOnlySet<JsonApiExtension> Negotiate()</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a><<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>></dt> | ||
| <dd></dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
| <div class="contribution d-print-none"> | ||
| <a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L9" class="edit-link">Edit this page</a> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| <span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span> | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </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
Oops, something went wrong.