Files
spring-cloud-release-tools/spring-cloud-info/src/main/resources/static/docs/spring-cloud-info.html
Ryan Baxter a6b591d781 Refining API
2019-05-08 12:19:38 -04:00

506 lines
19 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.7.1">
<title>Rest API</title>
<link rel="stylesheet" href="css/spring.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<style>
.hidden {
display: none;
}
.switch {
border-width: 1px 1px 0 1px;
border-style: solid;
border-color: #7a2518;
display: inline-block;
}
.switch--item {
padding: 10px;
background-color: #ffffff;
color: #7a2518;
display: inline-block;
cursor: pointer;
}
.switch--item.selected {
background-color: #7a2519;
color: #ffffff;
}
</style>
<script src="http://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js"></script>
<script type="text/javascript">
function addBlockSwitches() {
$('.primary').each(function() {
primary = $(this);
createSwitchItem(primary, createBlockSwitch(primary)).item.addClass("selected");
primary.children('.title').remove();
});
$('.secondary').each(function(idx, node) {
secondary = $(node);
primary = findPrimary(secondary);
switchItem = createSwitchItem(secondary, primary.children('.switch'));
switchItem.content.addClass('hidden');
findPrimary(secondary).append(switchItem.content);
secondary.remove();
});
}
function createBlockSwitch(primary) {
blockSwitch = $('<div class="switch"></div>');
primary.prepend(blockSwitch);
return blockSwitch;
}
function findPrimary(secondary) {
candidate = secondary.prev();
while (!candidate.is('.primary')) {
candidate = candidate.prev();
}
return candidate;
}
function createSwitchItem(block, blockSwitch) {
blockName = block.children('.title').text();
content = block.children('.content').first().append(block.next('.colist'));
item = $('<div class="switch--item">' + blockName + '</div>');
item.on('click', '', content, function(e) {
$(this).addClass('selected');
$(this).siblings().removeClass('selected');
e.data.siblings('.content').addClass('hidden');
e.data.removeClass('hidden');
});
blockSwitch.append(item);
return {'item': item, 'content': content};
}
$(addBlockSwitches);
</script>
</head>
<body class="book toc2 toc-left">
<div id="header">
<h1>Rest API</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_spring_cloud_versions">Spring Cloud Versions</a>
<ul class="sectlevel2">
<li><a href="#_curl_request">cURL Request</a></li>
<li><a href="#_httpie_request">HTTPie Request</a></li>
<li><a href="#_http_request">HTTP Request</a></li>
<li><a href="#_response">Response</a></li>
<li><a href="#_response_fields">Response Fields</a></li>
</ul>
</li>
<li><a href="#_spring_cloud_version_given_spring_boot_version">Spring Cloud Version Given Spring Boot Version</a>
<ul class="sectlevel2">
<li><a href="#_path_parameters">Path Parameters</a></li>
<li><a href="#_curl_request_2">cURL Request</a></li>
<li><a href="#_httpie_request_2">HTTPie Request</a></li>
<li><a href="#_http_request_2">HTTP Request</a></li>
<li><a href="#_http_response">HTTP Response</a></li>
<li><a href="#_response_fields_2">Response Fields</a></li>
</ul>
</li>
<li><a href="#_spring_cloud_project_versions">Spring Cloud Project Versions</a>
<ul class="sectlevel2">
<li><a href="#_curl_request_3">cURL Request</a></li>
<li><a href="#_httpie_request_3">HTTPie Request</a></li>
<li><a href="#_http_request_3">HTTP Request</a></li>
<li><a href="#_http_response_2">HTTP Response</a></li>
</ul>
</li>
<li><a href="#_upcoming_spring_cloud_releases">Upcoming Spring Cloud Releases</a>
<ul class="sectlevel2">
<li><a href="#_curl_request_4">cURL Request</a></li>
<li><a href="#_httpie_request_4">HTTPie Request</a></li>
<li><a href="#_http_request_4">HTTP Request</a></li>
<li><a href="#_http_response_3">HTTP Response</a></li>
</ul>
</li>
<li><a href="#_get_spring_cloud_release_date">Get Spring Cloud Release Date</a>
<ul class="sectlevel2">
<li><a href="#_path_parameters_2">Path Parameters</a></li>
<li><a href="#_curl_request_5">cURL Request</a></li>
<li><a href="#_httpie_request_5">HTTPie Request</a></li>
<li><a href="#_http_request_5">HTTP Request</a></li>
<li><a href="#_http_response_4">HTTP Response</a></li>
<li><a href="#_response_fields_3">Response Fields</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_spring_cloud_versions"><a class="link" href="#_spring_cloud_versions">Spring Cloud Versions</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets all the available Spring Cloud release trains.</p>
</div>
<div class="sect2">
<h3 id="_curl_request"><a class="link" href="#_curl_request">cURL Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://spring-cloud-info.cfapps.io/springcloudversions' -i -X GET \
-H 'Accept: application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_httpie_request"><a class="link" href="#_httpie_request">HTTPie Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ http GET 'http://spring-cloud-info.cfapps.io/springcloudversions' \
'Accept:application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_request"><a class="link" href="#_http_request">HTTP Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /springcloudversions HTTP/1.1
Accept: application/json
Host: spring-cloud-info.cfapps.io</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response"><a class="link" href="#_response">Response</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Length: 449
Content-Type: application/json;charset=UTF-8
["Greenwich.SR1","Greenwich.RELEASE","Greenwich.RC2","Greenwich.RC1","Greenwich.M3","Greenwich.M2","Greenwich.M1","Finchley.SR3","Finchley.SR2","Finchley.SR1","Finchley.RELEASE","Finchley.RC2","Finchley.RC1","Finchley.M9","Finchley.M8","Finchley.M7","Finchley.M6","Finchley.M5","Finchley.M3","Finchley.M2","Finchley.M1","Edgware.SR5","Edgware.SR4","Edgware.SR3","Edgware.SR2","Edgware.SR1","Edgware.RELEASE","Edgware.M1","Dalston.SR5","Dalston.SR4"]</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response_fields"><a class="link" href="#_response_fields">Response Fields</a></h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>[]</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">An array versions</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_spring_cloud_version_given_spring_boot_version"><a class="link" href="#_spring_cloud_version_given_spring_boot_version">Spring Cloud Version Given Spring Boot Version</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets the Spring Cloud release train version given a Spring Boot version.</p>
</div>
<div class="sect2">
<h3 id="_path_parameters"><a class="link" href="#_path_parameters">Path Parameters</a></h3>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. /springcloudversion/springboot/{bootVersion}</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>bootVersion</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Spring Boot version</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_curl_request_2"><a class="link" href="#_curl_request_2">cURL Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://spring-cloud-info.cfapps.io/springcloudversion/springboot/2.1.1.RELEASE' -i -X GET \
-H 'Accept: application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_httpie_request_2"><a class="link" href="#_httpie_request_2">HTTPie Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ http GET 'http://spring-cloud-info.cfapps.io/springcloudversion/springboot/2.1.1.RELEASE' \
'Accept:application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_request_2"><a class="link" href="#_http_request_2">HTTP Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /springcloudversion/springboot/2.1.1.RELEASE HTTP/1.1
Accept: application/json
Host: spring-cloud-info.cfapps.io</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_response"><a class="link" href="#_http_response">HTTP Response</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Length: 31
Content-Disposition: inline;filename=f.txt
Content-Type: application/json;charset=UTF-8
{"version":"Greenwich.RELEASE"}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response_fields_2"><a class="link" href="#_response_fields_2">Response Fields</a></h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>version</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Spring Cloud version</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_spring_cloud_project_versions"><a class="link" href="#_spring_cloud_project_versions">Spring Cloud Project Versions</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Get the Spring Cloud project versions for a given Spring Cloud release train.</p>
</div>
<div class="sect2">
<h3 id="_curl_request_3"><a class="link" href="#_curl_request_3">cURL Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://spring-cloud-info.cfapps.io/bomversions/Finchley.SR1' -i -X GET \
-H 'Accept: application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_httpie_request_3"><a class="link" href="#_httpie_request_3">HTTPie Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ http GET 'http://spring-cloud-info.cfapps.io/bomversions/Finchley.SR1' \
'Accept:application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_request_3"><a class="link" href="#_http_request_3">HTTP Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /bomversions/Finchley.SR1 HTTP/1.1
Accept: application/json
Host: spring-cloud-info.cfapps.io</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_response_2"><a class="link" href="#_http_response_2">HTTP Response</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Length: 904
Content-Disposition: inline;filename=f.txt
Content-Type: application/json;charset=UTF-8
{"spring-cloud-cloudfoundry":"2.2.0.BUILD-SNAPSHOT","spring-cloud-openfeign":"2.2.0.BUILD-SNAPSHOT","spring-cloud-task":"2.0.0.RELEASE","spring-cloud-security":"2.2.0.BUILD-SNAPSHOT","spring-cloud-zookeeper":"2.2.0.BUILD-SNAPSHOT","spring-cloud-config":"2.2.0.BUILD-SNAPSHOT","spring-cloud-function":"2.1.0.BUILD-SNAPSHOT","spring-cloud-netflix":"2.2.0.BUILD-SNAPSHOT","spring-cloud-vault":"2.2.0.BUILD-SNAPSHOT","spring-cloud-stream":"Germantown.BUILD-SNAPSHOT","spring-cloud-gcp":"1.1.0.BUILD-SNAPSHOT","spring-cloud-sleuth":"2.2.0.BUILD-SNAPSHOT","spring-cloud-kubernetes":"1.1.0.BUILD-SNAPSHOT","spring-cloud-commons":"2.2.0.BUILD-SNAPSHOT","spring-cloud-aws":"2.2.0.BUILD-SNAPSHOT","spring-cloud-contract":"2.2.0.BUILD-SNAPSHOT","spring-cloud-bus":"2.2.0.BUILD-SNAPSHOT","spring-cloud-gateway":"2.2.0.BUILD-SNAPSHOT","spring-boot":"2.2.0.BUILD-SNAPSHOT","spring-cloud-consul":"2.2.0.BUILD-SNAPSHOT"}</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_upcoming_spring_cloud_releases"><a class="link" href="#_upcoming_spring_cloud_releases">Upcoming Spring Cloud Releases</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets all the upcoming Spring Cloud releases.</p>
</div>
<div class="sect2">
<h3 id="_curl_request_4"><a class="link" href="#_curl_request_4">cURL Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://spring-cloud-info.cfapps.io/milestones' -i -X GET \
-H 'Accept: application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_httpie_request_4"><a class="link" href="#_httpie_request_4">HTTPie Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ http GET 'http://spring-cloud-info.cfapps.io/milestones' \
'Accept:application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_request_4"><a class="link" href="#_http_request_4">HTTP Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /milestones HTTP/1.1
Accept: application/json
Host: spring-cloud-info.cfapps.io</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_response_3"><a class="link" href="#_http_response_3">HTTP Response</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 57
["Hoxton.RELEASE","Finchley.SR4","Hoxton.M1","Hoxton.M2"]</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_get_spring_cloud_release_date"><a class="link" href="#_get_spring_cloud_release_date">Get Spring Cloud Release Date</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets the tentative date given an upcoming Spring Cloud release train name.</p>
</div>
<div class="sect2">
<h3 id="_path_parameters_2"><a class="link" href="#_path_parameters_2">Path Parameters</a></h3>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. /milestones/{release}/duedate</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>release</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Spring Cloud release train name</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_curl_request_5"><a class="link" href="#_curl_request_5">cURL Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ curl 'http://spring-cloud-info.cfapps.io/milestones/Hoxton.RELEASE/duedate' -i -X GET \
-H 'Accept: application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_httpie_request_5"><a class="link" href="#_httpie_request_5">HTTPie Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">$ http GET 'http://spring-cloud-info.cfapps.io/milestones/Hoxton.RELEASE/duedate' \
'Accept:application/json'</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_request_5"><a class="link" href="#_http_request_5">HTTP Request</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">GET /milestones/Hoxton.RELEASE/duedate HTTP/1.1
Accept: application/json
Host: spring-cloud-info.cfapps.io</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_http_response_4"><a class="link" href="#_http_response_4">HTTP Response</a></h3>
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight nowrap"><code class="language-http hljs" data-lang="http">HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 24
{"dueDate":"2019-07-31"}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response_fields_3"><a class="link" href="#_response_fields_3">Response Fields</a></h3>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Path</th>
<th class="tableblock halign-left valign-top">Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>dueDate</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Spring Cloud milestone due date</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<script type="text/javascript" src="js/tocbot/tocbot.min.js"></script>
<script type="text/javascript" src="js/toc.js"></script>
<link rel="stylesheet" href="js/highlight/styles/atom-one-dark-reasonable.min.css">
<script src="js/highlight/highlight.min.js"></script>
<script>hljs.initHighlighting()</script>
</body>
</html>