haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #9076 from hashicorp/vagrant-cloud-api-docs 

website: Vagrant Cloud API docs
This commit is contained in:
Justin Campbell 2017-10-23 09:44:51 -04:00 committed by GitHub
parent f99c5d4818 1aaa03c1b0
commit 881625006d
27 changed files with 1565 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/Gemfile
View File

@ -1,3 +1,3 @@
source "https://rubygems.org"
gem "middleman-hashicorp", "0.3.28"
gem "middleman-hashicorp", "0.3.29"

38
website/Gemfile.lock
View File

@ -1,12 +1,12 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.8)
activesupport (4.2.10)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
autoprefixer-rails (7.1.1.2)
autoprefixer-rails (7.1.5)
execjs
bootstrap-sass (3.3.7)
autoprefixer-rails (>= 5.2.1)
@ -39,10 +39,10 @@ GEM
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
erubis (2.7.0)
eventmachine (1.2.3)
eventmachine (1.2.5)
execjs (2.7.0)
ffi (1.9.18)
haml (5.0.1)
haml (5.0.4)
temple (>= 0.8.0)
tilt
hike (1.2.3)
@ -51,7 +51,7 @@ GEM
http_parser.rb (0.6.0)
i18n (0.7.0)
json (2.1.0)
kramdown (1.13.2)
kramdown (1.15.0)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
@ -78,7 +78,7 @@ GEM
rack (>= 1.4.5, < 2.0)
thor (>= 0.15.2, < 2.0)
tilt (~> 1.4.1, < 2.0)
middleman-hashicorp (0.3.28)
middleman-hashicorp (0.3.29)
bootstrap-sass (~> 3.3)
builder (~> 3.2)
middleman (~> 3.4)
@ -101,11 +101,11 @@ GEM
mime-types (3.1)
mime-types-data (~> 3.2015)
mime-types-data (3.2016.0521)
mini_portile2 (2.2.0)
minitest (5.10.2)
multi_json (1.12.1)
nokogiri (1.8.0)
mini_portile2 (~> 2.2.0)
mini_portile2 (2.3.0)
minitest (5.10.3)
multi_json (1.12.2)
nokogiri (1.8.1)
mini_portile2 (~> 2.3.0)
padrino-helpers (0.12.8.1)
i18n (~> 0.6, >= 0.6.7)
padrino-support (= 0.12.8.1)
@ -115,14 +115,14 @@ GEM
rack (1.6.8)
rack-livereload (0.3.16)
rack
rack-test (0.6.3)
rack (>= 1.0)
rb-fsevent (0.9.8)
rack-test (0.7.0)
rack (>= 1.0, < 3)
rb-fsevent (0.10.2)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
redcarpet (3.4.0)
rouge (2.1.1)
sass (3.4.24)
rouge (2.2.1)
sass (3.4.25)
sprockets (2.12.4)
hike (~> 1.2)
multi_json (~> 1.0)
@ -134,7 +134,7 @@ GEM
sprockets (~> 2.0)
tilt (~> 1.1)
temple (0.8.0)
thor (0.19.4)
thor (0.20.0)
thread_safe (0.3.6)
tilt (1.4.1)
turbolinks (5.0.1)
@ -153,7 +153,7 @@ PLATFORMS
ruby
DEPENDENCIES
middleman-hashicorp (= 0.3.28)
middleman-hashicorp (= 0.3.29)
BUNDLED WITH
1.15.1
1.15.4

2
website/Makefile
View File

@ -1,4 +1,4 @@
VERSION?="0.3.28"
VERSION?="0.3.29"
build:
@echo "==> Starting build in Docker..."

2
website/packer.json
View File

