Skip to content

Open API release #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
allmightyspiff merged 1 commit into from
Nov 12, 2024
Merged

Open API release #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions article/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ <h1> Articles </h1>

<div class="well well-sm example">
<h4>
<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>
</h4>
<div class = "example-summary"> Introducing OpenAPI spec sheet for SLDN api</div>
<a class="btn btn-primary btn-xs" href="https://sldn.softlayer.com/article/openAPI/"><i class="fas fa-file"></i> Read Me </a>
</div>

<div class="well well-sm example">
<h4>
<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>
</h4>
<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>
Expand Down
239 changes: 239 additions & 0 deletions article/openAPI/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
<!doctype html>
<html lang="en">
<head>

<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="SoftLayer API Examples, implementations, and release notes.">
<meta name="author" content="SoftLayer">

<title>Open API Definitions for SLDN - https://sldn.softlayer.com/</title>
<link rel="canonical" href="https://sldn.softlayer.com/article/openAPI/">
<link href="https://sldn.softlayer.com/css/main.css" rel="stylesheet">
<link href="https://sldn.softlayer.com/css/bootstrap.css" rel="stylesheet">
<link href="https://sldn.softlayer.com/css/custom.css" rel="stylesheet">
<link href="https://sldn.softlayer.com/css/monokai.css" rel="stylesheet">
<link href="https://sldn.softlayer.com/css/highlight/solarized_dark.css" rel="stylesheet">


<script src="https://sldn.softlayer.com/js/highlight.pack.js"></script>

<script>hljs.initHighlightingOnLoad();</script>
<link rel="shortcut icon" href="https://sldn.softlayer.com/img/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Lato" />


<script src="https://sldn.softlayer.com/js/jquery-3.3.1.min.js"></script>
<script src="https://sldn.softlayer.com/js/sldn.js"></script>


<link href="https://sldn.softlayer.com/fontawesome/css/fontawesome.min.css" rel="stylesheet" type="text/css">
<link href="https://sldn.softlayer.com/fontawesome/css/brands.min.css" rel="stylesheet" type="text/css">
<link href="https://sldn.softlayer.com/fontawesome/css/solid.min.css" rel="stylesheet" type="text/css">

<script defer src="https://sldn.softlayer.com/fontawesome/js/solid.min.js"></script>
<script defer src="https://sldn.softlayer.com/fontawesome/js/brands.min.js"></script>
<script defer src="https://sldn.softlayer.com/fontawesome/js/fontawesome.min.js"></script>

<script>
var head = document.getElementsByTagName('head')[0]
var style = document.createElement('link')
style.type = 'text/css'
style.rel = 'stylesheet'
style.id = "dark-theme"
if (localStorage.getItem("dark-mode-theme") == "dark") {
style.href = '/css/dark.css'
} else {
style.href = '/css/light.css'
}
head.append(style)
</script>

<script>
$(document).ready(function() {
$('table').addClass("table table-hover table-striped")
setThemeMode(localStorage.getItem("dark-mode-theme") || "dark");
})
</script>

<script async src="https://www.googletagmanager.com/gtag/js?id=G-9XPZ9ZBSJE"></script>
<script>
var doNotTrack = false;
if ( false ) {
var dnt = (navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack);
var doNotTrack = (dnt == "1" || dnt == "yes");
}
if (!doNotTrack) {
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-9XPZ9ZBSJE');
}
</script>
</head>

<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="nav-container">
<div class="navbar-header" style="width: 150px">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle Navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="https://sldn.softlayer.com/">SoftLayer API</a>
</div>

<div class="navbar-header" style="width: calc(100% - 350px)">
<ul class="nav navbar-nav" style="width: 100%">

<li><a href="https://sldn.softlayer.com/article/">Articles</a></li>

<li><a href="https://sldn.softlayer.com/reference/softlayerapi">Docs</a></li>

<li><a href="https://sldn.softlayer.com/go/">Go</a></li>

<li><a href="https://sldn.softlayer.com/java/">Java</a></li>

<li><a href="https://sldn.softlayer.com/php/">PHP</a></li>

<li><a href="https://sldn.softlayer.com/python/">Python</a></li>

<li><a href="https://sldn.softlayer.com/rest/">Rest</a></li>

<li><a href="https://sldn.softlayer.com/ruby/">Ruby</a></li>

