Merge pull request #78 from DrFaust92/scopes

Scopes Docs
DrFaust92 · Jun 18, 2022 · e3d132d · e3d132d
2 parents 76a7be3 + db78206
commit e3d132d
Show file tree

Hide file tree

Showing 29 changed files with 61 additions and 27 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -15,7 +15,7 @@ jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
         use-quiet-mode: 'yes'
@@ -26,25 +26,9 @@ jobs:
   markdown-lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: avto-dev/markdown-lint@v1
         with:
           config: '.markdownlint.yml'
           args: 'docs'
-  misspell:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      # See also: https://github.com/actions/setup-go/pull/62
-      - run: echo "GO_VERSION=$(cat .go-version)" >> $GITHUB_ENV
-      - uses: actions/setup-go@v2
-        with:
-          go-version: ${{ env.GO_VERSION }}
-      - uses: actions/cache@v2
-        continue-on-error: true
-        timeout-minutes: 2
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-pkg-mod-${{ hashFiles('go.sum') }}
-      - run: go install github.com/client9/misspell/cmd/misspell
-      - run: misspell -error -source text docs/
+
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -7,12 +7,12 @@ jobs:
     name: Run linter
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v2
+      - uses: actions/setup-go@v3
         with:
           go-version: '1.18'
       - uses: actions/checkout@v3          
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.45.2
+          version: v1.46.2
           only-new-issues: true
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -20,15 +20,15 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
       -
         name: Unshallow
         run: git fetch --prune --unshallow
       -
         name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
-          go-version: 1.18
+          go-version: '1.18'
       -
         name: Import GPG key
         id: import_gpg
@@ -39,7 +39,7 @@ jobs:
           PASSPHRASE: ${{ secrets.PASSPHRASE }}
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2.8.0
+        uses: goreleaser/goreleaser-action@v3
         with:
           version: latest
           args: release --rm-dist

diff --git a/.go-version b/.go-version
diff --git a/docs/data-sources/current_user.md b/docs/data-sources/current_user.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data of the current user.
 
+OAuth2 Scopes: `account`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/hook_types.md b/docs/data-sources/hook_types.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data of hook types.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/ip_ranges.md b/docs/data-sources/ip_ranges.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch IP Ranges for whitelisting.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/pipeline_oidc_config.md b/docs/data-sources/pipeline_oidc_config.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data on a pipeline OIDC Config.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/pipeline_oidc_config_keys.md b/docs/data-sources/pipeline_oidc_config_keys.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data on a pipeline OIDC Config Keys.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/workspace.md b/docs/data-sources/workspace.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data on a workspace.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/data-sources/workspace_members.md b/docs/data-sources/workspace_members.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides a way to fetch data on a the members of a workspace.
 
+OAuth2 Scopes: `account`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/index.md b/docs/index.md
@@ -49,3 +49,7 @@ The following arguments are supported in the `provider` block:
 
 * `oauth_token` - (Optional) Your password used to connect to bitbucket. You can
 also set this via the environment variable. `BITBUCKET_OAUTH_TOKEN`
+
+## OAuth2 Scopes
+
+To interacte with the Bitbucket API, an [App Password](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/) is required. App passwords are limited in scope, each API requires certain scopse to interact with, each resource doc will specifiy what are the scopes required to use that resource. See [Docs](https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/) for more inforamtion on scopes.
diff --git a/docs/resources/branch_restriction.md b/docs/resources/branch_restriction.md
@@ -12,6 +12,8 @@ Provides a Bitbucket branch restriction resource.
 
 This allows you for setting up branch restrictions for your repository.
 
+OAuth2 Scopes: `repository:admin`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/branching_model.md b/docs/resources/branching_model.md
@@ -12,6 +12,8 @@ Provides a Bitbucket branching model resource.
 
 This allows you for setting up branching models for your repository.
 
