From ced173d2483737291f227275901d49d597614df4 Mon Sep 17 00:00:00 2001 From: Chris Riley Date: Tue, 21 Mar 2017 14:50:17 -0700 Subject: [PATCH] Added API docs to FTE --- .../api/configuration-versions.html.md | 6 ++- .../enterprise/api/configurations.html.md | 6 ++- .../docs/enterprise/api/environments.html.md | 6 ++- .../source/docs/enterprise/api/index.html.md | 34 ++++++----------- .../source/docs/enterprise/api/runs.html.md | 10 +++-- .../source/docs/enterprise/api/states.html.md | 8 +++- .../source/docs/enterprise/api/users.html.md | 8 +++- website/source/layouts/api.erb | 37 +++++++++++++++++++ website/source/layouts/docs.erb | 3 ++ 9 files changed, 85 insertions(+), 33 deletions(-) create mode 100644 website/source/layouts/api.erb diff --git a/website/source/docs/enterprise/api/configuration-versions.html.md b/website/source/docs/enterprise/api/configuration-versions.html.md index 76150ff72..579ebf24d 100755 --- a/website/source/docs/enterprise/api/configuration-versions.html.md +++ b/website/source/docs/enterprise/api/configuration-versions.html.md @@ -1,5 +1,9 @@ --- -title: "Build Configuration Versions API" +layout: "api" +page_title: "Configuration Versions API" +sidebar_current: "docs-enterprise-api-configversions" +description: |- + A configuration version represents versions of Terrraform configuration. --- # Configuration Versions API diff --git a/website/source/docs/enterprise/api/configurations.html.md b/website/source/docs/enterprise/api/configurations.html.md index 8fcdb1a3a..ef4b81dec 100755 --- a/website/source/docs/enterprise/api/configurations.html.md +++ b/website/source/docs/enterprise/api/configurations.html.md @@ -1,5 +1,9 @@ --- -title: "Terraform Configuration API" +layout: "api" +page_title: "Terraform Configuration API" +sidebar_current: "docs-enterprise-api-configurations" +description: |- + A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration.. --- # Terraform Configuration API diff --git a/website/source/docs/enterprise/api/environments.html.md b/website/source/docs/enterprise/api/environments.html.md index 82a967f91..6e9976134 100755 --- a/website/source/docs/enterprise/api/environments.html.md +++ b/website/source/docs/enterprise/api/environments.html.md @@ -1,5 +1,9 @@ --- -title: "Environments API" +layout: "api" +page_title: "Environments API" +sidebar_current: "docs-enterprise-api-environments" +description: |- + Environments represent running infrastructure managed by Terraform. --- # Environments API diff --git a/website/source/docs/enterprise/api/index.html.md b/website/source/docs/enterprise/api/index.html.md index ff5c6d1aa..3d286dd94 100755 --- a/website/source/docs/enterprise/api/index.html.md +++ b/website/source/docs/enterprise/api/index.html.md @@ -1,33 +1,21 @@ --- -title: "Atlas API Documentation" +layout: "api" +page_title: "API Documentation" +sidebar_current: "docs-enterprise-api" +description: |- + Terraform Enterprise provides an API for a **subset of features**. --- -# Atlas API Documentation +# Terraform Enterprise API Documentation -Atlas provides an API for a **subset of features** available. For questions +Terraform Enterprise provides an API for a **subset of features** available. For questions or requests for new API features please email [support@hashicorp.com](mailto:support@hashicorp.com). -## Available Endpoints +## Available Endpoints Terraform Enterprise -These are the currently supported API endpoints for each product: - -### Vagrant - -- [Boxes](/help/api/vagrant/boxes) -- [Box Versions](/help/api/vagrant/box-versions) -- [Box Providers](/help/api/vagrant/box-providers) - -### Packer - -- [Build configurations](/help/api/packer/build-configurations) -- [Build configuration versions](/help/api/packer/build-configuration-versions) -- [Builds](/help/api/packer/builds) - -### Terraform - -- [Environments](/help/api/terraform/environments) -- [Runs](/help/api/terraform/runs) -- [States](/help/api/terraform/states) +- [Environments](/docs/enterprise/api/environments.html) +- [Runs](/docs/enterprise/api/runs.html) +- [States](/docs/enterprise/api/states.html) ## Authentication diff --git a/website/source/docs/enterprise/api/runs.html.md b/website/source/docs/enterprise/api/runs.html.md index 70d134498..f81c81fb9 100755 --- a/website/source/docs/enterprise/api/runs.html.md +++ b/website/source/docs/enterprise/api/runs.html.md @@ -1,12 +1,16 @@ --- -title: "Runs API" +layout: "api" +page_title: "Runs API" +sidebar_current: "docs-enterprise-api-runs" +description: |- + Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply. --- # Runs API -Runs in Atlas represents a two step Terraform plan and a subsequent apply. +Runs in Terraform Enterprise represents a two step Terraform plan and a subsequent apply. -Runs are queued under [environments](/help/api/terraform/environments) +Runs are queued under [environments](/docs/enterprise/api/environments.html) and require a two-step confirmation workflow. However, environments can be configured to auto-apply to avoid this. diff --git a/website/source/docs/enterprise/api/states.html.md b/website/source/docs/enterprise/api/states.html.md index 5e77d624d..6b20c566e 100755 --- a/website/source/docs/enterprise/api/states.html.md +++ b/website/source/docs/enterprise/api/states.html.md @@ -1,10 +1,14 @@ --- -title: "State API" +layout: "api" +page_title: "State API" +sidebar_current: "docs-enterprise-api-states" +description: |- + State represents the status of your infrastructure at the last time Terraform was run. --- # State API -State represents the status of your infrastructure at the last time Terraform was run. States can be pushed to Atlas from Terraform's CLI after an apply is done locally, or state is automatically stored in Atlas if the apply is done in Atlas. +State represents the status of your infrastructure at the last time Terraform was run. States can be pushed to Terraform Enterprise from Terraform's CLI after an apply is done locally, or state is automatically stored if the apply is done in Terraform Enterprise. ### State Attributes diff --git a/website/source/docs/enterprise/api/users.html.md b/website/source/docs/enterprise/api/users.html.md index 46e5119fa..f6d771753 100755 --- a/website/source/docs/enterprise/api/users.html.md +++ b/website/source/docs/enterprise/api/users.html.md @@ -1,10 +1,14 @@ --- -title: "Users API" +layout: "api" +page_title: "Users API" +sidebar_current: "docs-enterprise-api-users" +description: |- + Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources. --- # Users API -Users are both users and organizations in Atlas. They are the +Users are both users and organizations in Terraform Enterprise. They are the parent resource of all resources. Currently, only the retrieval of users is avaiable on the API. Additionally, diff --git a/website/source/layouts/api.erb b/website/source/layouts/api.erb new file mode 100644 index 000000000..147af5115 --- /dev/null +++ b/website/source/layouts/api.erb @@ -0,0 +1,37 @@ +<% wrap_layout :inner do %> + <% content_for :sidebar do %> + + <% end %> + + <%= yield %> +<% end %> diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index de0a7c642..2d66abbe6 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -564,6 +564,9 @@ > Organizations + > + API + > Billing