summaryrefslogtreecommitdiff
path: root/build/html/introduction.html
blob: 91a88c2abcc68aeb14587ec26a7930ee07aedc9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Introduction &#8212; Battelrite 0.2 documentation</title>
    <link rel="stylesheet" href="_static/css/battlerite.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '0.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Datacenters" href="datacenters/datacenters.html" />
    <link rel="prev" title="Gamelocker Documentation" href="index.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  </head>
  <body>
<header id="BTT" role="banner">
	<div class="menu-top-outer clearfix">
		<div class="wrapper clearfix">
			<a href="/" id="site-logo"></a>
			<span id="logSignBtn" class="btn">Login / Signup</span>
			<nav id="mainMenu" class="main-menu-con">
				<ul class="main-menu clearfix">
					<li><a class="active" href="guides.html">Documentation</a></li>
					<li><a href="faq.html">Faqs</a></li>
					<li><a href="creations.html">Creations</a></li>
				</ul>
			</nav>
		</div>
	</div>
</header>

  <div class="related top">
  <nav id="rellinks">
    <ul>
        <li>
          &larr;
          <a href="index.html" title="Previous document">Gamelocker Documentation</a>
        </li>
        <li>
          <a href="datacenters/datacenters.html" title="Next document">Datacenters</a>
          &rarr;
        </li>
    </ul>
  </nav>
  <nav id="breadcrumbs">
    <ul>
      <li><a href="index.html">Battelrite 0.2 documentation</a></li> 
    </ul>
  </nav>
  </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p>The first version of the Vainglory Game Data Service is an exciting step forward towards making it easier for users to have open access to in-game data.</p>
<p>Build something great!</p>
<p>At the moment this Service is in Alpha Preview mode. You can see sample data, test the interface, and provide feedback to our development team.</p>
<p>While we initially took a different approach, based on community feedback the Server now makes every attempt to implement the required features of the <a class="reference external" href="http://jsonapi.org/">JSON-API</a>. specification.</p>
<p>We show example language bindings using CURL and plan to add libraries for Ruby, NodeJS, Java, Python and more. Community contributions are welcome and rewarded with good karma (and swag!) You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
<div class="section" id="versioning">
<h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline">¶</a></h2>
<p>We following <a class="reference external" href="http://semver.org/">SEMVER</a>. standards, using a MAJOR.MINOR.PATCH versioning scheme. This means that we will increment versioning in the following way:</p>
<p>MAJOR version when we make incompatible API changes,
MINOR version when we add functionality in a backwards-compatible manner,
PATCH version when we make backwards-compatible bug fixes.
You can see the current version and deploy date by viewing the Status endpoint.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#versioning">Versioning</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="datacenters/datacenters.html">Datacenters</a></li>
<li class="toctree-l1"><a class="reference internal" href="authorization/authorization.html">Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="titles/titles.html">Titles</a></li>
<li class="toctree-l1"><a class="reference internal" href="makingrequests/makingrequests.html">Making Requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="receivingresponses/receivingresponses.html">Receiving Responses</a></li>
<li class="toctree-l1"><a class="reference internal" href="matches/matches.html">Matches</a></li>
<li class="toctree-l1"><a class="reference internal" href="match_data_summary/match_data_summary.html">Match Data Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="players/players.html">Players</a></li>
<li class="toctree-l1"><a class="reference internal" href="samples/samples.html">Samples</a></li>
<li class="toctree-l1"><a class="reference internal" href="telemetry/telemetry.html">Telemetry</a></li>
<li class="toctree-l1"><a class="reference internal" href="teams/teams.html">Teams</a></li>
<li class="toctree-l1"><a class="reference internal" href="links/links.html">Links</a></li>
<li class="toctree-l1"><a class="reference internal" href="community_sdks/community_sdks.html">Community SDKs</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors/errors.html">Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog/changelog.html">Changelog</a></li>
</ul>

        </div>
      </div>
      <div class="clearer"></div>
    </div>
  <div class="related bottom">
  <nav id="rellinks">
    <ul>
        <li>
          &larr;
          <a href="index.html" title="Previous document">Gamelocker Documentation</a>
        </li>
        <li>
          <a href="datacenters/datacenters.html" title="Next document">Datacenters</a>
          &rarr;
        </li>
    </ul>
  </nav>
  <nav id="breadcrumbs">
    <ul>
      <li><a href="index.html">Battelrite 0.2 documentation</a></li> 
    </ul>
  </nav>
  </div>

  </body>
</html>