-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
api.yaml
418 lines (417 loc) · 15.5 KB
/
api.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# Copyright 2020 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
--- !ruby/object:Api::Product
name: Apigee
display_name: Apigee
versions:
- !ruby/object:Api::Product::Version
name: ga
base_url: https://apigee.googleapis.com/v1/
# Apigee has no beta API, but running the full Terraform
# acceptance tests depends on a beta-only resource and a bug in MM
# will generate beta tests against the GA provider in this case, so
# we fake a beta API with the same endpoint as the GA API.
- !ruby/object:Api::Product::Version
name: beta
base_url: https://apigee.googleapis.com/v1/
scopes:
- https://www.googleapis.com/auth/cloud-platform
apis_required:
- !ruby/object:Api::Product::ApiReference
name: Apigee API
url: https://console.cloud.google.com/apis/library/apigee.googleapis.com/
objects:
- !ruby/object:Api::Resource
name: 'Organization'
base_url: 'organizations'
create_url: 'organizations?parent=projects/{{project_id}}'
self_link: 'organizations/{{name}}'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
description: |
An `Organization` is the top-level container in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'projectId'
description: |
The project ID associated with the Apigee organization.
required: true
input: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: |
Output only. Name of the Apigee organization.
output: true
- !ruby/object:Api::Type::String
name: 'displayName'
description: |
The display name of the Apigee organization.
- !ruby/object:Api::Type::String
name: 'description'
description: |
Description of the Apigee organization.
- !ruby/object:Api::Type::String
name: 'analyticsRegion'
description: |
Primary GCP region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).
input: true
- !ruby/object:Api::Type::String
name: 'authorizedNetwork'
description: |
Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started).
Valid only when `RuntimeType` is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default".
- !ruby/object:Api::Type::Enum
name: 'runtimeType'
description: |
Runtime type of the Apigee organization based on the Apigee subscription purchased.
values:
- "CLOUD"
- "HYBRID"
default_value: :CLOUD
input: true
- !ruby/object:Api::Type::String
name: 'subscriptionType'
description: |
Output only. Subscription type of the Apigee organization.
Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased).
output: true
- !ruby/object:Api::Type::String
name: 'caCertificate'
description: |
Output only. Base64-encoded public certificate for the root CA of the Apigee organization.
Valid only when `RuntimeType` is CLOUD. A base64-encoded string.
output: true
- !ruby/object:Api::Type::String
name: 'runtimeDatabaseEncryptionKeyName'
description: |
Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
Update is not allowed after the organization is created.
If not specified, a Google-Managed encryption key will be used.
Valid only when `RuntimeType` is CLOUD. For example: `projects/foo/locations/us/keyRings/bar/cryptoKeys/baz`.
input: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating an API organization':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-org'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations'
- !ruby/object:Api::Resource
name: 'Instance'
base_url: 'instances'
create_url: '{{org_id}}/instances'
self_link: '{{org_id}}/instances/{{name}}'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
input: true
description: |
An `Instance` is the runtime dataplane in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'orgId'
description: |
The Apigee Organization associated with the Apigee instance,
in the format `organizations/{{org_name}}`.
required: true
input: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: |
Resource ID of the instance.
required: true
- !ruby/object:Api::Type::String
name: 'location'
description: |
Compute Engine location where the instance resides. For trial organization
subscriptions, the location must be a Compute Engine zone. For paid organization
subscriptions, it should correspond to a Compute Engine region.
required: true
- !ruby/object:Api::Type::Enum
name: 'peeringCidrRange'
description: |
The size of the CIDR block range that will be reserved by the instance.
values:
- "SLASH_16"
- "SLASH_20"
- "SLASH_22"
- !ruby/object:Api::Type::String
name: 'description'
description: |
Description of the instance.
- !ruby/object:Api::Type::String
name: 'displayName'
description: |
Display name of the instance.
- !ruby/object:Api::Type::String
name: 'diskEncryptionKeyName'
description: |
Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only.
Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
input: true
- !ruby/object:Api::Type::String
name: 'host'
description: |
Output only. Hostname or IP address of the exposed Apigee endpoint used by clients to connect to the service.
output: true
- !ruby/object:Api::Type::String
name: 'port'
description: |
Output only. Port number of the exposed Apigee endpoint.
output: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating a runtime instance':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-instance'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances/create'
- !ruby/object:Api::Resource
name: 'Environment'
base_url: 'environments'
create_url: '{{org_id}}/environments'
self_link: '{{org_id}}/environments/{{name}}'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
description: |
An `Environment` in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'orgId'
description: |
The Apigee Organization associated with the Apigee environment,
in the format `organizations/{{org_name}}`.
required: true
input: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: |
The resource ID of the environment.
required: true
- !ruby/object:Api::Type::String
name: 'displayName'
description: |
Display name of the environment.
required: false
input: true
- !ruby/object:Api::Type::String
name: 'description'
description: |
Description of the environment.
required: false
input: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating an environment':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments/create'
- !ruby/object:Api::Resource
name: 'Envgroup'
base_url: 'envgroups'
create_url: '{{org_id}}/envgroups'
self_link: '{{org_id}}/envgroups/{{name}}'
update_verb: :PATCH
update_mask: true
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
description: |
An `Environment group` in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'orgId'
description: |
The Apigee Organization associated with the Apigee environment group,
in the format `organizations/{{org_name}}`.
required: true
input: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'name'
description: |
The resource ID of the environment group.
required: true
input: true
- !ruby/object:Api::Type::Array
name: 'hostnames'
description: |
Hostnames of the environment group.
required: false
item_type: Api::Type::String
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating an environment':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.envgroups/create'
- !ruby/object:Api::Resource
name: 'InstanceAttachment'
base_url: '{{instance_id}}/attachments'
create_url: '{{instance_id}}/attachments'
delete_url: '{{instance_id}}/attachments/{{name}}'
self_link: '{{instance_id}}/attachments/{{name}}'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
input: true
description: |
An `Instance attachment` in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'instanceId'
description: |
The Apigee instance associated with the Apigee environment,
in the format `organisations/{{org_name}}/instances/{{instance_name}}`.
required: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'environment'
description: |
The resource ID of the environment.
required: true
- !ruby/object:Api::Type::String
name: 'name'
description: |
The name of the newly created attachment (output parameter).
output: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating an environment':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.instances.attachments/create'
- !ruby/object:Api::Resource
name: 'EnvgroupAttachment'
base_url: '{{envgroup_id}}/attachments'
create_url: '{{envgroup_id}}/attachments'
delete_url: '{{envgroup_id}}/attachments/{{name}}'
self_link: '{{envgroup_id}}/attachments/{{name}}'
async: !ruby/object:Api::OpAsync
operation: !ruby/object:Api::OpAsync::Operation
path: 'name'
base_url: '{{op_id}}'
wait_ms: 1000
result: !ruby/object:Api::OpAsync::Result
path: 'response'
resource_inside_response: true
status: !ruby/object:Api::OpAsync::Status
path: 'done'
complete: True
allowed:
- True
- False
error: !ruby/object:Api::OpAsync::Error
path: 'error'
message: 'message'
input: true
description: |
An `Environment Group attachment` in Apigee.
parameters:
- !ruby/object:Api::Type::String
name: 'envgroupId'
description: |
The Apigee environment group associated with the Apigee environment,
in the format `organizations/{{org_name}}/envgroups/{{envgroup_name}}`.
required: true
url_param_only: true
properties:
- !ruby/object:Api::Type::String
name: 'environment'
description: |
The resource ID of the environment.
required: true
- !ruby/object:Api::Type::String
name: 'name'
description: |
The name of the newly created attachment (output parameter).
output: true
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Creating an environment':
'https://cloud.google.com/apigee/docs/api-platform/get-started/create-environment'
api: 'https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.envgroups.attachments/create'