cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-24 21:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
tgstation-server/_open_api_enum_var_names_extension_8cs_source.html
T

154 lines
17 KiB
HTML
Raw Permalink Blame History

<!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/OpenApiEnumVarNamesExtension.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">&#160;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&amp;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&amp;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&amp;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">OpenApiEnumVarNamesExtension.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_open_api_enum_var_names_extension_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> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span>Microsoft.OpenApi;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>Microsoft.OpenApi.Interfaces;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>Microsoft.OpenApi.Models;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>Microsoft.OpenApi.Writers;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</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="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html"> 13</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_open_api_enum_var_names_extension.html">OpenApiEnumVarNamesExtension</a> : <a class="code hl_class" href="class_i_open_api_extension.html">IOpenApiExtension</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455"> 18</a></span> readonly Type <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="foldopen" id="foldopen00024" data-start="{" data-end="}">
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#a0fb92b26a90752170ecf00b093acebee"> 24</a></span> <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#a0fb92b26a90752170ecf00b093acebee">OpenApiEnumVarNamesExtension</a>(Type <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> this.enumType = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a> ?? <span class="keywordflow">throw</span> <span class="keyword">new</span> ArgumentNullException(nameof(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>));</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> }</div>
</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<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_open_api_enum_var_names_extension.html#a93407e10fe77d7c7f39084d4b1e3308f"> 34</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_open_api_enum_var_names_extension.html#a93407e10fe77d7c7f39084d4b1e3308f">Apply</a>(OpenApiSchema openApiSchema, Type <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>)</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> ArgumentNullException.ThrowIfNull(openApiSchema);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> openApiSchema.Extensions.Add(<span class="stringliteral">&quot;x-enum-varnames&quot;</span>, <span class="keyword">new</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_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>));</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> }</div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="foldopen" id="foldopen00042" data-start="{" data-end="}">
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#a494040b4da110b42018d6ee7cb4818ee"> 42</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_open_api_enum_var_names_extension.html#a494040b4da110b42018d6ee7cb4818ee">Write</a>(IOpenApiWriter writer, OpenApiSpecVersion specVersion)</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> ArgumentNullException.ThrowIfNull(writer);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordflow">if</span> (specVersion != OpenApiSpecVersion.OpenApi3_0)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">throw</span> <span class="keyword">new</span> InvalidOperationException(<span class="stringliteral">&quot;This extension only applies to OpenAPI 3.0!&quot;</span>);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> writer.WriteStartArray();</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">foreach</span> (var enumValue <span class="keywordflow">in</span> Enum.GetValues(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>))</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> var enumName = enumValue.ToString()!;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> var field = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_open_api_enum_var_names_extension.html#acf96da76fa2dbad832506b3d0d4c4455">enumType</a>.GetField(enumName)!;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">if</span> (field.IsDefined(typeof(ObsoleteAttribute), <span class="keyword">false</span>))</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> enumName = $<span class="stringliteral">&quot;DEPRECATED_{enumName}&quot;</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> writer.WriteValue(enumName);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> writer.WriteEndArray();</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> }</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>}</div>
<div class="ttc" id="aclass_i_open_api_extension_html"><div class="ttname"><a href="class_i_open_api_extension.html">IOpenApiExtension</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 &quot;x-enum-varnames&quot; 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_a0fb92b26a90752170ecf00b093acebee"><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#a0fb92b26a90752170ecf00b093acebee">Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.OpenApiEnumVarNamesExtension</a></div><div class="ttdeci">OpenApiEnumVarNamesExtension(Type enumType)</div><div class="ttdoc">Initializes a new instance of the OpenApiEnumVarNamesExtension class.</div><div class="ttdef"><b>Definition</b> <a href="_open_api_enum_var_names_extension_8cs_source.html#l00024">OpenApiEnumVarNamesExtension.cs:24</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_a494040b4da110b42018d6ee7cb4818ee"><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#a494040b4da110b42018d6ee7cb4818ee">Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.Write</a></div><div class="ttdeci">void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)</div><div class="ttdef"><b>Definition</b> <a href="_open_api_enum_var_names_extension_8cs_source.html#l00042">OpenApiEnumVarNamesExtension.cs:42</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_open_api_enum_var_names_extension_html_acf96da76fa2dbad832506b3d0d4c4455"><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#acf96da76fa2dbad832506b3d0d4c4455">Tgstation.Server.Host.Utils.OpenApiEnumVarNamesExtension.enumType</a></div><div class="ttdeci">readonly Type enumType</div><div class="ttdoc">The Type of the Enum being described.</div><div class="ttdef"><b>Definition</b> <a href="_open_api_enum_var_names_extension_8cs_source.html#l00018">OpenApiEnumVarNamesExtension.cs:18</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&#160;<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>
Reference in New Issue View Git Blame Copy Permalink