<li><a href="https://sldn.softlayer.com/tools/">Tools</a></li>

<li class="nav-item">
<a id="dark-toggle" class="dark-mode-toggle" aria-label="dark-mode-toggle" style="color: var(--Red); font-size: 20px">
<i class="fas fa-sun"></i>
</a>
</li>
</ul>
</div>

<div id="custom-search-input" class="pull-right" style="width: 200px">
<form class="navbar-form" role="search" method="get" action="https://www.bing.com/search">
<div class="input-group col-md-12">
<input type="text" class="form-control input-md" placeholder="Search" name="q" id="srch-term">
<input type="hidden" name="q1" value="site:sldn.softlayer.com" />
<div class="input-group-btn">
<button class="btn btn-info" type="submit">
<i class="glyphicon glyphicon-search"></i>
</button>
</div>
</div>
</form>
</div>

</div>
</nav>

<script type="text/javascript">
const darkIconClass = 'fas fa-moon'
const lightIconClass = 'fas fa-sun'
var darkCSS = $("#dark-theme");
var darkToggleIcon = $("#dark-toggle i");




function setThemeMode(mode) {
localStorage.setItem("dark-mode-theme", mode);
if (mode === "dark") {
darkToggleIcon.attr('class', darkIconClass)
} else {
darkToggleIcon.attr('class', lightIconClass)
}
}


$("#dark-toggle").click(function () {
if (darkToggleIcon.attr("class") == lightIconClass) {
setThemeMode("dark")
} else if (darkToggleIcon.attr("class") == darkIconClass) {
setThemeMode("light")
}
location.reload();
});
</script>
<div class="container">
<div class="row main-top">

<div class="col-md-3">
<div style="word-wrap: break-word;">
<h4>November 12, 2024<br></h4>
</div>
</div>
<div class="col-md-9">
<strong>Tags <span class="fa fa-tags"/></strong>

<a class="label label-danger" href="https://sldn.softlayer.com/tags/article">article</a>

<a class="label label-danger" href="https://sldn.softlayer.com/tags/sldn">sldn</a>

</div>
</div>
<hr>
<div class="row">
<div class="col-md-12">
<div class="well well-sm article" style="word-wrap: break-word;">
<div class="article-title">
<h1>Open API Definitions for SLDN</h1>
<small>Introducing OpenAPI spec sheet for SLDN api</small>
</div>



<h1 id="open-apihttpsswaggeriospecification"><a href="https://swagger.io/specification/">Open API</a></h1>
<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>
<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>
<h1 id="generation">Generation</h1>
<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>
<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>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback"><span class="line"><span class="cl">$&gt; mkdir generated
</span></span><span class="line"><span class="cl">$&gt; wget https://sldn.softlayer.com/static/openapi/sl_openapi.json
</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
</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>

</div>
</div>

</div>
<hr>
<div class="row">
<div class="col-md-6">
<div class="well well-sm footer" style="word-wrap: break-word;">
<strong>Feedback? <span class="fas fa-comment"/></strong>
<p>
If this article contains any error, or leaves any of your questions unanswered, please help us out by
opening up a github issue.<br>
<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>
<i class="fab fa-github" alt="github"></i>
<span> - </span>
<a class="" href="https://github.com/softlayer/githubio_source/edit/master/content/article/openAPI.md" style="text-align: right;"> Quick Edit</a>
<i class="fab fa-github" alt="github"></i>

</p>
</div>
</div>

</div>
<footer>
<div class="row">
<div class="col-sm-12 footer">
<p>&copy; SoftLayer 2024<br>
Built with <a href="https://github.com/spf13/hugo">Hugo</a></p>
</div>
</div>
</footer>
</div>

<script src="https://sldn.softlayer.com/js/jquery.js"></script>
<script src="https://sldn.softlayer.com/js/bootstrap.js"></script>
</body>
</html>

2 changes: 1 addition & 1 deletion index.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<language>en-US</language>
<author>Enthusiastic Hugo User</author>
<rights>Copyright (c) 2014, Enthusiastic Hugo User; all rights reserved.</rights>
<updated>Mon, 28 Oct 2024 00:00:00 UTC</updated>
<updated>Tue, 12 Nov 2024 00:00:00 UTC</updated>

<item>
<title>Release_notes</title>
Expand Down
Loading