@ -8,7 +8,7 @@
"builders": [
{
"type": "docker",
"image": "hashicorp/middleman-hashicorp:0.3.28",
"image": "hashicorp/middleman-hashicorp:0.3.29",
"discard": "true",
"volumes": {
"{{ pwd }}": "/website"

1395
website/source/docs/vagrant-cloud/api.html.md.erb Normal file
View File

File diff suppressed because it is too large Load Diff

2
website/source/docs/vagrant-cloud/boxes/catalog.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Discovering Vagrant Boxes"
sidebar_current: "vagrant-cloud-boxes-catalog"
---

2
website/source/docs/vagrant-cloud/boxes/create-version.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Create a New Box Version"
sidebar_current: "vagrant-cloud-boxes-create-version"
---

2
website/source/docs/vagrant-cloud/boxes/create.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Creating a New Vagrant Box"
sidebar_current: "vagrant-cloud-boxes-create-x"
---

2
website/source/docs/vagrant-cloud/boxes/distributing.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Distributing Boxes"
sidebar_current: "vagrant-cloud-boxes-distributing"
---

2
website/source/docs/vagrant-cloud/boxes/index.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "About Vagrant Boxes"
sidebar_current: "vagrant-cloud-boxes"
---

2
website/source/docs/vagrant-cloud/boxes/lifecycle.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Box Versioning and Lifecycle"
sidebar_current: "vagrant-cloud-boxes-lifecycle"
---

2
website/source/docs/vagrant-cloud/boxes/private.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Private Boxes"
sidebar_current: "vagrant-cloud-boxes-private"
---

2
website/source/docs/vagrant-cloud/boxes/release-workflow.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "API Release Workflow"
sidebar_current: "vagrant-cloud-boxes-release-workflow"
---

2
website/source/docs/vagrant-cloud/boxes/using.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Finding and Using Boxes"
sidebar_current: "vagrant-cloud-boxes-using"
---

2
website/source/docs/vagrant-cloud/index.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Vagrant Cloud"
sidebar_current: "vagrant-cloud"
---

2
website/source/docs/vagrant-cloud/organizations/authentication-policy.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Organization Authentication Policy"
sidebar_current: "vagrant-cloud-organizations-authentication-policy"
---

2
website/source/docs/vagrant-cloud/organizations/create.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Create an Organization"
sidebar_current: "vagrant-cloud-organizations-create"
---

2
website/source/docs/vagrant-cloud/organizations/index.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_page_title: "Organizations in Vagrant Cloud"
sidebar_current: "vagrant-cloud-organizations"
---

2
website/source/docs/vagrant-cloud/organizations/migrate.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Migrate User to Organization"
sidebar_current: "vagrant-cloud-organizations-migrate"
---

2
website/source/docs/vagrant-cloud/request-limits.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Request Limits"
sidebar_current: "vagrant-cloud-request-limits"
---

2
website/source/docs/vagrant-cloud/support.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Vagrant Cloud Support"
sidebar_current: "vagrant-cloud-support"
---

2
website/source/docs/vagrant-cloud/users/authentication.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Authentication"
sidebar_current: "vagrant-cloud-users-authentication"
---

2
website/source/docs/vagrant-cloud/users/index.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "User Accounts"
sidebar_current: "vagrant-cloud-users"
---

2
website/source/docs/vagrant-cloud/users/recovery.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Account Recovery"
sidebar_current: "vagrant-cloud-users-recovery"
---

2
website/source/docs/vagrant-cloud/vagrant-cloud-migration.html.md
View File

@ -1,5 +1,5 @@
---
layout: "docs"
layout: "vagrant-cloud"
page_title: "Vagrant Cloud Migration"
sidebar_current: "vagrant-cloud-migration"
---

36
website/source/layouts/docs.erb
View File

@ -218,42 +218,6 @@
<li<%= sidebar_current("vagrant-cloud") %>>
<a href="/docs/vagrant-cloud/">Vagrant Cloud</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-boxes") %>>
<a href="/docs/vagrant-cloud/boxes/index.html">Boxes</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-boxes-catalog") %>><a href="/docs/vagrant-cloud/boxes/catalog.html">Catalog</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-create-x") %>><a href="/docs/vagrant-cloud/boxes/create.html">Creating a New Box</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-create-version") %>><a href="/docs/vagrant-cloud/boxes/create-version.html">Creating a New Version</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-distributing") %>><a href="/docs/vagrant-cloud/boxes/distributing.html">Distributing</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-lifecycle") %>><a href="/docs/vagrant-cloud/boxes/lifecycle.html">Lifecycle</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-private") %>><a href="/docs/vagrant-cloud/boxes/private.html">Private Boxes</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-release-workflow") %>><a href="/docs/vagrant-cloud/boxes/release-workflow.html">Release Workflow</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-using") %>><a href="/docs/vagrant-cloud/boxes/using.html">Finding & Using Boxes</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-organizations") %>>
<a href="/docs/vagrant-cloud/organizations/index.html">Organizations</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-organizations-create") %>><a href="/docs/vagrant-cloud/organizations/create.html">Create an Organization</a></li>
<li<%= sidebar_current("vagrant-cloud-organizations-migrate") %>><a href="/docs/vagrant-cloud/organizations/migrate.html">Migrate User to Organization</a></li>
<li<%= sidebar_current("vagrant-cloud-organizations-authentication-policy") %>><a href="/docs/vagrant-cloud/organizations/authentication-policy.html">Authentication Policy</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-users") %>>
<a href="/docs/vagrant-cloud/users/index.html">Users</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-users-authentication") %>><a href="/docs/vagrant-cloud/users/authentication.html">Authentication</a></li>
<li<%= sidebar_current("vagrant-cloud-users-recovery") %>><a href="/docs/vagrant-cloud/users/recovery.html">Account Recovery</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-request-limits") %>><a href="/docs/vagrant-cloud/request-limits.html">Request Limits</a></li>
<li<%= sidebar_current("vagrant-cloud-support") %>><a href="/docs/vagrant-cloud/support.html">Support</a></li>
<li<%= sidebar_current("vagrant-cloud-migration") %>><a href="/docs/vagrant-cloud/vagrant-cloud-migration.html">Vagrant Cloud Migration</a></li>
</ul>
</li>
</ul>
<% end %>

