completed addon providers page

_includes/addon_providers_toc.html

@@ -0,0 +1 @@
+<ul class='list-unstyled'><li ><a href='addon_providers.html#list-addon-providers'>List addon providers</a></li></ul>

_includes/addons_toc.html

@@ -1 +1 @@
-<ul class='list-unstyled'><li ><a href='addons.html#list-app-addons'>List app addons</a></li></ul>
+<ul class='list-unstyled'><li ><a href='addons.html#list-app-addons'>List app addons</a></li><li ><a href='addons.html#provision-an-addon'>Provision an addon</a></li><li ><a href='addons.html#upgrade-an-addon'>Upgrade an addon</a></li></ul>

_includes/list_of_resources.html

@@ -1,3 +1,4 @@
 <li class='resource'><a href='addons.html'><strong>Addons</strong></a>{% if page.path == 'addons.html' %}{% include addons_toc.html %}{% endif %}</li>
 <li class='resource'><a href='events.html'><strong>Events</strong></a>{% if page.path == 'events.html' %}{% include events_toc.html %}{% endif %}</li>
 <li class='resource'><a href='environment.html'><strong>Environment variable</strong></a>{% if page.path == 'environment.html' %}{% include environment_toc.html %}{% endif %}</li>
+<li class='resource'><a href='addon_providers.html'><strong>Addon providers</strong></a>{% if page.path == 'addon_providers.html' %}{% include addon_providers_toc.html %}{% endif %}</li>

addons.html

@@ -65,4 +65,52 @@ <h2 id="list-app-addons">List app addons</h2>
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
+
+</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
+<h2 id="provision-an-addon">Provision an addon</h2>
+
+<p><code class="highlighter-rouge">POST https://api.scalingo.com/v1/apps/[:app]/addons</code></p>
+
+<p>Parameters:</p>
+
+<ul>
+  <li><code class="highlighter-rouge">addon.addon_provider_id</code></li>
+  <li><code class="highlighter-rouge">addon.plan_id</code></li>
+</ul>
+
+</div><div class='col-xs-12 col-sm-6 sidebar-code'>
+<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
+  -X POST https://api.scalingo.com/v1/apps/[:app]/addons <span class="se">\</span>
+  -d <span class="s1">'{"addon":{"plan_id": "1234", "addon_provider_id": "1234"}}'</span>
+</code></pre>
+</div>
+
+</div></div><div class='row'><div class='col-xs-12 col-sm-6 sidebar-text'>
+<h2 id="upgrade-an-addon">Upgrade an addon</h2>
+
+<p><code class="highlighter-rouge">PATCH https://api.scalingo.com/v1/apps/[:app]/addons/[:addon_id]</code></p>
+
+<p>Parameters:</p>
+
+<ul>
+  <li><code class="highlighter-rouge">addon.plan_id</code></li>
+</ul>
+
+</div><div class='col-xs-12 col-sm-6 sidebar-code'>
+<div class="highlighter-rouge"><pre class="highlight"><code>curl -H <span class="s2">"Accept: application/json"</span> -H <span class="s2">"Content-Type: application/json"</span> -u :<span class="nv">$AUTH_TOKEN</span> <span class="se">\</span>
+  -X POST https://api.scalingo.com/v1/apps/[:app]/addons/[:addon_id] <span class="se">\</span>
+  -d <span class="s1">'{"addon": {"plan_id": "2"}}'</span>
+</code></pre>
+</div>
+
+<p>Response:</p>
+
+<p>200 OK</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
+  </span><span class="s2">"vars"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"VAR1"</span><span class="p">,</span><span class="w"> </span><span class="s2">"VAR2"</span><span class="p">],</span><span class="w">
+  </span><span class="s2">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"&lt;custom message from the addon provider&gt;"</span><span class="w">
+</span><span class="p">}</span><span class="w">
+</span></code></pre>
+</div>
 </div></div>

markdown/addons.md

@@ -48,3 +48,51 @@ Returns 200 Created
     }]
 }
 ```
+
+--- row ---
+
+## Provision an addon
+
+`POST https://api.scalingo.com/v1/apps/[:app]/addons`
+
+Parameters:
+
+* `addon.addon_provider_id`
+* `addon.plan_id`
+
+||| col |||
+
+```shell
+curl -H "Accept: application/json" -H "Content-Type: application/json" -u :$AUTH_TOKEN \
+  -X POST https://api.scalingo.com/v1/apps/[:app]/addons \
+  -d '{"addon":{"plan_id": "1234", "addon_provider_id": "1234"}}'
+```
+
+--- row ---
+
+## Upgrade an addon
+
+`PATCH https://api.scalingo.com/v1/apps/[:app]/addons/[:addon_id]`
+
+Parameters:
+
+* `addon.plan_id`
+
+||| col |||
+
+```shell
+curl -H "Accept: application/json" -H "Content-Type: application/json" -u :$AUTH_TOKEN \
+  -X POST https://api.scalingo.com/v1/apps/[:app]/addons/[:addon_id] \
+  -d '{"addon": {"plan_id": "2"}}'
+```
+
+Response:
+
+200 OK
+
+```json
+{
+  "vars": ["VAR1", "VAR2"],
+  "message": "<custom message from the addon provider>"
+}
+```