Skip to content

Commit 25b10f3

Browse files
auto-docs: Update Cloud API spec (#27)
* auto-docs: Update Cloud API spec * Apply suggestions from code review --------- Co-authored-by: Kat Batuigas <[email protected]>
1 parent 7309c88 commit 25b10f3

File tree

2 files changed

+35
-8
lines changed

2 files changed

+35
-8
lines changed

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2520,8 +2520,9 @@ components:
25202520
ServerlessCluster:
25212521
description: Resource describing a ServerlessCluster.
25222522
properties:
2523-
console:
2524-
$ref: '#/components/schemas/ServerlessCluster.Console'
2523+
console_private_url:
2524+
readOnly: true
2525+
type: string
25252526
console_url:
25262527
readOnly: true
25272528
type: string
@@ -2540,6 +2541,8 @@ components:
25402541
description: Unique name of the Serverless cluster.
25412542
example: development-ServerlessCluster
25422543
type: string
2544+
network:
2545+
$ref: '#/components/schemas/ServerlessCluster.NetworkingConfig'
25432546
planned_deletion:
25442547
$ref: '#/components/schemas/PlannedDeletion'
25452548
private_link:
@@ -2562,25 +2565,47 @@ components:
25622565
type: string
25632566
title: ServerlessCluster
25642567
type: object
2565-
ServerlessCluster.Console:
2566-
type: object
25672568
ServerlessCluster.DataplaneAPI:
25682569
description: Cluster's Data Plane API properties.
25692570
properties:
2571+
private_url:
2572+
description: |-
2573+
The private URL of the data plane API, if private networking
2574+
is enabled for this cluster.
2575+
readOnly: true
2576+
type: string
25702577
url:
25712578
readOnly: true
25722579
type: string
25732580
type: object
25742581
ServerlessCluster.KafkaAPI:
25752582
description: Cluster's Kafka API properties.
25762583
properties:
2584+
private_seed_brokers:
2585+
items:
2586+
type: string
2587+
readOnly: true
2588+
title: Kafka API seed brokers (also known as bootstrap servers). Private addresses
2589+
type: array
25772590
seed_brokers:
2578-
description: Kafka API seed brokers (also known as bootstrap servers).
25792591
items:
25802592
type: string
25812593
readOnly: true
2594+
title: Kafka API seed brokers (also known as bootstrap servers). Implicitly public
25822595
type: array
25832596
type: object
2597+
ServerlessCluster.NetworkingConfig:
2598+
properties:
2599+
private:
2600+
$ref: '#/components/schemas/ServerlessCluster.NetworkingConfig.State'
2601+
public:
2602+
$ref: '#/components/schemas/ServerlessCluster.NetworkingConfig.State'
2603+
type: object
2604+
ServerlessCluster.NetworkingConfig.State:
2605+
enum:
2606+
- STATE_DISABLED
2607+
- STATE_ENABLED
2608+
type: string
25842609
ServerlessCluster.PrivateLink:
25852610
properties:
25862611
id:
@@ -2591,6 +2616,10 @@ components:
25912616
ServerlessCluster.SchemaRegistryStatus:
25922617
description: Cluster's Schema Registry properties.
25932618
properties:
2619+
private_url:
2620+
readOnly: true
2621+
title: Private URL for the schema registry
2622+
type: string
25942623
url:
25952624
readOnly: true
25962625
type: string

cloud-dataplane/cloud-dataplane.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -683,7 +683,7 @@ components:
683683
{ "reason": "API_DISABLED"
684684
"domain": "googleapis.com"
685685
"metadata": {
686-
"resource": "projects/1234",
686+
"resource": "projects/123",
687687
"service": "pubsub.googleapis.com"
688688
}
689689
}
@@ -2081,8 +2081,6 @@ components:
20812081
description: The secret data. Must be Base64-encoded.
20822082
format: byte
20832083
type: string
2084-
required:
2085-
- secret_data
20862084
type: object
20872085
UpdateSecretResponse:
20882086
description: UpdateSecretResponse is the response of UpdateSecret.

0 commit comments

Comments
 (0)