Skip to content

Commit a361c07

Browse files
author
SLDN
committed
Tue Nov 12 20:37:41 UTC 2024 Release
1 parent 2fc7cf2 commit a361c07

11 files changed

Lines changed: 601742 additions & 27 deletions

File tree

‎article/index.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,14 @@ <h1> Articles </h1>
168168

169169
<div class="well well-sm example">
170170
<h4>
171+
<a href="https://sldn.softlayer.com/article/openAPI/"><i class="fas fa-terminal"></i> Open API Definitions for SLDN </a> <small class="pull-right">Nov 12, 2024</small><br>
172+
</h4>
173+
<div class = "example-summary"> Introducing OpenAPI spec sheet for SLDN api</div>
174+
<a class="btn btn-primary btn-xs" href="https://sldn.softlayer.com/article/openAPI/"><i class="fas fa-file"></i> Read Me </a>
175+
</div>
176+
177+
<div class="well well-sm example">
178+
<h4>
171179
<a href="https://sldn.softlayer.com/article/vlanTrunking/"><i class="fas fa-terminal"></i> VLAN Trunking </a> <small class="pull-right">Dec 18, 2023</small><br>
172180
</h4>
173181
<div class = "example-summary"> An explanation of how to trunk vlans with the CLI so servers can have access to more than their native VLANs</div>

‎article/openAPI/index.html‎

