Skip to content

Commit a0d16ae

Browse files
coryancoryan
authored
ci: automatically update Doxygen auth snippets (googleapis#10154)
1 parent 6bb9fc9 commit a0d16ae

92 files changed

Lines changed: 1558 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎ci/generate-markdown/update-library-landing-dox.sh‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,32 @@ IFS= mapfile -d $'\0' -t samples_cc < <(git ls-files -z -- "${LIB}/samples/*_cli
8484
sed -n '/<!-- inject-endpoint-snippet-end -->/,$p' "${MAIN_DOX}"
8585
) | sponge "${MAIN_DOX}"
8686

87+
(
88+
sed '/<!-- inject-service-account-snippet-start -->/q' "${MAIN_DOX}"
89+
if [[ ${#samples_cc[@]} -gt 0 ]]; then
90+
sample_cc="${samples_cc[0]}"
91+
client_name="$(sed -n '/main-dox-marker: / s;// main-dox-marker: \(.*\);\1;p' "${sample_cc}")"
92+
echo "@snippet $(basename "${sample_cc}") with-service-account"
93+
if [[ ${#samples_cc[@]} -gt 1 ]]; then
94+
echo
95+
echo "Follow these links to find examples for other \\c *Client classes:"
96+
for sample_cc in "${samples_cc[@]}"; do
97+
sed -n "/main-dox-marker: / s;// main-dox-marker: \(.*\); [\1](@ref \1-service-account-snippet);p" "${sample_cc}"
98+
done
99+
fi
100+
fi
101+
echo
102+
sed -n '/<!-- inject-service-account-snippet-end -->/,$p' "${MAIN_DOX}"
103+
) | sponge "${MAIN_DOX}"
104+
87105
(
88106
sed '/<!-- inject-endpoint-pages-start -->/q' "${MAIN_DOX}"
89107
for sample_cc in "${samples_cc[@]}"; do
90108
client_name=$(sed -n "/main-dox-marker: / s;// main-dox-marker: \(.*\);\1;p" "${sample_cc}")
91109
printf '\n/*! @page %s-endpoint-snippet Override %s Endpoint Configuration\n\n@snippet %s set-client-endpoint\n\n*/\n' \
92110
"${client_name}" "${client_name}" "${sample_cc}"
111+
printf '\n/*! @page %s-service-account-snippet Override %s Authentication Defaults\n\n@snippet %s with-service-account\n\n*/\n' \
112+
"${client_name}" "${client_name}" "${sample_cc}"
93113
done
94114
sed -n '/<!-- inject-endpoint-pages-end -->/,$p' "${MAIN_DOX}"
95115
) | sponge "${MAIN_DOX}"

‎google/cloud/accessapproval/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ Some applications cannot use the default authentication mechanism (known as
108108
to explicitly load a service account key file.
109109

110110
<!-- inject-service-account-snippet-start -->
111+
@snippet access_approval_client_samples.cc with-service-account
112+
111113
<!-- inject-service-account-snippet-end -->
112114

113115
Keep in mind that we chose this as an example because it is relatively easy to
@@ -146,5 +148,11 @@ can override the default policies.
146148

147149
@snippet google/cloud/accessapproval/samples/access_approval_client_samples.cc set-client-endpoint
148150

151+
*/
152+
153+
/*! @page AccessApprovalClient-service-account-snippet Override AccessApprovalClient Authentication Defaults
154+
155+
@snippet google/cloud/accessapproval/samples/access_approval_client_samples.cc with-service-account
156+
149157
*/
150158
// <!-- inject-endpoint-pages-end -->

‎google/cloud/accesscontextmanager/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ Some applications cannot use the default authentication mechanism (known as
107107
to explicitly load a service account key file.
108108

109109
<!-- inject-service-account-snippet-start -->
110+
@snippet access_context_manager_client_samples.cc with-service-account
111+
110112
<!-- inject-service-account-snippet-end -->
111113

112114
Keep in mind that we chose this as an example because it is relatively easy to
@@ -140,5 +142,11 @@ can override the default policies.
140142

141143
@snippet google/cloud/accesscontextmanager/samples/access_context_manager_client_samples.cc set-client-endpoint
142144

145+
*/
146+
147+
/*! @page AccessContextManagerClient-service-account-snippet Override AccessContextManagerClient Authentication Defaults
148+
149+
@snippet google/cloud/accesscontextmanager/samples/access_context_manager_client_samples.cc with-service-account
150+
143151
*/
144152
// <!-- inject-endpoint-pages-end -->

‎google/cloud/apigateway/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ Some applications cannot use the default authentication mechanism (known as
106106
to explicitly load a service account key file.
107107

108108
<!-- inject-service-account-snippet-start -->
109+
@snippet api_gateway_client_samples.cc with-service-account
110+
109111
<!-- inject-service-account-snippet-end -->
110112

111113
Keep in mind that we chose this as an example because it is relatively easy to
@@ -139,5 +141,11 @@ can override the default policies.
139141

140142
@snippet google/cloud/apigateway/samples/api_gateway_client_samples.cc set-client-endpoint
141143

144+
*/
145+
146+
/*! @page ApiGatewayServiceClient-service-account-snippet Override ApiGatewayServiceClient Authentication Defaults
147+
148+
@snippet google/cloud/apigateway/samples/api_gateway_client_samples.cc with-service-account
149+
142150
*/
143151
// <!-- inject-endpoint-pages-end -->

‎google/cloud/apigeeconnect/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ Some applications cannot use the default authentication mechanism (known as
110110
to explicitly load a service account key file.
111111

112112
<!-- inject-service-account-snippet-start -->
113+
@snippet connection_client_samples.cc with-service-account
114+
113115
<!-- inject-service-account-snippet-end -->
114116

115117
Keep in mind that we chose this as an example because it is relatively easy to
@@ -143,5 +145,11 @@ can override the default policies.
143145

144146
@snippet google/cloud/apigeeconnect/samples/connection_client_samples.cc set-client-endpoint
145147

148+
*/
149+
150+
/*! @page ConnectionServiceClient-service-account-snippet Override ConnectionServiceClient Authentication Defaults
151+
152+
@snippet google/cloud/apigeeconnect/samples/connection_client_samples.cc with-service-account
153+
146154
*/
147155
// <!-- inject-endpoint-pages-end -->

‎google/cloud/apikeys/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ Some applications cannot use the default authentication mechanism (known as
106106
to explicitly load a service account key file.
107107

108108
<!-- inject-service-account-snippet-start -->
109+
@snippet api_keys_client_samples.cc with-service-account
110+
109111
<!-- inject-service-account-snippet-end -->
110112

111113
Keep in mind that we chose this as an example because it is relatively easy to
@@ -139,5 +141,11 @@ can override the default policies.
139141

140142
@snippet google/cloud/apikeys/samples/api_keys_client_samples.cc set-client-endpoint
141143

144+
*/
145+
146+
/*! @page ApiKeysClient-service-account-snippet Override ApiKeysClient Authentication Defaults
147+
148+
@snippet google/cloud/apikeys/samples/api_keys_client_samples.cc with-service-account
149+
142150
*/
143151
// <!-- inject-endpoint-pages-end -->

‎google/cloud/appengine/doc/main.dox‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,18 @@ Some applications cannot use the default authentication mechanism (known as
144144
to explicitly load a service account key file.
145145

146146
<!-- inject-service-account-snippet-start -->
147+
@snippet applications_client_samples.cc with-service-account
148+
149+
Follow these links to find examples for other \c *Client classes:
150+
[ApplicationsClient](@ref ApplicationsClient-service-account-snippet)
151+
[AuthorizedCertificatesClient](@ref AuthorizedCertificatesClient-service-account-snippet)
152+
[AuthorizedDomainsClient](@ref AuthorizedDomainsClient-service-account-snippet)
153+
[DomainMappingsClient](@ref DomainMappingsClient-service-account-snippet)
154+
[FirewallClient](@ref FirewallClient-service-account-snippet)
155+
[InstancesClient](@ref InstancesClient-service-account-snippet)
156+
[ServicesClient](@ref ServicesClient-service-account-snippet)
157+
[VersionsClient](@ref VersionsClient-service-account-snippet)
158+
147159
<!-- inject-service-account-snippet-end -->
148160

149161
Keep in mind that we chose this as an example because it is relatively easy to
@@ -179,45 +191,93 @@ can override the default policies.
179191

180192
*/
181193

194+
/*! @page ApplicationsClient-service-account-snippet Override ApplicationsClient Authentication Defaults
195+
196+
@snippet google/cloud/appengine/samples/applications_client_samples.cc with-service-account
197+
198+
*/
199+
182200
/*! @page AuthorizedCertificatesClient-endpoint-snippet Override AuthorizedCertificatesClient Endpoint Configuration
183201

184202
@snippet google/cloud/appengine/samples/authorized_certificates_client_samples.cc set-client-endpoint
185203

186204
*/
187205

206+
/*! @page AuthorizedCertificatesClient-service-account-snippet Override AuthorizedCertificatesClient Authentication Defaults
207+
208+
@snippet google/cloud/appengine/samples/authorized_certificates_client_samples.cc with-service-account
209+
210+
*/
211+
188212
/*! @page AuthorizedDomainsClient-endpoint-snippet Override AuthorizedDomainsClient Endpoint Configuration
189213

190214
@snippet google/cloud/appengine/samples/authorized_domains_client_samples.cc set-client-endpoint
191215

192216
*/
193217

218+
/*! @page AuthorizedDomainsClient-service-account-snippet Override AuthorizedDomainsClient Authentication Defaults
219+
220+
@snippet google/cloud/appengine/samples/authorized_domains_client_samples.cc with-service-account
221+
222+
*/
223+
194224
/*! @page DomainMappingsClient-endpoint-snippet Override DomainMappingsClient Endpoint Configuration
195225

196226
@snippet google/cloud/appengine/samples/domain_mappings_client_samples.cc set-client-endpoint
197227

198228
*/
199229

230+
/*! @page DomainMappingsClient-service-account-snippet Override DomainMappingsClient Authentication Defaults
231+
232+
@snippet google/cloud/appengine/samples/domain_mappings_client_samples.cc with-service-account
233+
234+
*/
235+
200236
/*! @page FirewallClient-endpoint-snippet Override FirewallClient Endpoint Configuration
201237

202238
@snippet google/cloud/appengine/samples/firewall_client_samples.cc set-client-endpoint
203239

204240
*/
205241

242+
/*! @page FirewallClient-service-account-snippet Override FirewallClient Authentication Defaults
243+
244+
@snippet google/cloud/appengine/samples/firewall_client_samples.cc with-service-account
245+
246+
*/
247+
206248
/*! @page InstancesClient-endpoint-snippet Override InstancesClient Endpoint Configuration
207249

208250
@snippet google/cloud/appengine/samples/instances_client_samples.cc set-client-endpoint
209251

210252
*/
211253

254+
/*! @page InstancesClient-service-account-snippet Override InstancesClient Authentication Defaults
255+
256+
@snippet google/cloud/appengine/samples/instances_client_samples.cc with-service-account
257+
258+
*/
259+
212260
/*! @page ServicesClient-endpoint-snippet Override ServicesClient Endpoint Configuration
213261

214262
@snippet google/cloud/appengine/samples/services_client_samples.cc set-client-endpoint
215263

216264
*/
217265

266+
/*! @page ServicesClient-service-account-snippet Override ServicesClient Authentication Defaults
267+
268+
@snippet google/cloud/appengine/samples/services_client_samples.cc with-service-account
269+
270+
*/
271+
218272
/*! @page VersionsClient-endpoint-snippet Override VersionsClient Endpoint Configuration
219273

220274
@snippet google/cloud/appengine/samples/versions_client_samples.cc set-client-endpoint
221275

276+
*/
277+
278+
/*! @page VersionsClient-service-account-snippet Override VersionsClient Authentication Defaults
279+
280+
@snippet google/cloud/appengine/samples/versions_client_samples.cc with-service-account
281+
222282
*/
223283
// <!-- inject-endpoint-pages-end -->

‎google/cloud/artifactregistry/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ Some applications cannot use the default authentication mechanism (known as
107107
to explicitly load a service account key file.
108108

109109
<!-- inject-service-account-snippet-start -->
110+
@snippet artifact_registry_client_samples.cc with-service-account
111+
110112
<!-- inject-service-account-snippet-end -->
111113

112114
Keep in mind that we chose this as an example because it is relatively easy to
@@ -140,5 +142,11 @@ can override the default policies.
140142

141143
@snippet google/cloud/artifactregistry/samples/artifact_registry_client_samples.cc set-client-endpoint
142144

145+
*/
146+
147+
/*! @page ArtifactRegistryClient-service-account-snippet Override ArtifactRegistryClient Authentication Defaults
148+
149+
@snippet google/cloud/artifactregistry/samples/artifact_registry_client_samples.cc with-service-account
150+
143151
*/
144152
// <!-- inject-endpoint-pages-end -->

‎google/cloud/asset/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ Some applications cannot use the default authentication mechanism (known as
107107
to explicitly load a service account key file.
108108

109109
<!-- inject-service-account-snippet-start -->
110+
@snippet asset_client_samples.cc with-service-account
111+
110112
<!-- inject-service-account-snippet-end -->
111113

112114
Keep in mind that we chose this as an example because it is relatively easy to
@@ -140,5 +142,11 @@ can override the default policies.
140142

141143
@snippet google/cloud/asset/samples/asset_client_samples.cc set-client-endpoint
142144

145+
*/
146+
147+
/*! @page AssetServiceClient-service-account-snippet Override AssetServiceClient Authentication Defaults
148+
149+
@snippet google/cloud/asset/samples/asset_client_samples.cc with-service-account
150+
143151
*/
144152
// <!-- inject-endpoint-pages-end -->

‎google/cloud/assuredworkloads/doc/main.dox‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,8 @@ Some applications cannot use the default authentication mechanism (known as
109109
to explicitly load a service account key file.
110110

111111
<!-- inject-service-account-snippet-start -->
112+
@snippet assured_workloads_client_samples.cc with-service-account
113+
112114
<!-- inject-service-account-snippet-end -->
113115

114116
Keep in mind that we chose this as an example because it is relatively easy to
@@ -141,5 +143,11 @@ can override the default policies.
141143

142144
@snippet google/cloud/assuredworkloads/samples/assured_workloads_client_samples.cc set-client-endpoint
143145

146+
*/
147+
148+
/*! @page AssuredWorkloadsServiceClient-service-account-snippet Override AssuredWorkloadsServiceClient Authentication Defaults
149+
150+
@snippet google/cloud/assuredworkloads/samples/assured_workloads_client_samples.cc with-service-account
151+
144152
*/
145153
// <!-- inject-endpoint-pages-end -->

0 commit comments

Comments
 (0)