+OAuth2 Scopes: `repository:admin`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/default_reviewers.md b/docs/resources/default_reviewers.md
@@ -10,6 +10,8 @@ description: |-
 
 Provides support for setting up default reviewers for your repository. You must however have the UUID of the user available. Since Bitbucket has removed usernames from its APIs the best case is to use the UUID via the data provider.
 
+OAuth2 Scopes: `pullrequest` and `repository:admin`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/deploy_key.md b/docs/resources/deploy_key.md
@@ -12,6 +12,8 @@ Provides a Bitbucket Deploy Key resource.
 
 This allows you to manage your Deploy Keys for a repository.
 
+OAuth2 Scopes: `repository` and `repository:admin`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/deployment.md b/docs/resources/deployment.md
@@ -11,6 +11,8 @@ description: |-
 
 This resource allows you to setup pipelines deployment environments.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/deployment_variable.md b/docs/resources/deployment_variable.md
@@ -11,6 +11,8 @@ description: |-
 
 This resource allows you to configure deployment variables.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/forked_repository.md b/docs/resources/forked_repository.md
@@ -15,6 +15,8 @@ private, how to fork the repository and other options. SCM cannot be overridden,
 as it is inherited from the parent repository. Creation will fail if the parent
 repo has `no_forks` as its fork policy.
 
+OAuth2 Scopes: `repository`, `repository:admin`, and `repository:delete`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/hook.md b/docs/resources/hook.md
@@ -12,6 +12,8 @@ Provides a Bitbucket hook resource.
 
 This allows you to manage your webhooks on a repository.
 
+OAuth2 Scopes: `webhook`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/pipeline_schedule.md b/docs/resources/pipeline_schedule.md
@@ -12,6 +12,8 @@ Provides a Bitbucket Pipeline Schedule resource.
 
 This allows you to manage your Pipeline Schedules for a repository.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/pipeline_ssh_key.md b/docs/resources/pipeline_ssh_key.md
@@ -12,6 +12,8 @@ Provides a Bitbucket Pipeline Ssh Key resource.
 
 This allows you to manage your Pipeline Ssh Keys for a repository.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/pipeline_ssh_known_host.md b/docs/resources/pipeline_ssh_known_host.md
@@ -12,6 +12,8 @@ Provides a Bitbucket Pipeline Ssh Known Host resource.
 
 This allows you to manage your Pipeline Ssh Known Hosts for a repository.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/project.md b/docs/resources/project.md
@@ -11,6 +11,8 @@ description: |-
 
 This resource allows you to manage your projects in your bitbucket team.
 
+OAuth2 Scopes: `project` and `project:admin`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/repository.md b/docs/resources/repository.md
@@ -13,6 +13,8 @@ Provides a Bitbucket repository resource.
 This resource allows you manage your repositories such as scm type, if it is
 private, how to fork the repository and other options.
 
+OAuth2 Scopes: `repository`, `repository:admin`, and `repository:delete`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/repository_variable.md b/docs/resources/repository_variable.md
@@ -11,6 +11,8 @@ description: |-
 
 This resource allows you to setup pipelines variables to manage your builds with. Once you have enabled pipelines on your repository you can then further setup variables here to use.
 
+OAuth2 Scopes: `none`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/ssh_key.md b/docs/resources/ssh_key.md
@@ -12,6 +12,8 @@ Provides a Bitbucket SSH Key resource.
 
 This allows you to manage your SSH Keys for a user.
 
+OAuth2 Scopes: `account` and `account:write`
+
 ## Example Usage
 
 ```hcl

diff --git a/docs/resources/workspace_hook.md b/docs/resources/workspace_hook.md
@@ -12,6 +12,8 @@ Provides a Bitbucket workspace hook resource.
 
 This allows you to manage your webhooks on a workspace.
 
+OAuth2 Scopes: `webhook`
+
 ## Example Usage
 
 ```hcl

diff --git a/go.sum b/go.sum
@@ -62,6 +62,7 @@ github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XL
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
+github.com/client9/misspell v0.3.4 h1:ta993UF76GwbvJcIo3Y68y/M3WxlpEHPWIGDkJYwzJI=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=