Skip to content

Commit 871cf24

Browse files
authored
chore(docs): support is_secret boolean on environment variables (#471)
* feat: support `is_secret` boolean on environment variables * fix: whitespace from `make all` command by upgrading to go 1.20 * chore(docs): update description for is_secret
1 parent 2a69b40 commit 871cf24

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

go/models/create_env_vars_params_body_items.go

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go/models/env_var.go

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go/models/update_env_var_params_body.go

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swagger.yml

+18
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,12 @@ paths:
280280
type: array
281281
items:
282282
$ref: '#/definitions/envVarValue'
283+
is_secret:
284+
type: boolean
285+
description: >-
286+
Secret values are only readable by code running on Netlify’s systems.
287+
With secrets, only the local development context values are readable from the UI, API, and CLI.
288+
By default, environment variable values are not secret. (Enterprise plans only)
283289
- name: account_id
284290
description: Scope response to account_id
285291
type: string
@@ -378,6 +384,12 @@ paths:
378384
type: array
379385
items:
380386
$ref: '#/definitions/envVarValue'
387+
is_secret:
388+
type: boolean
389+
description: >-
390+
Secret values are only readable by code running on Netlify’s systems.
391+
With secrets, only the local development context values are readable from the UI, API, and CLI.
392+
By default, environment variable values are not secret. (Enterprise plans only)
381393
- name: site_id
382394
description: 'If provided, update an environment variable set on this site'
383395
type: string
@@ -2722,6 +2734,12 @@ definitions:
27222734
$ref: '#/definitions/envVarValue'
27232735
description: An array of Value objects containing values and metadata
27242736
x-faker: internet.password
2737+
is_secret:
2738+
type: boolean
2739+
description: >-
2740+
Secret values are only readable by code running on Netlify’s systems.
2741+
With secrets, only the local development context values are readable from the UI, API, and CLI.
2742+
By default, environment variable values are not secret. (Enterprise plans only)
27252743
updated_at:
27262744
type: string
27272745
format: date-time

0 commit comments

Comments
 (0)