From 3f9bd9b579ae17ddcc56794936fc1391151c7fc0 Mon Sep 17 00:00:00 2001 From: Ben Drucker Date: Sat, 23 Jan 2021 16:10:44 -0800 Subject: [PATCH] docs: match provider config schema (#42) * docs: fix vcs_type (optional for GitHub) * update all provider args --- website/docs/index.html.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index 8a831bde..91a23a3b 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -34,6 +34,8 @@ resource "circleci_context" "build" { The following arguments are supported: -* `vcs_type` - (Required) The version control system, either "github" or "bitbucket". * `api_token` - (Required) A CircleCI API token. This can also be set via the `CIRCLECI_TOKEN` environment variable. -* `organization` - (Optional) The organization where resources will be created. If unset, an organization must be provided with each resource. +* `vcs_type` - (Optional) The version control system, either `"github"` or `"bitbucket"`. Defaults to `"github"`. This can also be set via the `CIRCLECI_VCS_TYPE` environment variable. +* `organization` - (Optional) The organization where resources will be created. If unset, an organization must be provided with each resource. This can also be set via the `CIRCLECI_ORGANIZATION` environment variable. +* `url` - (Optional) The URL for the the CircleCI API (v1). Defaults to `"https://circleci.com/api/v1.1/"`. This value should generally only be set for testing. This can also be set via the `CIRCLECI_URL` environment variable. +* `graphql_url` - (Optional) The URL for the the CircleCI GraphQL API (unstable). Defaults to `"https://circleci.com/graphql-unstable"`. This value should generally only be set for testing. This can also be set via the `CIRCLECI_GRAPHQL_URL` environment variable.