mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-24 21:46:52 +01:00
722 lines
123 KiB
HTML
722 lines
123 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>tgstation-server: src/Tgstation.Server.Host/Utils/SwaggerConfiguration.cs Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">tgstation-server<span id="projectnumber"> 6.19.3</span>
|
|
</div>
|
|
<div id="projectbrief">The /tg/station 13 server suite</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_e031aa0fb63a9784d5d0be33d19ac57a.html">Utils</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">SwaggerConfiguration.cs</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_swagger_configuration_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System;</div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Collections;</div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>System.Collections.Generic;</div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System.Linq;</div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>System.Net;</div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>System.Net.Mime;</div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>System.Reflection;</div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using </span>System.Text.RegularExpressions;</div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">using </span>Microsoft.Extensions.DependencyInjection;</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">using </span>Microsoft.Net.Http.Headers;</div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">using </span>Microsoft.OpenApi.Any;</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">using </span>Microsoft.OpenApi.Models;</div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">using </span>Swashbuckle.AspNetCore.SwaggerGen;</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api.html">Tgstation.Server.Api</a>;</div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a>;</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a>;</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_common_1_1_extensions.html">Tgstation.Server.Common.Extensions</a>;</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a>;</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a>;</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>{</div>
|
|
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html"> 29</a></span> <span class="keyword">sealed</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">SwaggerConfiguration</a> : <a class="code hl_class" href="class_i_operation_filter.html">IOperationFilter</a>, <a class="code hl_class" href="class_i_document_filter.html">IDocumentFilter</a>, <a class="code hl_class" href="class_i_schema_filter.html">ISchemaFilter</a>, <a class="code hl_class" href="class_i_request_body_filter.html">IRequestBodyFilter</a></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8b547109d306e44f64dbc80646858812"> 34</a></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8b547109d306e44f64dbc80646858812">DocumentName</a> = <span class="stringliteral">"tgs_api"</span>;</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a491cd42b9d11a659b718c70ebebb9014"> 39</a></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a491cd42b9d11a659b718c70ebebb9014">DocumentationSiteRouteExtension</a> = <span class="stringliteral">"documentation"</span>;</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7c7e4acf655dff5060d09fe3a10a035a"> 44</a></span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7c7e4acf655dff5060d09fe3a10a035a">PasswordSecuritySchemeId</a> = <span class="stringliteral">"Password_Login_Scheme"</span>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a490cbcecb61148a88e5f8c4f4043cee1"> 49</a></span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a490cbcecb61148a88e5f8c4f4043cee1">OAuthSecuritySchemeId</a> = <span class="stringliteral">"OAuth_Login_Scheme"</span>;</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8a92a78cf700a1637e98689dd8afa7f4"> 54</a></span> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8a92a78cf700a1637e98689dd8afa7f4">TokenSecuritySchemeId</a> = <span class="stringliteral">"Token_Authorization_Scheme"</span>;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="foldopen" id="foldopen00062" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7a8de5dbb9ef96b2ced6739f2afe3549"> 62</a></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7a8de5dbb9ef96b2ced6739f2afe3549">Configure</a>(SwaggerGenOptions swaggerGenOptions, <span class="keywordtype">string</span> assemblyDocumentationPath, <span class="keywordtype">string</span> apiDocumentationPath)</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> {</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> swaggerGenOptions.SwaggerDoc(</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8b547109d306e44f64dbc80646858812">DocumentName</a>,</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">new</span> OpenApiInfo</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> {</div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> Title = <span class="stringliteral">"TGS API"</span>,</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> Version = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a6741a096c8700041ac2995b55078302b">Version</a>.Semver().ToString(),</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> License = <span class="keyword">new</span> OpenApiLicense</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> {</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> Name = <span class="stringliteral">"AGPL-3.0"</span>,</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> Url = <span class="keyword">new</span> Uri(<span class="stringliteral">"https://github.com/tgstation/tgstation-server/blob/dev/LICENSE"</span>),</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> },</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> Contact = <span class="keyword">new</span> OpenApiContact</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> {</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> Name = <span class="stringliteral">"/tg/station 13"</span>,</div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> Url = <span class="keyword">new</span> Uri(<span class="stringliteral">"https://github.com/tgstation"</span>),</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> },</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> Description = <span class="stringliteral">"A production scale tool for DreamMaker server management"</span>,</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> });</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="comment">// Important to do this before applying our own filters</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// Otherwise we'll get NullReferenceExceptions on parameters to be setup in our document filter</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> swaggerGenOptions.IncludeXmlComments(assemblyDocumentationPath);</div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> swaggerGenOptions.IncludeXmlComments(apiDocumentationPath);</div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="comment">// nullable stuff</span></div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> swaggerGenOptions.UseAllOfToExtendReferenceSchemas();</div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> swaggerGenOptions.OperationFilter<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">SwaggerConfiguration</a>>();</div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> swaggerGenOptions.DocumentFilter<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">SwaggerConfiguration</a>>();</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> swaggerGenOptions.SchemaFilter<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">SwaggerConfiguration</a>>();</div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> swaggerGenOptions.RequestBodyFilter<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">SwaggerConfiguration</a>>();</div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> swaggerGenOptions.CustomSchemaIds(<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2a1c7a7fbfd7147ea7c5bafca2f73651">GenerateSchemaId</a>);</div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> swaggerGenOptions.AddSecurityDefinition(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7c7e4acf655dff5060d09fe3a10a035a">PasswordSecuritySchemeId</a>, <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> {</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> Type = SecuritySchemeType.Http,</div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> Name = HeaderNames.Authorization,</div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> Description = <span class="stringliteral">"Username & Password authentication to obtain an JWT token when doing a (POST /api)."</span>,</div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> Scheme = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a6bbe0fc133b7dde5ef8a6f1c8f0feb18">BasicAuthenticationScheme</a>,</div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> });</div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> swaggerGenOptions.AddSecurityDefinition(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a490cbcecb61148a88e5f8c4f4043cee1">OAuthSecuritySchemeId</a>, <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> {</div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> Type = SecuritySchemeType.Http,</div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> Name = HeaderNames.Authorization,</div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> Description = <span class="stringliteral">"OAuth2 based authentication."</span>,</div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> Scheme = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a16bcacbed6e65c329a4c7ec22f9d7479">OAuthAuthenticationScheme</a>,</div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> });</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> swaggerGenOptions.AddSecurityDefinition(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8a92a78cf700a1637e98689dd8afa7f4">TokenSecuritySchemeId</a>, <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> {</div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> Type = SecuritySchemeType.Http,</div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> Name = HeaderNames.Authorization,</div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> Description = <span class="stringliteral">"JWT Bearer token generated by the server (POST /api). You need this for most endpoints to work."</span>,</div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> Scheme = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#aa8e108c1ba26a8d57578f2d3b23ea394">BearerAuthenticationScheme</a>,</div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> BearerFormat = <span class="stringliteral">"JWT"</span>,</div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> });</div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
|
|
<div class="foldopen" id="foldopen00131" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ac7c84669ba2400c1673cba025f275fb9"> 131</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ac7c84669ba2400c1673cba025f275fb9">AddDefaultResponses</a>(OpenApiDocument document)</div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> {</div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span> var errorMessageContent = <span class="keyword">new</span> Dictionary<string, OpenApiMediaType></div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> {</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> {</div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> MediaTypeNames.Application.Json,</div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">new</span> OpenApiMediaType</div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> {</div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> Schema = <span class="keyword">new</span> OpenApiSchema</div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> {</div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> {</div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> Id = nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">ErrorMessageResponse</a>),</div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> Type = ReferenceType.Schema,</div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> },</div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> },</div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> }</div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> },</div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> };</div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">void</span> AddDefaultResponse(HttpStatusCode code, OpenApiResponse concrete)</div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> {</div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">string</span> responseKey = $<span class="stringliteral">"{(int)code}"</span>;</div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> </div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> document.Components.Responses.Add(responseKey, concrete);</div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> var referenceResponse = <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> {</div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> {</div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> Type = ReferenceType.Response,</div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> Id = responseKey,</div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> },</div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> };</div>
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> </div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keywordflow">foreach</span> (var operation <span class="keywordflow">in</span> document.Paths.SelectMany(path => path.Value.Operations))</div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> operation.Value.Responses.TryAdd(responseKey, referenceResponse);</div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> }</div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
|
|
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> AddDefaultResponse(HttpStatusCode.BadRequest, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> {</div>
|
|
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> Description = <span class="stringliteral">"A badly formatted request was made. See error message for details."</span>,</div>
|
|
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> Content = errorMessageContent,</div>
|
|
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> });</div>
|
|
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> </div>
|
|
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> AddDefaultResponse(HttpStatusCode.Unauthorized, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> {</div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> Description = <span class="stringliteral">"Invalid Authentication header."</span>,</div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> });</div>
|
|
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
|
|
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> AddDefaultResponse(HttpStatusCode.Forbidden, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> {</div>
|
|
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> Description = <span class="stringliteral">"User lacks sufficient permissions for the operation."</span>,</div>
|
|
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> });</div>
|
|
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> </div>
|
|
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> AddDefaultResponse(HttpStatusCode.Conflict, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> {</div>
|
|
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> Description = <span class="stringliteral">"A data integrity check failed while performing the operation. See error message for details."</span>,</div>
|
|
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> Content = errorMessageContent,</div>
|
|
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> });</div>
|
|
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span> </div>
|
|
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> AddDefaultResponse(HttpStatusCode.NotAcceptable, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> {</div>
|
|
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> Description = $<span class="stringliteral">"Invalid Accept header, TGS requires `{HeaderNames.Accept}: {MediaTypeNames.Application.Json}`."</span>,</div>
|
|
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> Content = errorMessageContent,</div>
|
|
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> });</div>
|
|
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> </div>
|
|
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> AddDefaultResponse(HttpStatusCode.InternalServerError, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> {</div>
|
|
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> Description = ErrorCode.InternalServerError.Describe(),</div>
|
|
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> Content = errorMessageContent,</div>
|
|
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> });</div>
|
|
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span> </div>
|
|
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> AddDefaultResponse(HttpStatusCode.ServiceUnavailable, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> {</div>
|
|
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> Description = <span class="stringliteral">"The server may be starting up or shutting down."</span>,</div>
|
|
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> });</div>
|
|
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> </div>
|
|
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> AddDefaultResponse(HttpStatusCode.NotImplemented, <span class="keyword">new</span> OpenApiResponse</div>
|
|
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> {</div>
|
|
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> Description = ErrorCode.RequiresPosixSystemIdentity.Describe(),</div>
|
|
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> Content = errorMessageContent,</div>
|
|
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> });</div>
|
|
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> </div>
|
|
<div class="foldopen" id="foldopen00221" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ae096775c5ebc422b2ef65548cb0b1f31"> 221</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ae096775c5ebc422b2ef65548cb0b1f31">ApplyAttributesForRootSchema</a>(OpenApiSchema rootSchema, SchemaFilterContext context)</div>
|
|
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> {</div>
|
|
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> <span class="comment">// tune up the descendants</span></div>
|
|
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> rootSchema.Nullable = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> var rootSchemaId = <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2a1c7a7fbfd7147ea7c5bafca2f73651">GenerateSchemaId</a>(context.Type);</div>
|
|
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> var rootRequestSchema = rootSchemaId.EndsWith(<span class="stringliteral">"Request"</span>, StringComparison.Ordinal);</div>
|
|
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> var rootResponseSchema = rootSchemaId.EndsWith(<span class="stringliteral">"Response"</span>, StringComparison.Ordinal);</div>
|
|
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> var isPutRequest = rootSchemaId.EndsWith(<span class="stringliteral">"CreateRequest"</span>, StringComparison.Ordinal);</div>
|
|
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> </div>
|
|
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>> GetTypeFromKvp(Type currentType, KeyValuePair<string, OpenApiSchema> kvp, IDictionary<string, OpenApiSchema> schemaDictionary)</div>
|
|
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> {</div>
|
|
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> var propertyInfo = currentType</div>
|
|
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> .GetProperties()</div>
|
|
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> .Single(x => x.Name.Equals(kvp.Key, StringComparison.OrdinalIgnoreCase));</div>
|
|
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> </div>
|
|
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> <span class="keywordflow">return</span> Tuple.Create(</div>
|
|
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> propertyInfo,</div>
|
|
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> kvp.Key,</div>
|
|
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> kvp.Value,</div>
|
|
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> schemaDictionary);</div>
|
|
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> }</div>
|
|
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> </div>
|
|
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> var subSchemaStack = <span class="keyword">new</span> Stack<Tuple<PropertyInfo, string, OpenApiSchema, IDictionary<string, OpenApiSchema>>>(</div>
|
|
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> rootSchema</div>
|
|
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> .Properties</div>
|
|
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> .Select(</div>
|
|
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> x => GetTypeFromKvp(context.Type, x, rootSchema.Properties))</div>
|
|
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> .Where(x => x.Item3.Reference == <span class="keyword">null</span>));</div>
|
|
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div>
|
|
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> <span class="keywordflow">while</span> (subSchemaStack.Count > 0)</div>
|
|
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span> {</div>
|
|
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> var tuple = subSchemaStack.Pop();</div>
|
|
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span> var subSchema = tuple.Item3;</div>
|
|
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"> 254</span> </div>
|
|
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span> var subSchemaPropertyInfo = tuple.Item1;</div>
|
|
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
|
|
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span> <span class="keywordflow">if</span> (subSchema.Properties != <span class="keyword">null</span></div>
|
|
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"> 258</span> && !subSchemaPropertyInfo</div>
|
|
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"> 259</span> .PropertyType</div>
|
|
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span> .GetInterfaces()</div>
|
|
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno"> 261</span> .Any(x => x == typeof(IEnumerable)))</div>
|
|
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span> <span class="keywordflow">foreach</span> (var kvp in subSchema.Properties.Where(x => x.Value.Reference == <span class="keyword">null</span>))</div>
|
|
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno"> 263</span> subSchemaStack.Push(GetTypeFromKvp(subSchemaPropertyInfo.PropertyType, kvp, subSchema.Properties));</div>
|
|
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno"> 264</span> </div>
|
|
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno"> 265</span> var attributes = subSchemaPropertyInfo</div>
|
|
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno"> 266</span> .GetCustomAttributes();</div>
|
|
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno"> 267</span> var responsePresence = attributes</div>
|
|
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> .OfType<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html">ResponseOptionsAttribute</a>>()</div>
|
|
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span> .FirstOrDefault()</div>
|
|
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"> 270</span> ?.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html#a5744f461c73911d0d65031704ca3ac00">Presence</a></div>
|
|
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span> ?? <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Required;</div>
|
|
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"> 272</span> var requestOptions = attributes</div>
|
|
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"> 273</span> .OfType<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_options_attribute.html">RequestOptionsAttribute</a>>()</div>
|
|
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"> 274</span> .OrderBy(x => x.PutOnly) <span class="comment">// Process PUTs last</span></div>
|
|
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"> 275</span> .ToList();</div>
|
|
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"> 276</span> </div>
|
|
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"> 277</span> <span class="keywordflow">if</span> (requestOptions.Count == 0 && requestOptions.All(x => x.Presence == <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Ignored && !x.PutOnly))</div>
|
|
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span> subSchema.ReadOnly = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno"> 279</span> </div>
|
|
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> var subSchemaId = tuple.Item2;</div>
|
|
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span> var subSchemaOwningDictionary = tuple.Item4;</div>
|
|
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno"> 282</span> <span class="keywordflow">if</span> (rootResponseSchema)</div>
|
|
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno"> 283</span> {</div>
|
|
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno"> 284</span> subSchema.Nullable = responsePresence == <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Optional;</div>
|
|
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno"> 285</span> <span class="keywordflow">if</span> (responsePresence == <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Ignored)</div>
|
|
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno"> 286</span> subSchemaOwningDictionary.Remove(subSchemaId);</div>
|
|
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno"> 287</span> }</div>
|
|
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"> 288</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (rootRequestSchema)</div>
|
|
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno"> 289</span> {</div>
|
|
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno"> 290</span> subSchema.Nullable = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno"> 291</span> var lastOptionWasIgnored = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span> <span class="keywordflow">foreach</span> (var requestOption <span class="keywordflow">in</span> requestOptions)</div>
|
|
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span> {</div>
|
|
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno"> 294</span> var validForThisRequest = !requestOption.PutOnly || isPutRequest;</div>
|
|
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno"> 295</span> <span class="keywordflow">if</span> (!validForThisRequest)</div>
|
|
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"> 296</span> <span class="keywordflow">continue</span>;</div>
|
|
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span> </div>
|
|
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"> 298</span> lastOptionWasIgnored = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno"> 299</span> <span class="keywordflow">switch</span> (requestOption.Presence)</div>
|
|
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"> 300</span> {</div>
|
|
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> <span class="keywordflow">case</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Ignored:</div>
|
|
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span> lastOptionWasIgnored = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span> <span class="keywordflow">case</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Optional:</div>
|
|
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span> subSchema.Nullable = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno"> 307</span> <span class="keywordflow">case</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Required:</div>
|
|
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno"> 308</span> subSchema.Nullable = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno"> 309</span> <span class="keywordflow">break</span>;</div>
|
|
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span> <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException($<span class="stringliteral">"Invalid FieldPresence: {requestOption.Presence}!"</span>);</div>
|
|
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno"> 312</span> }</div>
|
|
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno"> 313</span> }</div>
|
|
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"> 314</span> </div>
|
|
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span> <span class="keywordflow">if</span> (lastOptionWasIgnored)</div>
|
|
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span> subSchemaOwningDictionary.Remove(subSchemaId);</div>
|
|
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span> }</div>
|
|
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (responsePresence == <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Required</div>
|
|
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> && requestOptions.All(x => x.Presence == <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">FieldPresence</a>.Required && !x.PutOnly))</div>
|
|
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> subSchema.Nullable = subSchemaId.Equals(</div>
|
|
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span> nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html">TestMergeParameters</a>.<a class="code hl_property" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html#a1b7f38a2ee2f645796ffeb89fe51b2ce">TargetCommitSha</a>),</div>
|
|
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span> StringComparison.OrdinalIgnoreCase)</div>
|
|
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span> && rootSchemaId == nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html">TestMergeParameters</a>); <span class="comment">// special tactics</span></div>
|
|
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> </div>
|
|
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <span class="comment">// otherwise, we have to assume it's a shared schema</span></div>
|
|
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <span class="comment">// use what Swagger thinks the nullability is by default</span></div>
|
|
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span> }</div>
|
|
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> </div>
|
|
<div class="foldopen" id="foldopen00335" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2a1c7a7fbfd7147ea7c5bafca2f73651"> 335</a></span> <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2a1c7a7fbfd7147ea7c5bafca2f73651">GenerateSchemaId</a>(Type type)</div>
|
|
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno"> 336</span> {</div>
|
|
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span> <span class="keywordflow">if</span> (type == typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html">UserName</a>))</div>
|
|
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> <span class="keywordflow">return</span> <span class="stringliteral">"ShallowUserResponse"</span>;</div>
|
|
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span> </div>
|
|
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno"> 340</span> <span class="keywordflow">if</span> (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html">PaginatedResponse<></a>))</div>
|
|
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno"> 341</span> <span class="keywordflow">return</span> $<span class="stringliteral">"Paginated{type.GenericTypeArguments.First().Name}"</span>;</div>
|
|
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno"> 342</span> </div>
|
|
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno"> 343</span> <span class="keywordflow">return</span> type.Name;</div>
|
|
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno"> 344</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno"> 345</span> </div>
|
|
<div class="foldopen" id="foldopen00347" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ad42b61af703046605dcf2c27a3a76e14"> 347</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ad42b61af703046605dcf2c27a3a76e14">Apply</a>(OpenApiOperation operation, OperationFilterContext context)</div>
|
|
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno"> 348</span> {</div>
|
|
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno"> 349</span> ArgumentNullException.ThrowIfNull(operation);</div>
|
|
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno"> 350</span> ArgumentNullException.ThrowIfNull(context);</div>
|
|
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> </div>
|
|
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> operation.OperationId = $<span class="stringliteral">"{context.MethodInfo.DeclaringType!.Name}.{context.MethodInfo.Name}"</span>;</div>
|
|
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> </div>
|
|
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> var authAttributes = context</div>
|
|
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> .MethodInfo</div>
|
|
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span> .DeclaringType</div>
|
|
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno"> 357</span> .GetCustomAttributes(<span class="keyword">true</span>)</div>
|
|
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> .Union(</div>
|
|
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno"> 359</span> context</div>
|
|
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno"> 360</span> .MethodInfo</div>
|
|
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno"> 361</span> .GetCustomAttributes(<span class="keyword">true</span>))</div>
|
|
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno"> 362</span> .OfType<<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_tgs_authorize_attribute.html">TgsAuthorizeAttribute</a>>();</div>
|
|
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno"> 363</span> </div>
|
|
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno"> 364</span> <span class="keywordflow">if</span> (authAttributes.Any())</div>
|
|
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"> 365</span> {</div>
|
|
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno"> 366</span> var tokenScheme = <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno"> 367</span> {</div>
|
|
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno"> 368</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno"> 369</span> {</div>
|
|
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno"> 370</span> Type = ReferenceType.SecurityScheme,</div>
|
|
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno"> 371</span> Id = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8a92a78cf700a1637e98689dd8afa7f4">TokenSecuritySchemeId</a>,</div>
|
|
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"> 372</span> },</div>
|
|
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno"> 373</span> };</div>
|
|
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno"> 374</span> </div>
|
|
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno"> 375</span> operation.Security = <span class="keyword">new</span> List<OpenApiSecurityRequirement>()</div>
|
|
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span> {</div>
|
|
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno"> 377</span> <span class="keyword">new</span>()</div>
|
|
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno"> 378</span> {</div>
|
|
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span> { tokenScheme, <span class="keyword">new</span> List<string>() },</div>
|
|
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> },</div>
|
|
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> };</div>
|
|
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> </div>
|
|
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span> <span class="keywordflow">if</span> (typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">InstanceRequiredController</a>).IsAssignableFrom(context.MethodInfo.DeclaringType))</div>
|
|
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span> operation.Parameters.Insert(0, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> {</div>
|
|
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> {</div>
|
|
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span> Type = ReferenceType.Parameter,</div>
|
|
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span> Id = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a28f94492eb21542e63675a53d871e3ef">InstanceIdHeader</a>,</div>
|
|
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> },</div>
|
|
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno"> 391</span> });</div>
|
|
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno"> 392</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (typeof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html">TransferController</a>).IsAssignableFrom(context.MethodInfo.DeclaringType))</div>
|
|
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno"> 393</span> <span class="keywordflow">if</span> (context.MethodInfo.Name == nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html">TransferController</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html#a6ad5ecb6e2fd792b0b3e88675e86e8cb">Upload</a>))</div>
|
|
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno"> 394</span> operation.RequestBody = <span class="keyword">new</span> OpenApiRequestBody</div>
|
|
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno"> 395</span> {</div>
|
|
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno"> 396</span> Content = <span class="keyword">new</span> Dictionary<string, OpenApiMediaType></div>
|
|
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno"> 397</span> {</div>
|
|
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno"> 398</span> {</div>
|
|
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno"> 399</span> MediaTypeNames.Application.Octet,</div>
|
|
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno"> 400</span> <span class="keyword">new</span> OpenApiMediaType</div>
|
|
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno"> 401</span> {</div>
|
|
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno"> 402</span> Schema = <span class="keyword">new</span> OpenApiSchema</div>
|
|
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno"> 403</span> {</div>
|
|
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno"> 404</span> Type = <span class="stringliteral">"string"</span>,</div>
|
|
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno"> 405</span> Format = <span class="stringliteral">"binary"</span>,</div>
|
|
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno"> 406</span> },</div>
|
|
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno"> 407</span> }</div>
|
|
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno"> 408</span> },</div>
|
|
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno"> 409</span> },</div>
|
|
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno"> 410</span> };</div>
|
|
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno"> 411</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (context.MethodInfo.Name == nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html">TransferController</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html#a199627b7cb0d306297b5bdbf3db04f9f">Download</a>))</div>
|
|
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno"> 412</span> {</div>
|
|
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno"> 413</span> var twoHundredResponseContents = operation.Responses[<span class="stringliteral">"200"</span>].Content;</div>
|
|
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno"> 414</span> var fileContent = twoHundredResponseContents[MediaTypeNames.Application.Json];</div>
|
|
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno"> 415</span> twoHundredResponseContents.Remove(MediaTypeNames.Application.Json);</div>
|
|
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno"> 416</span> twoHundredResponseContents.Add(MediaTypeNames.Application.Octet, fileContent);</div>
|
|
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno"> 417</span> }</div>
|
|
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno"> 418</span> }</div>
|
|
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno"> 419</span> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (context.MethodInfo.Name == nameof(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html">ApiRootController</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html#a312331c3db52428a3d06f9967ec56cd8">CreateToken</a>))</div>
|
|
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno"> 420</span> {</div>
|
|
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno"> 421</span> var passwordScheme = <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno"> 422</span> {</div>
|
|
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno"> 423</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno"> 424</span> {</div>
|
|
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno"> 425</span> Type = ReferenceType.SecurityScheme,</div>
|
|
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno"> 426</span> Id = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7c7e4acf655dff5060d09fe3a10a035a">PasswordSecuritySchemeId</a>,</div>
|
|
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno"> 427</span> },</div>
|
|
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno"> 428</span> };</div>
|
|
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno"> 429</span> </div>
|
|
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> var oAuthScheme = <span class="keyword">new</span> OpenApiSecurityScheme</div>
|
|
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span> {</div>
|
|
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno"> 432</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno"> 433</span> {</div>
|
|
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno"> 434</span> Type = ReferenceType.SecurityScheme,</div>
|
|
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno"> 435</span> Id = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a490cbcecb61148a88e5f8c4f4043cee1">OAuthSecuritySchemeId</a>,</div>
|
|
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno"> 436</span> },</div>
|
|
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno"> 437</span> };</div>
|
|
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno"> 438</span> </div>
|
|
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno"> 439</span> operation.Parameters.Add(<span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> {</div>
|
|
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno"> 441</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno"> 442</span> Name = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#aed33a94614774ed99f9fa355dd4a3ddd">OAuthProviderHeader</a>,</div>
|
|
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno"> 443</span> Description = <span class="stringliteral">"The external OAuth service provider."</span>,</div>
|
|
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno"> 444</span> Style = ParameterStyle.Simple,</div>
|
|
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno"> 445</span> Example = <span class="keyword">new</span> OpenApiString(<span class="stringliteral">"Discord"</span>),</div>
|
|
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> Schema = <span class="keyword">new</span> OpenApiSchema</div>
|
|
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> {</div>
|
|
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno"> 448</span> Type = <span class="stringliteral">"string"</span>,</div>
|
|
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> },</div>
|
|
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno"> 450</span> });</div>
|
|
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno"> 451</span> </div>
|
|
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno"> 452</span> operation.Security = <span class="keyword">new</span> List<OpenApiSecurityRequirement></div>
|
|
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno"> 453</span> {</div>
|
|
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno"> 454</span> <span class="keyword">new</span>()</div>
|
|
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno"> 455</span> {</div>
|
|
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno"> 456</span> {</div>
|
|
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno"> 457</span> passwordScheme,</div>
|
|
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno"> 458</span> <span class="keyword">new</span> List<string>()</div>
|
|
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno"> 459</span> },</div>
|
|
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno"> 460</span> {</div>
|
|
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno"> 461</span> oAuthScheme,</div>
|
|
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno"> 462</span> <span class="keyword">new</span> List<string>()</div>
|
|
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno"> 463</span> },</div>
|
|
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno"> 464</span> },</div>
|
|
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno"> 465</span> };</div>
|
|
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno"> 466</span> }</div>
|
|
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno"> 467</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno"> 468</span> </div>
|
|
<div class="foldopen" id="foldopen00470" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a5fa0a6137981895643b5e2d026c243d1"> 470</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a5fa0a6137981895643b5e2d026c243d1">Apply</a>(OpenApiDocument swaggerDoc, DocumentFilterContext context)</div>
|
|
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno"> 471</span> {</div>
|
|
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno"> 472</span> ArgumentNullException.ThrowIfNull(swaggerDoc);</div>
|
|
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno"> 473</span> ArgumentNullException.ThrowIfNull(context);</div>
|
|
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno"> 474</span> </div>
|
|
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno"> 475</span> swaggerDoc.ExternalDocs = <span class="keyword">new</span> OpenApiExternalDocs</div>
|
|
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno"> 476</span> {</div>
|
|
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno"> 477</span> Description = <span class="stringliteral">"API Usage Documentation"</span>,</div>
|
|
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno"> 478</span> Url = <span class="keyword">new</span> Uri(<span class="stringliteral">"https://tgstation.github.io/tgstation-server/api.html"</span>),</div>
|
|
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno"> 479</span> };</div>
|
|
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno"> 480</span> </div>
|
|
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno"> 481</span> swaggerDoc.Components.Parameters.Add(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a28f94492eb21542e63675a53d871e3ef">InstanceIdHeader</a>, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"> 482</span> {</div>
|
|
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno"> 483</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno"> 484</span> Name = ApiHeaders.InstanceIdHeader,</div>
|
|
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno"> 485</span> Description = <span class="stringliteral">"The instance ID being accessed"</span>,</div>
|
|
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno"> 486</span> Required = true,</div>
|
|
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno"> 487</span> Style = ParameterStyle.Simple,</div>
|
|
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno"> 488</span> Schema = new OpenApiSchema</div>
|
|
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno"> 489</span> {</div>
|
|
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno"> 490</span> Type = <span class="stringliteral">"integer"</span>,</div>
|
|
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno"> 491</span> },</div>
|
|
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno"> 492</span> });</div>
|
|
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno"> 493</span> </div>
|
|
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno"> 494</span> var productHeaderSchema = <span class="keyword">new</span> OpenApiSchema</div>
|
|
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno"> 495</span> {</div>
|
|
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno"> 496</span> Type = <span class="stringliteral">"string"</span>,</div>
|
|
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno"> 497</span> };</div>
|
|
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno"> 498</span> </div>
|
|
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno"> 499</span> swaggerDoc.Components.Parameters.Add(<a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a99649cb8fbf286c635b109e8373b415e">ApiVersionHeader</a>, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno"> 500</span> {</div>
|
|
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno"> 501</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno"> 502</span> Name = ApiHeaders.ApiVersionHeader,</div>
|
|
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno"> 503</span> Description = <span class="stringliteral">"The API version being used in the form \"Tgstation.Server.Api/[API version]\""</span>,</div>
|
|
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno"> 504</span> Required = true,</div>
|
|
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno"> 505</span> Style = ParameterStyle.Simple,</div>
|
|
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno"> 506</span> Example = new OpenApiString($<span class="stringliteral">"Tgstation.Server.Api/{ApiHeaders.Version}"</span>),</div>
|
|
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno"> 507</span> Schema = productHeaderSchema,</div>
|
|
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno"> 508</span> });</div>
|
|
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno"> 509</span> </div>
|
|
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno"> 510</span> swaggerDoc.Components.Parameters.Add(HeaderNames.UserAgent, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno"> 511</span> {</div>
|
|
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno"> 512</span> In = ParameterLocation.Header,</div>
|
|
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno"> 513</span> Name = HeaderNames.UserAgent,</div>
|
|
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno"> 514</span> Description = <span class="stringliteral">"The user agent of the calling client."</span>,</div>
|
|
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno"> 515</span> Required = true,</div>
|
|
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno"> 516</span> Style = ParameterStyle.Simple,</div>
|
|
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno"> 517</span> Example = new OpenApiString(<span class="stringliteral">"Your-user-agent/1.0.0.0"</span>),</div>
|
|
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno"> 518</span> Schema = productHeaderSchema,</div>
|
|
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno"> 519</span> });</div>
|
|
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno"> 520</span> </div>
|
|
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno"> 521</span> var allSchemas = context</div>
|
|
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span> .SchemaRepository</div>
|
|
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno"> 523</span> .Schemas;</div>
|
|
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> <span class="keywordflow">foreach</span> (var path <span class="keywordflow">in</span> swaggerDoc.Paths)</div>
|
|
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span> <span class="keywordflow">foreach</span> (var operation <span class="keywordflow">in</span> path.Value.Operations.Select(x => x.Value))</div>
|
|
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno"> 526</span> {</div>
|
|
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno"> 527</span> operation.Parameters.Insert(0, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno"> 528</span> {</div>
|
|
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno"> 529</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno"> 530</span> {</div>
|
|
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno"> 531</span> Type = ReferenceType.Parameter,</div>
|
|
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno"> 532</span> Id = <a class="code hl_class" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">ApiHeaders</a>.<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a99649cb8fbf286c635b109e8373b415e">ApiVersionHeader</a>,</div>
|
|
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno"> 533</span> },</div>
|
|
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno"> 534</span> });</div>
|
|
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno"> 535</span> </div>
|
|
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno"> 536</span> operation.Parameters.Insert(1, <span class="keyword">new</span> OpenApiParameter</div>
|
|
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno"> 537</span> {</div>
|
|
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno"> 538</span> Reference = <span class="keyword">new</span> OpenApiReference</div>
|
|
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno"> 539</span> {</div>
|
|
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"> 540</span> Type = ReferenceType.Parameter,</div>
|
|
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno"> 541</span> Id = HeaderNames.UserAgent,</div>
|
|
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno"> 542</span> },</div>
|
|
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno"> 543</span> });</div>
|
|
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno"> 544</span> </div>
|
|
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno"> 545</span> <span class="comment">// flatten (Tgstation.Server.*).MyClass</span></div>
|
|
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno"> 546</span> <span class="keywordflow">if</span> (operation.Description?.Length > 0)</div>
|
|
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno"> 547</span> operation.Description = Regex.Replace(operation.Description, <span class="stringliteral">@"Tgstation\.Server\.(\w+\.)+(?=\w+)"</span>, <span class="keywordtype">string</span>.Empty);</div>
|
|
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno"> 548</span> </div>
|
|
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno"> 549</span> <span class="keywordflow">if</span> (operation.Summary?.Length > 0)</div>
|
|
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno"> 550</span> operation.Summary = Regex.Replace(operation.Summary, <span class="stringliteral">@"Tgstation\.Server\.(\w+\.)+(?=\w+)"</span>, <span class="keywordtype">string</span>.Empty);</div>
|
|
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno"> 551</span> </div>
|
|
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno"> 552</span> <span class="keywordflow">if</span> (operation.RequestBody?.Description != <span class="keyword">null</span>)</div>
|
|
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno"> 553</span> operation.RequestBody.Description = Regex.Replace(operation.RequestBody.Description, <span class="stringliteral">@"Tgstation\.Server\.(\w+\.)+(?=\w+)"</span>, <span class="keywordtype">string</span>.Empty);</div>
|
|
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno"> 554</span> </div>
|
|
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno"> 555</span> <span class="keywordflow">foreach</span> (var opPar <span class="keywordflow">in</span> operation.Parameters)</div>
|
|
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno"> 556</span> {</div>
|
|
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno"> 557</span> <span class="keywordflow">if</span> (opPar.Description != <span class="keyword">null</span>)</div>
|
|
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno"> 558</span> opPar.Description = Regex.Replace(opPar.Description, <span class="stringliteral">@"Tgstation\.Server\.(\w+\.)+(?=\w+)"</span>, <span class="keywordtype">string</span>.Empty);</div>
|
|
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno"> 559</span> }</div>
|
|
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno"> 560</span> </div>
|
|
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno"> 561</span> <span class="keywordflow">foreach</span> (var (_, opRes) in operation.Responses)</div>
|
|
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno"> 562</span> {</div>
|
|
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno"> 563</span> <span class="keywordflow">if</span> (opRes.Description != <span class="keyword">null</span>)</div>
|
|
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno"> 564</span> opRes.Description = Regex.Replace(opRes.Description, <span class="stringliteral">@"Tgstation\.Server\.(\w+\.)+(?=\w+)"</span>, <span class="keywordtype">string</span>.Empty);</div>
|
|
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno"> 565</span> }</div>
|
|
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno"> 566</span> }</div>
|
|
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno"> 567</span> </div>
|
|
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno"> 568</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ac7c84669ba2400c1673cba025f275fb9">AddDefaultResponses</a>(swaggerDoc);</div>
|
|
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno"> 569</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno"> 570</span> </div>
|
|
<div class="foldopen" id="foldopen00572" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a63dc57c725c0f96c85f18c55f4d17bc5"> 572</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a63dc57c725c0f96c85f18c55f4d17bc5">Apply</a>(OpenApiSchema schema, SchemaFilterContext context)</div>
|
|
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno"> 573</span> {</div>
|
|
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno"> 574</span> ArgumentNullException.ThrowIfNull(schema);</div>
|
|
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno"> 575</span> ArgumentNullException.ThrowIfNull(context);</div>
|
|
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno"> 576</span> </div>
|
|
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno"> 577</span> <span class="comment">// Nothing is required</span></div>
|
|
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno"> 578</span> schema.Required.Clear();</div>
|
|
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno"> 579</span> </div>
|
|
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno"> 580</span> <span class="keywordflow">if</span> (context.MemberInfo == <span class="keyword">null</span>)</div>
|
|
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno"> 581</span> ApplyAttributesForRootSchema(schema, context);</div>
|
|
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno"> 582</span> </div>
|
|
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno"> 583</span> <span class="keywordflow">if</span> (!schema.Enum?.Any() ?? <span class="keyword">false</span>)</div>
|
|
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno"> 584</span> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno"> 585</span> </div>
|
|
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno"> 586</span> <span class="comment">// Could be nullable type, make sure to get the right one</span></div>
|
|
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno"> 587</span> Type firstGenericArgumentOrType = context.Type.IsConstructedGenericType</div>
|
|
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno"> 588</span> ? context.Type.GenericTypeArguments.First()</div>
|
|
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno"> 589</span> : context.Type;</div>
|
|
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno"> 590</span> </div>
|
|
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno"> 591</span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html">OpenApiEnumVarNamesExtension</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#a93407e10fe77d7c7f39084d4b1e3308f">Apply</a>(schema, firstGenericArgumentOrType);</div>
|
|
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno"> 592</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno"> 593</span> </div>
|
|
<div class="foldopen" id="foldopen00595" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2f69c8b93d19b133a81a669f025ec108"> 595</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2f69c8b93d19b133a81a669f025ec108">Apply</a>(OpenApiRequestBody requestBody, RequestBodyFilterContext context)</div>
|
|
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno"> 596</span> {</div>
|
|
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno"> 597</span> ArgumentNullException.ThrowIfNull(requestBody);</div>
|
|
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno"> 598</span> ArgumentNullException.ThrowIfNull(context);</div>
|
|
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno"> 599</span> </div>
|
|
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno"> 600</span> requestBody.Required = <span class="keyword">true</span>;</div>
|
|
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno"> 601</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno"> 602</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno"> 603</span>}</div>
|
|
<div class="ttc" id="aclass_i_document_filter_html"><div class="ttname"><a href="class_i_document_filter.html">IDocumentFilter</a></div></div>
|
|
<div class="ttc" id="aclass_i_operation_filter_html"><div class="ttname"><a href="class_i_operation_filter.html">IOperationFilter</a></div></div>
|
|
<div class="ttc" id="aclass_i_request_body_filter_html"><div class="ttname"><a href="class_i_request_body_filter.html">IRequestBodyFilter</a></div></div>
|
|
<div class="ttc" id="aclass_i_schema_filter_html"><div class="ttname"><a href="class_i_schema_filter.html">ISchemaFilter</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html">Tgstation.Server.Api.ApiHeaders</a></div><div class="ttdoc">Represents the header that must be present for every server request.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00024">ApiHeaders.cs:25</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a16bcacbed6e65c329a4c7ec22f9d7479"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a16bcacbed6e65c329a4c7ec22f9d7479">Tgstation.Server.Api.ApiHeaders.OAuthAuthenticationScheme</a></div><div class="ttdeci">const string OAuthAuthenticationScheme</div><div class="ttdoc">The JWT authentication header scheme.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00054">ApiHeaders.cs:54</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a28f94492eb21542e63675a53d871e3ef"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a28f94492eb21542e63675a53d871e3ef">Tgstation.Server.Api.ApiHeaders.InstanceIdHeader</a></div><div class="ttdeci">const string InstanceIdHeader</div><div class="ttdoc">The InstanceId header key.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00034">ApiHeaders.cs:34</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a6741a096c8700041ac2995b55078302b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a6741a096c8700041ac2995b55078302b">Tgstation.Server.Api.ApiHeaders.Version</a></div><div class="ttdeci">static readonly Version Version</div><div class="ttdoc">Get the version of the Api the caller is using.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00069">ApiHeaders.cs:69</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a6bbe0fc133b7dde5ef8a6f1c8f0feb18"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a6bbe0fc133b7dde5ef8a6f1c8f0feb18">Tgstation.Server.Api.ApiHeaders.BasicAuthenticationScheme</a></div><div class="ttdeci">const string BasicAuthenticationScheme</div><div class="ttdoc">The JWT authentication header scheme.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00049">ApiHeaders.cs:49</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_a99649cb8fbf286c635b109e8373b415e"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#a99649cb8fbf286c635b109e8373b415e">Tgstation.Server.Api.ApiHeaders.ApiVersionHeader</a></div><div class="ttdeci">const string ApiVersionHeader</div><div class="ttdoc">The ApiVersion header key.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00029">ApiHeaders.cs:29</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_aa8e108c1ba26a8d57578f2d3b23ea394"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#aa8e108c1ba26a8d57578f2d3b23ea394">Tgstation.Server.Api.ApiHeaders.BearerAuthenticationScheme</a></div><div class="ttdeci">const string BearerAuthenticationScheme</div><div class="ttdoc">The JWT authentication header scheme.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00044">ApiHeaders.cs:44</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_api_headers_html_aed33a94614774ed99f9fa355dd4a3ddd"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_api_headers.html#aed33a94614774ed99f9fa355dd4a3ddd">Tgstation.Server.Api.ApiHeaders.OAuthProviderHeader</a></div><div class="ttdeci">const string OAuthProviderHeader</div><div class="ttdoc">The OAuthProvider header key.</div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00039">ApiHeaders.cs:39</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_options_attribute_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_request_options_attribute.html">Tgstation.Server.Api.Models.RequestOptionsAttribute</a></div><div class="ttdoc">Indicates the FieldPresence for fields in models.</div><div class="ttdef"><b>Definition</b> <a href="_request_options_attribute_8cs_source.html#l00009">RequestOptionsAttribute.cs:10</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_error_message_response.html">Tgstation.Server.Api.Models.Response.ErrorMessageResponse</a></div><div class="ttdoc">Represents an error message returned by the server.</div><div class="ttdef"><b>Definition</b> <a href="_error_message_response_8cs_source.html#l00011">ErrorMessageResponse.cs:12</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_1_1_paginated_response.html">Tgstation.Server.Api.Models.Response.PaginatedResponse</a></div><div class="ttdoc">Represents a paginated set of models.</div><div class="ttdef"><b>Definition</b> <a href="_paginated_response_8cs_source.html#l00010">PaginatedResponse.cs:11</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html">Tgstation.Server.Api.Models.ResponseOptionsAttribute</a></div><div class="ttdoc">Indicates the response FieldPresence of API fields. Changes it from FieldPresence....</div><div class="ttdef"><b>Definition</b> <a href="_response_options_attribute_8cs_source.html#l00009">ResponseOptionsAttribute.cs:10</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute_html_a5744f461c73911d0d65031704ca3ac00"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_options_attribute.html#a5744f461c73911d0d65031704ca3ac00">Tgstation.Server.Api.Models.ResponseOptionsAttribute.Presence</a></div><div class="ttdeci">FieldPresence Presence</div><div class="ttdoc">The FieldPresence.</div><div class="ttdef"><b>Definition</b> <a href="_response_options_attribute_8cs_source.html#l00014">ResponseOptionsAttribute.cs:14</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html">Tgstation.Server.Api.Models.TestMergeParameters</a></div><div class="ttdoc">Parameters for creating a TestMerge.</div><div class="ttdef"><b>Definition</b> <a href="_test_merge_parameters_8cs_source.html#l00008">TestMergeParameters.cs:9</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters_html_a1b7f38a2ee2f645796ffeb89fe51b2ce"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_test_merge_parameters.html#a1b7f38a2ee2f645796ffeb89fe51b2ce">Tgstation.Server.Api.Models.TestMergeParameters.TargetCommitSha</a></div><div class="ttdeci">virtual ? string TargetCommitSha</div><div class="ttdoc">The sha of the test merge revision to merge. If not specified, the latest commit from the source will...</div><div class="ttdef"><b>Definition</b> <a href="_test_merge_parameters_8cs_source.html#l00022">TestMergeParameters.cs:22</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_api_1_1_models_1_1_user_name.html">Tgstation.Server.Api.Models.UserName</a></div><div class="ttdoc">Base class for user names.</div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_user_name_8cs_source.html#l00006">UserName.cs:7</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html">Tgstation.Server.Host.Controllers.ApiRootController</a></div><div class="ttdoc">Root ApiController for the Application.</div><div class="ttdef"><b>Definition</b> <a href="_api_root_controller_8cs_source.html#l00035">ApiRootController.cs:36</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller_html_a312331c3db52428a3d06f9967ec56cd8"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_api_root_controller.html#a312331c3db52428a3d06f9967ec56cd8">Tgstation.Server.Host.Controllers.ApiRootController.CreateToken</a></div><div class="ttdeci">ValueTask< IActionResult > CreateToken(CancellationToken cancellationToken)</div><div class="ttdoc">Attempt to authenticate a User using ApiController.ApiHeaders.</div><div class="ttdef"><b>Definition</b> <a href="_api_root_controller_8cs_source.html#l00189">ApiRootController.cs:189</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">Tgstation.Server.Host.Controllers.InstanceRequiredController</a></div><div class="ttdoc">ComponentInterfacingController for operations that require an instance.</div><div class="ttdef"><b>Definition</b> <a href="_instance_required_controller_8cs_source.html#l00013">InstanceRequiredController.cs:14</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html">Tgstation.Server.Host.Controllers.TransferController</a></div><div class="ttdoc">ApiController for file streaming.</div><div class="ttdef"><b>Definition</b> <a href="_transfer_controller_8cs_source.html#l00026">TransferController.cs:27</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller_html_a199627b7cb0d306297b5bdbf3db04f9f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html#a199627b7cb0d306297b5bdbf3db04f9f">Tgstation.Server.Host.Controllers.TransferController.Download</a></div><div class="ttdeci">ValueTask< IActionResult > Download([Required, FromQuery] string ticket, CancellationToken cancellationToken)</div><div class="ttdoc">Downloads a file with a given ticket .</div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller_html_a6ad5ecb6e2fd792b0b3e88675e86e8cb"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_transfer_controller.html#a6ad5ecb6e2fd792b0b3e88675e86e8cb">Tgstation.Server.Host.Controllers.TransferController.Upload</a></div><div class="ttdeci">async ValueTask< IActionResult > Upload([Required, FromQuery] string ticket, CancellationToken cancellationToken)</div><div class="ttdoc">Uploads a file with a given ticket .</div><div class="ttdef"><b>Definition</b> <a href="_transfer_controller_8cs_source.html#l00086">TransferController.cs:86</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_security_1_1_tgs_authorize_attribute_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_security_1_1_tgs_authorize_attribute.html">Tgstation.Server.Host.Security.TgsAuthorizeAttribute</a></div><div class="ttdoc">Helper for using the AuthorizeAttribute with the Api.Rights system.</div><div class="ttdef"><b>Definition</b> <a href="_tgs_authorize_attribute_8cs_source.html#l00016">TgsAuthorizeAttribute.cs:17</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html">Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension</a></div><div class="ttdoc">Implements the "x-enum-varnames" OpenAPI 3.0 extension.</div><div class="ttdef"><b>Definition</b> <a href="_open_api_enum_var_names_extension_8cs_source.html#l00013">OpenApiEnumVarNamesExtension.cs:14</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension_html_a93407e10fe77d7c7f39084d4b1e3308f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#a93407e10fe77d7c7f39084d4b1e3308f">Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.Apply</a></div><div class="ttdeci">static void Apply(OpenApiSchema openApiSchema, Type enumType)</div><div class="ttdoc">Applies the extension to a give openApiSchema .</div><div class="ttdef"><b>Definition</b> <a href="_open_api_enum_var_names_extension_8cs_source.html#l00034">OpenApiEnumVarNamesExtension.cs:34</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html">Tgstation.Server.Host.Utils.SwaggerConfiguration</a></div><div class="ttdoc">Implements various filters for Swashbuckle.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00029">SwaggerConfiguration.cs:30</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a2a1c7a7fbfd7147ea7c5bafca2f73651"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2a1c7a7fbfd7147ea7c5bafca2f73651">Tgstation.Server.Host.Utils.SwaggerConfiguration.GenerateSchemaId</a></div><div class="ttdeci">static string GenerateSchemaId(Type type)</div><div class="ttdoc">Generates the OpenAPI schema ID for a given type .</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00335">SwaggerConfiguration.cs:335</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a2f69c8b93d19b133a81a669f025ec108"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a2f69c8b93d19b133a81a669f025ec108">Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply</a></div><div class="ttdeci">void Apply(OpenApiRequestBody requestBody, RequestBodyFilterContext context)</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00595">SwaggerConfiguration.cs:595</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a490cbcecb61148a88e5f8c4f4043cee1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a490cbcecb61148a88e5f8c4f4043cee1">Tgstation.Server.Host.Utils.SwaggerConfiguration.OAuthSecuritySchemeId</a></div><div class="ttdeci">const string OAuthSecuritySchemeId</div><div class="ttdoc">The OpenApiSecurityScheme name for OAuth 2.0 authentication.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00049">SwaggerConfiguration.cs:49</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a491cd42b9d11a659b718c70ebebb9014"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a491cd42b9d11a659b718c70ebebb9014">Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentationSiteRouteExtension</a></div><div class="ttdeci">const string DocumentationSiteRouteExtension</div><div class="ttdoc">The path to the hosted documentation site.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00039">SwaggerConfiguration.cs:39</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a5fa0a6137981895643b5e2d026c243d1"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a5fa0a6137981895643b5e2d026c243d1">Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply</a></div><div class="ttdeci">void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00470">SwaggerConfiguration.cs:470</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a63dc57c725c0f96c85f18c55f4d17bc5"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a63dc57c725c0f96c85f18c55f4d17bc5">Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply</a></div><div class="ttdeci">void Apply(OpenApiSchema schema, SchemaFilterContext context)</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00572">SwaggerConfiguration.cs:572</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a7a8de5dbb9ef96b2ced6739f2afe3549"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7a8de5dbb9ef96b2ced6739f2afe3549">Tgstation.Server.Host.Utils.SwaggerConfiguration.Configure</a></div><div class="ttdeci">static void Configure(SwaggerGenOptions swaggerGenOptions, string assemblyDocumentationPath, string apiDocumentationPath)</div><div class="ttdoc">Configure the swagger settings.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00062">SwaggerConfiguration.cs:62</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a7c7e4acf655dff5060d09fe3a10a035a"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a7c7e4acf655dff5060d09fe3a10a035a">Tgstation.Server.Host.Utils.SwaggerConfiguration.PasswordSecuritySchemeId</a></div><div class="ttdeci">const string PasswordSecuritySchemeId</div><div class="ttdoc">The OpenApiSecurityScheme name for password authentication.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00044">SwaggerConfiguration.cs:44</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a8a92a78cf700a1637e98689dd8afa7f4"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8a92a78cf700a1637e98689dd8afa7f4">Tgstation.Server.Host.Utils.SwaggerConfiguration.TokenSecuritySchemeId</a></div><div class="ttdeci">const string TokenSecuritySchemeId</div><div class="ttdoc">The OpenApiSecurityScheme name for token authentication.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00054">SwaggerConfiguration.cs:54</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_a8b547109d306e44f64dbc80646858812"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#a8b547109d306e44f64dbc80646858812">Tgstation.Server.Host.Utils.SwaggerConfiguration.DocumentName</a></div><div class="ttdeci">const string DocumentName</div><div class="ttdoc">The name of the swagger document.</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00034">SwaggerConfiguration.cs:34</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_ac7c84669ba2400c1673cba025f275fb9"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ac7c84669ba2400c1673cba025f275fb9">Tgstation.Server.Host.Utils.SwaggerConfiguration.AddDefaultResponses</a></div><div class="ttdeci">static void AddDefaultResponses(OpenApiDocument document)</div><div class="ttdoc">Add the default error responses to a given document .</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00131">SwaggerConfiguration.cs:131</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_ad42b61af703046605dcf2c27a3a76e14"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ad42b61af703046605dcf2c27a3a76e14">Tgstation.Server.Host.Utils.SwaggerConfiguration.Apply</a></div><div class="ttdeci">void Apply(OpenApiOperation operation, OperationFilterContext context)</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00347">SwaggerConfiguration.cs:347</a></div></div>
|
|
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration_html_ae096775c5ebc422b2ef65548cb0b1f31"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_swagger_configuration.html#ae096775c5ebc422b2ef65548cb0b1f31">Tgstation.Server.Host.Utils.SwaggerConfiguration.ApplyAttributesForRootSchema</a></div><div class="ttdeci">static void ApplyAttributesForRootSchema(OpenApiSchema rootSchema, SchemaFilterContext context)</div><div class="ttdoc">Applies the OpenApiSchema.Nullable, OpenApiSchema.ReadOnly, and OpenApiSchema.WriteOnly to OpenApiSch...</div><div class="ttdef"><b>Definition</b> <a href="_swagger_configuration_8cs_source.html#l00221">SwaggerConfiguration.cs:221</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models_1_1_response.html">Tgstation.Server.Api.Models.Response</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_response_8cs_source.html#l00005">AdministrationResponse.cs:6</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html_a2a982b7013d51aecc5738e6eec96cb8a"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2a982b7013d51aecc5738e6eec96cb8a">Tgstation.Server.Api.Models.FieldPresence</a></div><div class="ttdeci">FieldPresence</div><div class="ttdoc">Indicates whether a request field is Required or Ignored.</div><div class="ttdef"><b>Definition</b> <a href="_field_presence_8cs_source.html#l00006">FieldPresence.cs:7</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api.html">Tgstation.Server.Api</a></div><div class="ttdef"><b>Definition</b> <a href="_api_headers_8cs_source.html#l00019">ApiHeaders.cs:20</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_common_1_1_extensions_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_common_1_1_extensions.html">Tgstation.Server.Common.Extensions</a></div><div class="ttdef"><b>Definition</b> <a href="_value_task_extensions_8cs_source.html#l00006">ValueTaskExtensions.cs:7</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_controller_8cs_source.html#l00026">AdministrationController.cs:27</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>
|
|
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a></div><div class="ttdef"><b>Definition</b> <a href="_graph_q_l_git_lab_client_8cs_source.html#l00006">GraphQLGitLabClient.cs:7</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|