128
website/source/layouts/vagrant-cloud.erb Normal file
View File

@ -0,0 +1,128 @@
<% content_for :head do %>
<script type="text/javascript">
$(document).ready(function() {
$(".anchor-nav li").click(function() {
$(".anchor-nav li").removeClass("active");;
$(this).addClass("active");;
});
});
</script>
<style>
#docs-sidebar {
position: sticky;
top: 0;
bottom: 0;
max-height: calc(100vh);
overflow-y: scroll;
}
</style>
<% end %>
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<ul class="nav docs-sidenav">
<li><a href="/docs/">Vagrant Documentation</a></li>
<li<%= sidebar_current("vagrant-cloud") %>>
<a href="/docs/vagrant-cloud/">Vagrant Cloud</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-boxes") %>>
<a href="/docs/vagrant-cloud/boxes/index.html">Boxes</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-boxes-catalog") %>><a href="/docs/vagrant-cloud/boxes/catalog.html">Catalog</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-create-x") %>><a href="/docs/vagrant-cloud/boxes/create.html">Creating a New Box</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-create-version") %>><a href="/docs/vagrant-cloud/boxes/create-version.html">Creating a New Version</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-distributing") %>><a href="/docs/vagrant-cloud/boxes/distributing.html">Distributing</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-lifecycle") %>><a href="/docs/vagrant-cloud/boxes/lifecycle.html">Lifecycle</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-private") %>><a href="/docs/vagrant-cloud/boxes/private.html">Private Boxes</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-release-workflow") %>><a href="/docs/vagrant-cloud/boxes/release-workflow.html">Release Workflow</a></li>
<li<%= sidebar_current("vagrant-cloud-boxes-using") %>><a href="/docs/vagrant-cloud/boxes/using.html">Finding & Using Boxes</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-organizations") %>>
<a href="/docs/vagrant-cloud/organizations/index.html">Organizations</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-organizations-create") %>><a href="/docs/vagrant-cloud/organizations/create.html">Create an Organization</a></li>
<li<%= sidebar_current("vagrant-cloud-organizations-migrate") %>><a href="/docs/vagrant-cloud/organizations/migrate.html">Migrate User to Organization</a></li>
<li<%= sidebar_current("vagrant-cloud-organizations-authentication-policy") %>><a href="/docs/vagrant-cloud/organizations/authentication-policy.html">Authentication Policy</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-users") %>>
<a href="/docs/vagrant-cloud/users/index.html">Users</a>
<ul class="nav">
<li<%= sidebar_current("vagrant-cloud-users-authentication") %>><a href="/docs/vagrant-cloud/users/authentication.html">Authentication</a></li>
<li<%= sidebar_current("vagrant-cloud-users-recovery") %>><a href="/docs/vagrant-cloud/users/recovery.html">Account Recovery</a></li>
</ul>
</li>
<li<%= sidebar_current("vagrant-cloud-request-limits") %>><a href="/docs/vagrant-cloud/request-limits.html">Request Limits</a></li>
<li<%= sidebar_current("vagrant-cloud-support") %>><a href="/docs/vagrant-cloud/support.html">Support</a></li>
<li<%= sidebar_current("vagrant-cloud-migration") %>><a href="/docs/vagrant-cloud/vagrant-cloud-migration.html">Vagrant Cloud Migration</a></li>
<li<%= sidebar_current("vagrant-cloud-api") %>>
<a href="/docs/vagrant-cloud/api.html">API</a>
<ul class="nav anchor-nav">
<li>
<a href="#using-the-api">Using the API</a>
<ul class="nav">
<li><a href="#authentication">Authentication</a></li>
<li><a href="#request-and-response-format">Request and Response Format</a></li>
<li><a href="#response-codes">Response Codes</a></li>
</ul>
</li>
<li>
<a href="#creating-a-usable-box-from-scratch">Creating a usable box from scratch</a>
</li>
<li>
<a href="#authentication-1">Authentication</a>
<ul class="nav">
<li><a href="#create-a-token">Create a token</a></li>
<li><a href="#validate-a-token">Validate a token</a></li>
<li><a href="#validate-a-token">Request a 2FA code</a></li>
</ul>
</li>
<li>
<a href="#organizations">Organizations</a>
<ul class="nav">
<li><a href="#read-an-organization">Read an organization</a></li>
</ul>
</li>
<li>
<a href="#boxes">Boxes</a>
<ul class="nav">
<li><a href="#read-a-box">Read a box</a></li>
<li><a href="#create-a-box">Create a box</a></li>
<li><a href="#update-a-box">Update a box</a></li>
<li><a href="#delete-a-box">Delete a box</a></li>
</ul>
</li>
<li>
<a href="#versions">Versions</a>
<ul class="nav">
<li><a href="#read-a-version">Read a version</a></li>
<li><a href="#create-a-version">Create a version</a></li>
<li><a href="#update-a-version">Update a version</a></li>
<li><a href="#delete-a-version">Delete a version</a></li>
<li><a href="#release-a-version">Release a version</a></li>
<li><a href="#revoke-a-version">Revoke a version</a></li>
</ul>
</li>
<li>
<a href="#providers">Providers</a>
<ul class="nav">
<li><a href="#read-a-provider">Read a provider</a></li>
<li><a href="#create-a-provider">Create a providers</a></li>
<li><a href="#update-a-provider">Update a provider</a></li>
<li><a href="#delete-a-provider">Delete a provider</a></li>
<li><a href="#upload-a-provider">Upload a provider</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<% end %>
<%= yield %>
<% end %>