Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters.
Existing doc generator failed to recognize parameters as required when parameter descriptions
extended over more than one line. Besides presenting incorrect information, resulting
inconsistencies broke checks for automated sample generation.
* Regen docs
diff --git a/docs/dyn/proximitybeacon_v1beta1.beacons.html b/docs/dyn/proximitybeacon_v1beta1.beacons.html
index 107002a..64ab298 100644
--- a/docs/dyn/proximitybeacon_v1beta1.beacons.html
+++ b/docs/dyn/proximitybeacon_v1beta1.beacons.html
@@ -85,19 +85,19 @@
<p class="firstline">Returns the diagnostics Resource.</p>
<p class="toc_element">
- <code><a href="#activate">activate(beaconName=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#activate">activate(beaconName, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Activates a beacon. A beacon that is active will return information</p>
<p class="toc_element">
- <code><a href="#deactivate">deactivate(beaconName=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#deactivate">deactivate(beaconName, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deactivates a beacon. Once deactivated, the API will not return</p>
<p class="toc_element">
- <code><a href="#decommission">decommission(beaconName=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#decommission">decommission(beaconName, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Decommissions the specified beacon in the service. This beacon will no</p>
<p class="toc_element">
- <code><a href="#delete">delete(beaconName=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(beaconName, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified beacon including all diagnostics data for the beacon</p>
<p class="toc_element">
- <code><a href="#get">get(beaconName=None, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(beaconName, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns detailed information about the specified beacon.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, projectId=None, q=None, syntax=None, pageToken=None, x__xgafv=None)</a></code></p>
@@ -109,11 +109,11 @@
<code><a href="#register">register(body, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Registers a previously unregistered beacon given its `advertisedId`.</p>
<p class="toc_element">
- <code><a href="#update">update(beaconName=None, body, projectId=None, x__xgafv=None)</a></code></p>
+ <code><a href="#update">update(beaconName, body, projectId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the information about the specified beacon. **Any field that you do</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="activate">activate(beaconName=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="activate">activate(beaconName, projectId=None, x__xgafv=None)</code>
<pre>Activates a beacon. A beacon that is active will return information
and attachment data when queried via `beaconinfo.getforobserved`.
Calling this method on an already active beacon will do nothing (but
@@ -156,7 +156,7 @@
</div>
<div class="method">
- <code class="details" id="deactivate">deactivate(beaconName=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="deactivate">deactivate(beaconName, projectId=None, x__xgafv=None)</code>
<pre>Deactivates a beacon. Once deactivated, the API will not return
information nor attachment data for the beacon when queried via
`beaconinfo.getforobserved`. Calling this method on an already inactive
@@ -199,7 +199,7 @@
</div>
<div class="method">
- <code class="details" id="decommission">decommission(beaconName=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="decommission">decommission(beaconName, projectId=None, x__xgafv=None)</code>
<pre>Decommissions the specified beacon in the service. This beacon will no
longer be returned from `beaconinfo.getforobserved`. This operation is
permanent -- you will not be able to re-register a beacon with this ID
@@ -242,7 +242,7 @@
</div>
<div class="method">
- <code class="details" id="delete">delete(beaconName=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(beaconName, projectId=None, x__xgafv=None)</code>
<pre>Deletes the specified beacon including all diagnostics data for the beacon
as well as any attachments on the beacon (including those belonging to
other projects). This operation cannot be undone.
@@ -283,7 +283,7 @@
</div>
<div class="method">
- <code class="details" id="get">get(beaconName=None, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="get">get(beaconName, projectId=None, x__xgafv=None)</code>
<pre>Returns detailed information about the specified beacon.
Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)
@@ -416,16 +416,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be
@@ -670,16 +670,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be
@@ -859,16 +859,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be
@@ -1028,16 +1028,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be
@@ -1087,7 +1087,7 @@
</div>
<div class="method">
- <code class="details" id="update">update(beaconName=None, body, projectId=None, x__xgafv=None)</code>
+ <code class="details" id="update">update(beaconName, body, projectId=None, x__xgafv=None)</code>
<pre>Updates the information about the specified beacon. **Any field that you do
not populate in the submitted beacon will be permanently erased**, so you
should follow the "read, modify, write" pattern to avoid inadvertently
@@ -1211,16 +1211,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be
@@ -1380,16 +1380,16 @@
# value to the resolving service. Significant delay in transmitting this
# value to the service risks registration or resolution failures. If a
# value is not provided, the default is zero.
- "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `service_ecdh_public_key`
+ "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `beacon_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"initialEid": "A String", # An initial ephemeral ID calculated using the clock value submitted as
# `initial_clock_value`, and the secret key generated by the
# Diffie-Hellman key exchange using `service_ecdh_public_key` and
# `service_ecdh_public_key`. This initial EID value will be used by the
# service to confirm that the key exchange process was successful.
- "serviceEcdhPublicKey": "A String", # The service's public key used for the Elliptic curve Diffie-Hellman
- # key exchange. When this field is populated, `beacon_ecdh_public_key`
+ "beaconEcdhPublicKey": "A String", # The beacon's public key used for the Elliptic curve Diffie-Hellman
+ # key exchange. When this field is populated, `service_ecdh_public_key`
# must also be populated, and `beacon_identity_key` must not be.
"beaconIdentityKey": "A String", # The private key of the beacon. If this field is populated,
# `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be