Extract docs

2026-11-07 09:07:34 +00:00 · 2024-02-09 14:58:02 +01:00
1 parent 8c531f7d57
commit 49c99523f7
@@ -0,0 +1,23 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
@@ -0,0 +1 @@
+3.0.52
@@ -0,0 +1,312 @@
+.line-numbers {
+  margin-right: 1.0em;
+}
+
+.content {
+  padding-bottom: 100px;
+}
+
+.column_header_name {
+  width: 150px;
+}
+
+.column_header_path {
+  width: 350px;
+}
+
+.column_header_name .column_header_param_type .column_header_data_type .column_header_return_type {
+  width: 200px;
+}
+
+.expandable {
+  display: none;
+}
+
+.main_content {
+  margin-top: 80px;
+  margin-left: 25px;
+  margin-right: 25px;
+}
+
+.model {
+  float: left;
+}
+
+.model-container {
+  float: left;
+  width: 500px;
+  padding: 0px;
+}
+
+.model-detail-container {
+  clear: left;
+  float: left;
+  width: 500px;
+  margin-left: 40px;
+}
+
+.model-detail-popup {
+  box-shadow: rgba(0, 0, 0, 0.2) 0 2px 8px 5px;
+  border-style: solid;
+  border-width: 1px;
+  border-color: black;
+  padding-left: 10px;
+  padding-right: 10px;
+  padding-top: 10px;
+  padding-bottom: 10px;
+  background-color: white;
+  opacity: 0.99;
+  z-index: 1;
+  overflow: scroll;
+  width: 400px;
+}
+
+.model-detail-popup .code {
+  background-color: #E4F5FF;
+  font-family: monospace;
+  white-space: pre;
+  margin: 10px;
+  overflow: auto;
+}
+
+.model-detail-popup h2 {
+  margin-top: 0px;
+  padding-top: 0px;
+}
+
+.model-detail-popup li {
+  padding-bottom: 5px;
+}
+
+.model-detail-popup .param-reqiured-true {
+  font-family: monospace;
+  font-weight: bold;
+  clear: left;
+  display: block;
+  float: left;
+  width: 100%;
+}
+
+.model-detail-popup .param-required-false {
+  font-family: monospace;
+  clear: left;
+  display: block;
+  float: left;
+  width: 100%;
+}
+
+.model-detail-popup .param-description {
+  margin-left: 50px;
+  float: left;
+}
+
+.param-enum {
+  margin-left: 20px;
+}
+
+.section-header {
+  border-bottom: 2px;
+  font-weight: bold;
+  font-size: 15px;
+  padding: 6px 0;
+  color: rgb(57,57,57);
+}
+
+.content {
+  padding-top: 100px;
+}
+
+.content h1 {
+  font-size: 43px;
+  text-align: center;
+  margin-top: 40px;
+  margin-bottom: 40px;
+}
+
+.sidebar {
+  box-sizing: border-box;
+  float: left;
+  display: block;
+  width: 240px;
+  overflow: scroll;
+  position: fixed;
+}
+
+.section-box {
+  border-bottom-style: solid;
+  border-bottom: 10px;
+}
+
+.section-box ul li {
+  list-style: none;
+  margin-left: 0px;
+}
+
+.non-sidebar {
+  box-sizing: border-box;
+  display: block;
+  margin-left: 240px;
+  margin-right: 0px;
+  width: 638px;
+}
+
+.non-sidebar h2 {
+  clear: left;
+  padding-top: 20px;
+}
+
+li.parameter {
+  list-style: none;
+  display: block;
+  padding-left: 1em;
+}
+
+.param{
+  display: block;
+}
+
+.param-name {
+  margin-left: 1em;
+}
+
+.param-in {
+  font-weight: bold;
+  font-size: 1.1em;
+}
+.param-type {
+  margin-left: 1em;
+  font-style: italic;
+}
+
+.param-description {
+  display: block;
+  font-family: 'Helvetica Neue', Arial, 'Liberation Sans', FreeSans, sans-serif;
+}
+
+.param-optional-flag {
+  font-style: italic;
+}
+
+.section {
+  font-weight: normal;
+  clear: left;
+}
+
+.section a {
+  text-decoration: underline;
+}
+
+.code {
+  background-color: #E4F5FF;
+  font-family: monospace;
+  white-space: pre;
+  margin: 10px;
+  overflow: auto;
+  width: 600px;
+}
+
+.header {
+  position: fixed;
+  text-align: left;
+  background-color: black;
+  float: left;
+  top: 0;
+  width: 100%;
+  height: 70px auto;
+  padding-bottom: 20px;
+  box-shadow: rgba(0, 0, 0, 0.2) 0 2px 8px 5px;
+}
+
+.top-bar h1 a {
+  width: auto;
+}
+
+.top-bar h1#logo a {
+  width: auto;
+  display: block;
+  clear: none;
+  float: left;
+  background-position: left;;
+  color: white;
+  text-decoration: none;
+}
+
+.top-bar ul li {
+  list-style: none;
+}
+
+.top-bar h1#logo span {
+  display: block;
+  clear: none;
+  float: left;
+  padding-top: 10px;
+  padding-left: 10px;
+  margin: 0px;
+}
+
+.top-bar h1#logo a span.light {
+  color: #ffc97a;
+  color: #666666;
+  padding-left: 0px;
+}
+
+.top-bar ul#nav {
+  float: none;
+  clear: both;
+  overflow: hidden;
+  margin: 0;
+  padding: 0;
+  display: block;
+  float: right;
+  clear: none;
+}
+
+.top-bar ul#nav li {
+  float: left;
+  clear: none;
+  margin: 0;
+  padding: 2px 10px;
+  border-right: 1px solid #dddddd;
+}
+
+.top-bar ul#nav li:first-child, .top-bar ul#nav li.first {
+  padding-left: 0;
+}
+
+.top-bar ul#nav li:last-child, .top-bar ul#nav li.last {
+  padding-right: 0;
+  border-right: none;
+}
+
+.top-bar ul#nav li {
+  border: none;
+  padding: 0 5px;
+}
+
+.top-bar ul#nav li a {
+  display: block;
+  padding: 8px 10px 8px 10px;
+  color: #999999;
+  text-decoration: none;
+}
+
+.top-bar ul#nav li a.strong {
+  color: white;
+}
+
+.top-bar ul#nav li a:active, .top-bar ul#nav li a.active, .top-bar ul#nav li a:hover {
+  -moz-border-radius: 4px;
+  -webkit-border-radius: 4px;
+  -o-border-radius: 4px;
+  -ms-border-radius: 4px;
+  -khtml-border-radius: 4px;
+  border-radius: 4px;
+  background-image: -webkit-gradient(linear, 0% 100%, 0% 0%, color-stop(0%, #ff5401), color-stop(100%, #ffa014));
+  background-image: -moz-linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
+  background-image: linear-gradient(bottom, #ff5401 0%, #ffa014 100%);
+  color: white;
+}
+
+.top-bar ul#nav:hover li {
+  border-color: #222222;
+}
@@ -0,0 +1,2 @@
+/*! jQuery v1.8.3 jquery.com | jquery.org/license */
+(function(e,t){function _(e){var t=M[e]={};return v.each(e.split(y),function(e,n){t[n]=!0}),t}function H(e,n,r){if(r===t&&e.nodeType===1){var i="data-"+n.replace(P,"-$1").toLowerCase();r=e.getAttribute(i);if(typeof r=="string"){try{r=r==="true"?!0:r==="false"?!1:r==="null"?null:+r+""===r?+r:D.test(r)?v.parseJSON(r):r}catch(s){}v.data(e,n,r)}else r=t}return r}function B(e){var t;for(t in e){if(t==="data"&&v.isEmptyObject(e[t]))continue;if(t!=="toJSON")return!1}return!0}function et(){return!1}function tt(){return!0}function ut(e){return!e||!e.parentNode||e.parentNode.nodeType===11}function at(e,t){do e=e[t];while(e&&e.nodeType!==1);return e}function ft(e,t,n){t=t||0;if(v.isFunction(t))return v.grep(e,function(e,r){var i=!!t.call(e,r,e);return i===n});if(t.nodeType)return v.grep(e,function(e,r){return e===t===n});if(typeof t=="string"){var r=v.grep(e,function(e){return e.nodeType===1});if(it.test(t))return v.filter(t,r,!n);t=v.filter(t,r)}return v.grep(e,function(e,r){return v.inArray(e,t)>=0===n})}function lt(e){var t=ct.split("|"),n=e.createDocumentFragment();if(n.createElement)while(t.length)n.createElement(t.pop());return n}function Lt(e,t){return e.getElementsByTagName(t)[0]||e.appendChild(e.ownerDocument.createElement(t))}function At(e,t){if(t.nodeType!==1||!v.hasData(e))return;var n,r,i,s=v._data(e),o=v._data(t,s),u=s.events;if(u){delete o.handle,o.events={};for(n in u)for(r=0,i=u[n].length;r<i;r++)v.event.add(t,n,u[n][r])}o.data&&(o.data=v.extend({},o.data))}function Ot(e,t){var n;if(t.nodeType!==1)return;t.clearAttributes&&t.clearAttributes(),t.mergeAttributes&&t.mergeAttributes(e),n=t.nodeName.toLowerCase(),n==="object"?(t.parentNode&&(t.outerHTML=e.outerHTML),v.support.html5Clone&&e.innerHTML&&!v.trim(t.innerHTML)&&(t.innerHTML=e.innerHTML)):n==="input"&&Et.test(e.type)?(t.defaultChecked=t.checked=e.checked,t.value!==e.value&&(t.value=e.value)):n==="option"?t.selected=e.defaultSelected:n==="input"||n==="textarea"?t.defaultValue=e.defaultValue:n==="script"&&t.text!==e.text&&(t.text=e.text),t.removeAttribute(v.expando)}function Mt(e){return typeof e.getElementsByTagName!="undefined"?e.getElementsByTagName("*"):typeof e.querySelectorAll!="undefined"?e.querySelectorAll("*"):[]}function _t(e){Et.test(e.type)&&(e.defaultChecked=e.checked)}function Qt(e,t){if(t in e)return t;var n=t.charAt(0).toUpperCase()+t.slice(1),r=t,i=Jt.length;while(i--){t=Jt[i]+n;if(t in e)return t}return r}function Gt(e,t){return e=t||e,v.css(e,"display")==="none"||!v.contains(e.ownerDocument,e)}function Yt(e,t){var n,r,i=[],s=0,o=e.length;for(;s<o;s++){n=e[s];if(!n.style)continue;i[s]=v._data(n,"olddisplay"),t?(!i[s]&&n.style.display==="none"&&(n.style.display=""),n.style.display===""&&Gt(n)&&(i[s]=v._data(n,"olddisplay",nn(n.nodeName)))):(r=Dt(n,"display"),!i[s]&&r!=="none"&&v._data(n,"olddisplay",r))}for(s=0;s<o;s++){n=e[s];if(!n.style)continue;if(!t||n.style.display==="none"||n.style.display==="")n.style.display=t?i[s]||"":"none"}return e}function Zt(e,t,n){var r=Rt.exec(t);return r?Math.max(0,r[1]-(n||0))+(r[2]||"px"):t}function en(e,t,n,r){var i=n===(r?"border":"content")?4:t==="width"?1:0,s=0;for(;i<4;i+=2)n==="margin"&&(s+=v.css(e,n+$t[i],!0)),r?(n==="content"&&(s-=parseFloat(Dt(e,"padding"+$t[i]))||0),n!=="margin"&&(s-=parseFloat(Dt(e,"border"+$t[i]+"Width"))||0)):(s+=parseFloat(Dt(e,"padding"+$t[i]))||0,n!=="padding"&&(s+=parseFloat(Dt(e,"border"+$t[i]+"Width"))||0));return s}function tn(e,t,n){var r=t==="width"?e.offsetWidth:e.offsetHeight,i=!0,s=v.support.boxSizing&&v.css(e,"boxSizing")==="border-box";if(r<=0||r==null){r=Dt(e,t);if(r<0||r==null)r=e.style[t];if(Ut.test(r))return r;i=s&&(v.support.boxSizingReliable||r===e.style[t]),r=parseFloat(r)||0}return r+en(e,t,n||(s?"border":"content"),i)+"px"}function nn(e){if(Wt[e])return Wt[e];var t=v("<"+e+">").appendTo(i.body),n=t.css("display");t.remove();if(n==="none"||n===""){Pt=i.body.appendChild(Pt||v.extend(i.createElement("iframe"),{frameBorder:0,width:0,height:0}));if(!Ht||!Pt.createElement)Ht=(Pt.contentWindow||Pt.contentDocument).document,Ht.write("<!doctype html><html><body>"),Ht.close();t=Ht.body.appendChild(Ht.createElement(e)),n=Dt(t,"display"),i.body.removeChild(Pt)}return Wt[e]=n,n}function fn(e,t,n,r){var i;if(v.isArray(t))v.each(t,function(t,i){n||sn.test(e)?r(e,i):fn(e+"["+(typeof i=="object"?t:"")+"]",i,n,r)});else if(!n&&v.type(t)==="object")for(i in t)fn(e+"["+i+"]",t[i],n,r);else r(e,t)}function Cn(e){return function(t,n){typeof t!="string"&&(n=t,t="*");var r,i,s,o=t.toLowerCase().split(y),u=0,a=o.length;if(v.isFunction(n))for(;u<a;u++)r=o[u],s=/^\+/.test(r),s&&(r=r.substr(1)||"*"),i=e[r]=e[r]||[],i[s?"unshift":"push"](n)}}function kn(e,n,r,i,s,o){s=s||n.dataTypes[0],o=o||{},o[s]=!0;var u,a=e[s],f=0,l=a?a.length:0,c=e===Sn;for(;f<l&&(c||!u);f++)u=a[f](n,r,i),typeof u=="string"&&(!c||o[u]?u=t:(n.dataTypes.unshift(u),u=kn(e,n,r,i,u,o)));return(c||!u)&&!o["*"]&&(u=kn(e,n,r,i,"*",o)),u}function Ln(e,n){var r,i,s=v.ajaxSettings.flatOptions||{};for(r in n)n[r]Line truncated
@@ -0,0 +1,70 @@
+window.onhashchange = function() {
+  choose(window.location.href.toString());
+}
+
+var selectionImage;
+
+function choose(url) {
+  var f = url.split("/").slice(-1)[0].split("?")[0];
+  if(f.match(/#/g) && f.match(/#/g).length > 0) {
+    f = f.split("#")[0];
+  }
+  $('div.non-sidebar').empty();
+  $('div.non-sidebar').load("operations/" + f + ".html", function(){
+    goToAnchor();
+    // rebind the models
+    $(".model a").on("click", function(e){
+      e.preventDefault();
+      var model = $(this).parent().attr("data-model")
+      var parentOffset = $(this).parent().offset();
+      var encodedWord = encodeURI(model);
+
+      if(!selectionImage) {
+          selectionImage = $('<div>').attr({
+          title: 'Model detail',
+          target: '_blank',
+          class: 'model-detail-popup'
+        }).hide();
+        $('div.model-container').append(selectionImage);
+      }
+
+      selectionImage.load("models/" + encodedWord + ".html")
+      selectionImage.attr('href',url.replace('{term}',encodeURI(model))).css({
+        left: e.pageX + 20,
+        top:  e.pageY - 10,
+        position: "absolute"
+      }).fadeIn();
+    })
+  });
+
+  $("body").on("click",function(e) {
+    var target = $(e.target);
+    if (target.parents(".model-detail-popup").length == 0 && target.parents('.model').length != 1) {
+      if(document.querySelector('.model-detail-popup')) {
+        document.querySelector('.model-detail-popup').style.display = 'none';
+      }
+    }
+  });
+}
+
+function goToAnchor() {
+  var doARead = $($('a')[0]).offset();
+  var anchorArr = window.location.href.toString().split("#");
+  if(anchorArr.length > 2) {
+    var anchor = anchorArr[anchorArr.length-1];
+    window.scrollTo(0,$('a[name='+anchor+']').offset().top - 80);
+  }
+}
+function resize()
+{
+    $(".sidebar").css('height', $(window).height() -60);
+    $("#content-window").css('height', $(window).height() -60);
+
+}
+$(function(){
+    window.onresize = resize;
+    resize();
+    $(window).bind('hashchange', function() {
+        choose(window.location.href.toString());
+    });
+});
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+  <link rel="stylesheet" type="text/css" href="assets/css/bootstrap.css" media="screen">
+  <link rel="stylesheet" type="text/css" href="assets/css/bootstrap-responsive.css" media="screen">
+  <link rel="stylesheet" type="text/css" href="assets/css/style.css">
+  <script src="assets/js/jquery-1.8.3.min.js" type="text/javascript"></script>
+  <script src="assets/js/main.js" type="text/javascript"></script>
+
+  <title>REST API Resources</title>
+</head>
+<body>
+  <div class="header">
+    <div class="top-bar">
+      <h1 id="logo"><a class="logo" href="/"><span>Swagger</span><span class="light">API Docs</span></a></h1>
+    </div>
+  </div>
+  <div class="model-container"></div>
+  <div class="content">
+    <div class="box clearfix">
+      <div class="sidebar">
+        <div class="section-box">
+          <div class="section-header">
+            Overview
+          </div>
+          <ul>
+            <li>Getting Started</li>
+          </ul>
+        </div>
+        <div class="section-box">
+          <div class="section-header">
+            <a href="#!/AdminsApi">AdminsApi</a>
+          </div>
+          <ul>
+            <li><a href="#!/AdminsApi#clubsPost">clubsPost</a></li>
+          </ul>
+        </div>
+        <div class="section-box">
+          <div class="section-header">
+            <a href="#!/PlayersApi">PlayersApi</a>
+          </div>
+          <ul>
+            <li><a href="#!/PlayersApi#clubsClubIdCompetitionsCompetitionIdGamesGet">clubsClubIdCompetitionsCompetitionIdGamesGet</a></li>
+            <li><a href="#!/PlayersApi#clubsClubIdCompetitionsGet">clubsClubIdCompetitionsGet</a></li>
+            <li><a href="#!/PlayersApi#clubsClubIdGet">clubsClubIdGet</a></li>
+            <li><a href="#!/PlayersApi#clubsClubIdMembersGet">clubsClubIdMembersGet</a></li>
+            <li><a href="#!/PlayersApi#clubsGet">clubsGet</a></li>
+            <li><a href="#!/PlayersApi#gamesGameIdGet">gamesGameIdGet</a></li>
+          </ul>
+        </div>
+      </div>
+    <div class="non-sidebar">
+      <div class="main-content">
+        <h2>Getting Started</h2>
+        <p>To begin using your fancy HTTP API, follow the steps below.</p>
+        <p>You can add some helpful tips, here</p>
+      </div>
+    </div>
+  </div>
+</body>
+</html>
@@ -0,0 +1,37 @@
+
+<h2>Club</h2>
+<ul class="parameter">
+  <li class="param-required-false">id : String
+    <br/>The unique identifier for the club
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">name : String
+    <br/>The name of the club
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">members : List
+    <br/>
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">competitions : List
+    <br/>
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">ongoing : Boolean
+    <br/>Indicates if the club is currently active
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">start_date : date
+    <br/>The start date of the club&#x27;s activity
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">end_date : date
+    <br/>The end date of the club&#x27;s activity
+  </li>
+</ul>
@@ -0,0 +1,32 @@
+
+<h2>Competition</h2>
+<ul class="parameter">
+  <li class="param-required-false">id : String
+    <br/>The unique identifier for the competition
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">name : String
+    <br/>The name of the competition
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">club_id : String
+    <br/>The ID of the club hosting the competition
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">start_date : date
+    <br/>The start date of the competition
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">end_date : date
+    <br/>The end date of the competition
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">games : List
+    <br/>
+  </li>
+</ul>
@@ -0,0 +1,61 @@
+
+<h2>Game</h2>
+<ul class="parameter">
+  <li class="param-required-false">id : String
+    <br/>The unique identifier for the game
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">competition_id : String
+    <br/>The ID of the competition the game belongs to
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">player1_id : String
+    <br/>The ID of the first player
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">player2_id : String
+    <br/>The ID of the second player
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">date_played : Date
+    <br/>The date and time when the game was played
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">ongoing : Boolean
+    <br/>Indicates if the game is currently ongoing
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">outcome : String
+    <br/>The outcome of the game
+      <dl class="param-enum">
+        <dt>Enum:
+            <dd>win</dd>
+            <dd>lose</dd>
+            <dd>draw</dd>
+            <dd>maximum_turns</dd>
+            <dd>ongoing</dd>
+        </dt>
+      </dl>
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">points_player1 : Integer
+    <br/>Points scored by player 1 in the game
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">points_player2 : Integer
+    <br/>Points scored by player 2 in the game
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">turns : Integer
+    <br/>The amount of turns taken
+  </li>
+</ul>
@@ -0,0 +1,22 @@
+
+<h2>Player</h2>
+<ul class="parameter">
+  <li class="param-required-false">id : String
+    <br/>The unique identifier for the player
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">name : String
+    <br/>The name of the player
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">moyenne : BigDecimal
+    <br/>The player&#x27;s moyenne (average points per turn)
+  </li>
+</ul>
+<ul class="parameter">
+  <li class="param-required-false">competitions : List
+    <br/>
+  </li>
+</ul>
@@ -0,0 +1,29 @@
+<div class="main-content">
+  <h2><a name=""></a></h2>
+  <p>This is the  API</p>
+
+  <h2><a name="clubsPost"></a>clubsPost</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>POST</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Club"><a href="">Club</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      
+      
+      <span class="param-in">Body: </span>
+      <span class="param-name">body</span>
+      <span class="param-type">Club(Club)</span>
+      
+      <p class="param-description"></p>
+	  </li>
+  </ul>
+</div>
@@ -0,0 +1,149 @@
+<div class="main-content">
+  <h2><a name=""></a></h2>
+  <p>This is the  API</p>
+
+  <h2><a name="clubsClubIdCompetitionsCompetitionIdGamesGet"></a>clubsClubIdCompetitionsCompetitionIdGamesGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs/{club_id}/competitions/{competition_id}/games</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Game"><a href="">List</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">club_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the club</p>
+	  </li>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">competition_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the competition</p>
+	  </li>
+  </ul>
+  <h2><a name="clubsClubIdCompetitionsGet"></a>clubsClubIdCompetitionsGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs/{club_id}/competitions</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Competition"><a href="">List</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">club_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the club to retrieve competitions from</p>
+	  </li>
+  </ul>
+  <h2><a name="clubsClubIdGet"></a>clubsClubIdGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs/{club_id}</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Club"><a href="">Club</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">club_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the club to retrieve</p>
+	  </li>
+  </ul>
+  <h2><a name="clubsClubIdMembersGet"></a>clubsClubIdMembersGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs/{club_id}/members</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Player"><a href="">List</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">club_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the club to retrieve members from</p>
+	  </li>
+  </ul>
+  <h2><a name="clubsGet"></a>clubsGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/clubs</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Club"><a href="">List</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+  </ul>
+  <h2><a name="gamesGameIdGet"></a>gamesGameIdGet</h2>
+  <hr>
+  <p></p>
+  
+  <h3 class="section">URL</h3>
+  <code>https://virtserver.swaggerhub.com/chemistry.software/biljart-api/1.0.0/games/{game_id}</code>
+  <h3 class="section">HTTP Method</h3>
+  <code>GET</code>
+  <h3 class="section">Response Type</h3>
+  <div class="model" data-model="Game"><a href="">Game</a></div>
+  <h3 class="section">Parameters</h3>
+  <ul>
+	  <li class="parameter">
+      
+      
+      <span class="param-in">Path: </span>
+      
+      
+      <span class="param-name">game_id</span>
+      <span class="param-type">String</span>
+      
+      <p class="param-description">ID of the game to retrieve</p>
+	  </li>
+  </ul>
+</div>
@@ -0,0 +1,7 @@
+var express = require("express")
+
+var app = express();
+var docs_handler = express.static(__dirname + '/docs/');
+app.use(docs_handler);
+//  start the server
+app.listen(8002);
@@ -0,0 +1,12 @@
+{
+  "name": "swagger-docs",
+  "version": "1.0.0",
+  "main": "main.js",
+  "engines": {
+    "node": ">= 0.8.x"
+  },
+  "dependencies": {
+    "express": "3.x"
+  },
+  "license": "Unlicense"
+}
@@ -0,0 +1,23 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
@@ -0,0 +1 @@
+3.0.52
@@ -0,0 +1,23 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
@@ -0,0 +1 @@
+3.0.52