Lines changed: 239 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,239 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
5+
<meta charset="utf-8">
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
8+
<meta name="description" content="SoftLayer API Examples, implementations, and release notes.">
9+
<meta name="author" content="SoftLayer">
10+
11+
<title>Open API Definitions for SLDN - https://sldn.softlayer.com/</title>
12+
<link rel="canonical" href="https://sldn.softlayer.com/article/openAPI/">
13+
<link href="https://sldn.softlayer.com/css/main.css" rel="stylesheet">
14+
<link href="https://sldn.softlayer.com/css/bootstrap.css" rel="stylesheet">
15+
<link href="https://sldn.softlayer.com/css/custom.css" rel="stylesheet">
16+
<link href="https://sldn.softlayer.com/css/monokai.css" rel="stylesheet">
17+
<link href="https://sldn.softlayer.com/css/highlight/solarized_dark.css" rel="stylesheet">
18+
19+
20+
<script src="https://sldn.softlayer.com/js/highlight.pack.js"></script>
21+
22+
<script>hljs.initHighlightingOnLoad();</script>
23+
<link rel="shortcut icon" href="https://sldn.softlayer.com/img/favicon.ico" type="image/x-icon" />
24+
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Lato" />
25+
26+
27+
<script src="https://sldn.softlayer.com/js/jquery-3.3.1.min.js"></script>
28+
<script src="https://sldn.softlayer.com/js/sldn.js"></script>
29+
30+
31+
<link href="https://sldn.softlayer.com/fontawesome/css/fontawesome.min.css" rel="stylesheet" type="text/css">
32+
<link href="https://sldn.softlayer.com/fontawesome/css/brands.min.css" rel="stylesheet" type="text/css">
33+
<link href="https://sldn.softlayer.com/fontawesome/css/solid.min.css" rel="stylesheet" type="text/css">
34+
35+
<script defer src="https://sldn.softlayer.com/fontawesome/js/solid.min.js"></script>
36+
<script defer src="https://sldn.softlayer.com/fontawesome/js/brands.min.js"></script>
37+
<script defer src="https://sldn.softlayer.com/fontawesome/js/fontawesome.min.js"></script>
38+
39+
<script>
40+
var head = document.getElementsByTagName('head')[0]
41+
var style = document.createElement('link')
42+
style.type = 'text/css'
43+
style.rel = 'stylesheet'
44+
style.id = "dark-theme"
45+
if (localStorage.getItem("dark-mode-theme") == "dark") {
46+
style.href = '/css/dark.css'
47+
} else {
48+
style.href = '/css/light.css'
49+
}
50+
head.append(style)
51+
</script>
52+
53+
<script>
54+
$(document).ready(function() {
55+
$('table').addClass("table table-hover table-striped")
56+
setThemeMode(localStorage.getItem("dark-mode-theme") || "dark");
57+
})
58+
</script>
59+
60+
<script async src="https://www.googletagmanager.com/gtag/js?id=G-9XPZ9ZBSJE"></script>
61+
<script>
62+
var doNotTrack = false;
63+
if ( false ) {
64+
var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
65+
var doNotTrack = (dnt == "1" || dnt == "yes");
66+
}
67+
if (!doNotTrack) {
68+
window.dataLayer = window.dataLayer || [];
69+
function gtag(){dataLayer.push(arguments);}
70+
gtag('js', new Date());
71+
gtag('config', 'G-9XPZ9ZBSJE');
72+
}
73+
</script>
74+
</head>
75+
76+
<body>
77+
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
78+
<div class="nav-container">
79+
<div class="navbar-header" style="width: 150px">
80+
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
81+
<span class="sr-only">Toggle Navigation</span>
82+
<span class="icon-bar"></span>
83+
<span class="icon-bar"></span>
84+
<span class="icon-bar"></span>
85+
</button>
86+
<a class="navbar-brand" href="https://sldn.softlayer.com/">SoftLayer API</a>
87+
</div>
88+
89+
<div class="navbar-header" style="width: calc(100% - 350px)">
90+
<ul class="nav navbar-nav" style="width: 100%">
91+
92+
<li><a href="https://sldn.softlayer.com/article/">Articles</a></li>
93+
94+
<li><a href="https://sldn.softlayer.com/reference/softlayerapi">Docs</a></li>
95+
96+
<li><a href="https://sldn.softlayer.com/go/">Go</a></li>
97+
98+
<li><a href="https://sldn.softlayer.com/java/">Java</a></li>
99+
100+
<li><a href="https://sldn.softlayer.com/php/">PHP</a></li>
101+
102+
<li><a href="https://sldn.softlayer.com/python/">Python</a></li>
103+
104+
<li><a href="https://sldn.softlayer.com/rest/">Rest</a></li>
105+
106+
<li><a href="https://sldn.softlayer.com/ruby/">Ruby</a></li>
107+
108+
<li><a href="https://sldn.softlayer.com/tools/">Tools</a></li>
109+
110+
<li class="nav-item">
111+
<a id="dark-toggle" class="dark-mode-toggle" aria-label="dark-mode-toggle" style="color: var(--Red); font-size: 20px">
112+
<i class="fas fa-sun"></i>
113+
</a>
114+
</li>
115+
</ul>
116+
</div>
117+
118+
<div id="custom-search-input" class="pull-right" style="width: 200px">
119+
<form class="navbar-form" role="search" method="get" action="https://www.bing.com/search">
120+
<div class="input-group col-md-12">
121+
<input type="text" class="form-control input-md" placeholder="Search" name="q" id="srch-term">
122+
<input type="hidden" name="q1" value="site:sldn.softlayer.com" />
123+
<div class="input-group-btn">
124+
<button class="btn btn-info" type="submit">
125+
<i class="glyphicon glyphicon-search"></i>
126+
</button>
127+
</div>
128+
</div>
129+
</form>
130+
</div>
131+
132+
</div>
133+
</nav>
134+
135+
<script type="text/javascript">
136+
const darkIconClass = 'fas fa-moon'
137+
const lightIconClass = 'fas fa-sun'
138+
var darkCSS = $("#dark-theme");
139+
var darkToggleIcon = $("#dark-toggle i");
140+
141+
142+
143+
144+
function setThemeMode(mode) {
145+
localStorage.setItem("dark-mode-theme", mode);
146+
if (mode === "dark") {
147+
darkToggleIcon.attr('class', darkIconClass)
148+
} else {
149+
darkToggleIcon.attr('class', lightIconClass)
150+
}
151+
}
152+
153+
154+
$("#dark-toggle").click(function () {
155+
if (darkToggleIcon.attr("class") == lightIconClass) {
156+
setThemeMode("dark")
157+
} else if (darkToggleIcon.attr("class") == darkIconClass) {
158+
setThemeMode("light")
159+
}
160+
location.reload();
161+
});
162+
</script>
163+
<div class="container">
164+
<div class="row main-top">
165+
166+
<div class="col-md-3">
167+
<div style="word-wrap: break-word;">
168+
<h4>November 12, 2024<br></h4>
169+
</div>
170+
</div>
171+
<div class="col-md-9">
172+
<strong>Tags <span class="fa fa-tags"/></strong>
173+
174+
<a class="label label-danger" href="https://sldn.softlayer.com/tags/article">article</a>
175+
176+
<a class="label label-danger" href="https://sldn.softlayer.com/tags/sldn">sldn</a>
177+
178+
</div>
179+
</div>
180+
<hr>
181+
<div class="row">
182+
<div class="col-md-12">
183+
<div class="well well-sm article" style="word-wrap: break-word;">
184+
<div class="article-title">
185+
<h1>Open API Definitions for SLDN</h1>
186+
<small>Introducing OpenAPI spec sheet for SLDN api</small>
187+
</div>
188+
189+
190+
191+
<h1 id="open-apihttpsswaggeriospecification"><a href="https://swagger.io/specification/">Open API</a></h1>
192+
<p>We now have tenative support for an Open API spec. You can download it from <a href="https://sldn.softlayer.com/openapi/sl_openapi.json">SLDN</a></p>
193+
<p>Due to the way SLDN is designed, the spec sheet is fairly lengthy and a bit complicated, but perhaps it will be useful.</p>
194+
<h1 id="generation">Generation</h1>
195+
<p>If you are interested in how the file is generated, check out <a href="https://github.com/softlayer/githubio_source/tree/master/bin/generateOpenAPI.py">bin/generateOpenAPI.py</a></p>
196+
<p><a href="https://openapi-generator.tech/docs/installation">OpenAPI CLI</a> Can be used to generate HTML or whatever else from this document.</p>
197+
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><span class="line"><span class="cl">$&gt; mkdir generated
198+
</span></span><span class="line"><span class="cl">$&gt; wget https://sldn.softlayer.com/static/openapi/sl_openapi.json
199+
</span></span><span class="line"><span class="cl">$&gt; java -jar openapi-generator-cli.jar generate -g html -i sl_openapi.json -o generated/ --skip-operation-example
200+
</span></span></code></pre></div><p>You will need the <code>--skip-operation-example</code> option otherwise openapi-generator-cli will run out of memory building SLDN objects.</p>
201+
202+
</div>
203+
</div>
204+
205+
</div>
206+
<hr>
207+
<div class="row">
208+
<div class="col-md-6">
209+
<div class="well well-sm footer" style="word-wrap: break-word;">
210+
<strong>Feedback? <span class="fas fa-comment"/></strong>
211+
<p>
212+
If this article contains any error, or leaves any of your questions unanswered, please help us out by
213+
opening up a github issue.<br>
214+
<a class="" href="https://github.com/softlayer/githubio_source/issues/new?title=Feedback%20for%20article%20-%20Open%20API%20Definitions%20for%20SLDN&body=Feedback+regarding%3A%20https%3a%2f%2fsldn.softlayer.com%2farticle%2fopenAPI%2f"> Open an issue</a>
215+
<i class="fab fa-github" alt="github"></i>
216+
<span> - </span>
217+
<a class="" href="https://github.com/softlayer/githubio_source/edit/master/content/article/openAPI.md" style="text-align: right;"> Quick Edit</a>
218+
<i class="fab fa-github" alt="github"></i>
219+
220+
</p>
221+
</div>
222+
</div>
223+
224+
</div>
225+
<footer>
226+
<div class="row">
227+
<div class="col-sm-12 footer">
228+
<p>&copy; SoftLayer 2024<br>
229+
Built with <a href="https://github.com/spf13/hugo">Hugo</a></p>
230+
</div>
231+
</div>
232+
</footer>
233+
</div>
234+
235+
<script src="https://sldn.softlayer.com/js/jquery.js"></script>
236+
<script src="https://sldn.softlayer.com/js/bootstrap.js"></script>
237+
</body>
238+
</html>
239+

‎index.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<language>en-US</language>
66
<author>Enthusiastic Hugo User</author>
77
<rights>Copyright (c) 2014, Enthusiastic Hugo User; all rights reserved.</rights>
8-
<updated>Mon, 28 Oct 2024 00:00:00 UTC</updated>
8+
<updated>Tue, 12 Nov 2024 00:00:00 UTC</updated>
99

1010
<item>
1111
<title>Release_notes</title>

0 commit comments

Comments
 (0)