Skip to content

Commit 9442320

Browse files
jasonbarryAlex Kahn
andauthored
chore(docs): point to new environment variable endpoints in site crud operation descriptions (#415)
* Point to new environment variable endpoints in site CRUD operation descriptions * Update wording * docs: use bold * Rebuild go library Co-authored-by: Alex Kahn <[email protected]>
1 parent 374a371 commit 9442320

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

go/plumbing/operations/operations_client.go

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swagger.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ paths:
7474
$ref: '#/definitions/site'
7575
default:
7676
$ref: '#/responses/error'
77+
description: >-
78+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
79+
Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.
7780
post:
7881
operationId: createSite
7982
tags: [site]
@@ -95,6 +98,9 @@ paths:
9598
$ref: '#/definitions/site'
9699
default:
97100
$ref: '#/responses/error'
101+
description: >-
102+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
103+
Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site.
98104
/sites/{site_id}:
99105
parameters:
100106
- name: site_id
@@ -111,6 +117,9 @@ paths:
111117
$ref: '#/definitions/site'
112118
default:
113119
$ref: '#/responses/error'
120+
description: >-
121+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
122+
Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.
114123
patch:
115124
operationId: updateSite
116125
tags: [site]
@@ -129,6 +138,9 @@ paths:
129138
$ref: '#/definitions/site'
130139
default:
131140
$ref: '#/responses/error'
141+
description: >-
142+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
143+
Please use [updateEnvVar](#tag/environmentVariables/operation/updateEnvVar) to update a site's environment variables.
132144
delete:
133145
operationId: deleteSite
134146
tags: [site]
@@ -1655,6 +1667,9 @@ paths:
16551667
$ref: '#/definitions/site'
16561668
default:
16571669
$ref: '#/responses/error'
1670+
description: >-
1671+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
1672+
Please use [createEnvVars](#tag/environmentVariables/operation/createEnvVars) to create environment variables for a site.
16581673
get:
16591674
operationId: listSitesForAccount # an account represents a team or a user
16601675
tags: [site]
@@ -1677,6 +1692,9 @@ paths:
16771692
$ref: '#/definitions/site'
16781693
default:
16791694
$ref: '#/responses/error'
1695+
description: >-
1696+
**Note:** Environment variable keys and values will soon be moved from `build_settings.env` and `repo.env` to a new endpoint.
1697+
Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.
16801698
/{account_slug}/members:
16811699
parameters:
16821700
- name: account_slug

0 commit comments

Comments
 (0)