gapic-generator 0.45.3 → 0.45.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/gapic/generator/version.rb +1 -1
- data/lib/gapic/presenters/field_presenter.rb +2 -2
- data/lib/gapic/schema/wrappers.rb +12 -6
- data/templates/default/lib/rest/_rest.text.erb +1 -1
- data/templates/default/service/client/method/docs/_request_normal.text.erb +1 -1
- data/templates/default/service/rest/client/method/docs/_request.text.erb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e3f7283592167653163c4acebf0950f43eae341db2d41e0a8ff65f5cbad56194
|
4
|
+
data.tar.gz: d9680dfecc27af932856241ab1e269044df8d27e33fb662b55649866dbd83554
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6cd6639f82511f747baebc0aeb4117f42561bd9987a248bfc23bdf4d9cea7f2cf04c60a00de6aefbc7e40cf3cf7861515f17b7e970ef1c7c88d793b6f52b19dd
|
7
|
+
data.tar.gz: 5479a3b76164c023acbe2415805809be3a33850f6fa71930882c507dce92d06ba289d41a2f5d94fca464a084dd7f440717c6fd902666415f2bb57a5c8235f7e1
|
data/CHANGELOG.md
CHANGED
@@ -72,8 +72,8 @@ module Gapic
|
|
72
72
|
# gRPC client classes. Uses the default transport if not provided.
|
73
73
|
# @return [String]
|
74
74
|
#
|
75
|
-
def doc_description transport: nil
|
76
|
-
@field.docs_leading_comments transport: transport
|
75
|
+
def doc_description transport: nil, is_rpc_param: false
|
76
|
+
@field.docs_leading_comments transport: transport, is_rpc_param: is_rpc_param
|
77
77
|
end
|
78
78
|
|
79
79
|
def default_value
|
@@ -983,16 +983,22 @@ module Gapic
|
|
983
983
|
|
984
984
|
# @private
|
985
985
|
# Override this to add a note related to oneofs being mutually exclusive.
|
986
|
-
def docs_leading_comments disable_xrefs: false, transport: nil
|
987
|
-
str = super
|
986
|
+
def docs_leading_comments disable_xrefs: false, transport: nil, is_rpc_param: false
|
987
|
+
str = super(disable_xrefs: disable_xrefs, transport: transport)
|
988
988
|
return str unless @oneof_siblings && @oneof_siblings.size > 1
|
989
989
|
siblings = @oneof_siblings.map { |field| "`#{field.name}`" }.join ", "
|
990
|
-
note =
|
991
|
-
|
992
|
-
|
990
|
+
note =
|
991
|
+
if is_rpc_param
|
992
|
+
"Note: The following parameters are mutually exclusive: #{siblings}. " \
|
993
|
+
"At most one of these parameters can be set. If more than one is set, " \
|
994
|
+
"only one will be used, and it is not defined which one."
|
995
|
+
else
|
996
|
+
"Note: The following fields are mutually exclusive: #{siblings}. " \
|
997
|
+
"If a field in that set is populated, all other fields in the set " \
|
998
|
+
"will automatically be cleared."
|
999
|
+
end
|
993
1000
|
str ? "#{str.strip}\n\n#{note}" : note
|
994
1001
|
end
|
995
|
-
|
996
1002
|
# @!method name
|
997
1003
|
# @return [String] the unqualified name of the field.
|
998
1004
|
# @!method number
|
@@ -15,7 +15,7 @@ require "<%= service.credentials_require %>"
|
|
15
15
|
<%- if service.paths? -%>
|
16
16
|
require "<%= service.paths_require %>"
|
17
17
|
<%- end -%>
|
18
|
-
<%- if service.lro? -%>
|
18
|
+
<%- if service.rest.lro? -%>
|
19
19
|
require "<%= service.rest.operations_require %>"
|
20
20
|
<%- end -%>
|
21
21
|
<%- if service.nonstandard_lro_provider? -%>
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<%- method.arguments.each do |arg| -%>
|
20
20
|
# @param <%= arg.name %> [<%= arg.doc_types %>]
|
21
21
|
<%- if arg.doc_description -%>
|
22
|
-
<%= indent arg.doc_description(transport: :grpc), "# " %>
|
22
|
+
<%= indent arg.doc_description(transport: :grpc, is_rpc_param: true), "# " %>
|
23
23
|
<%- end -%>
|
24
24
|
<%- end -%>
|
25
25
|
<%- end -%>
|
@@ -19,7 +19,7 @@
|
|
19
19
|
<%- method.arguments.each do |arg| -%>
|
20
20
|
# @param <%= arg.name %> [<%= arg.doc_types %>]
|
21
21
|
<%- if arg.doc_description -%>
|
22
|
-
<%= indent arg.doc_description(transport: :rest), "# " %>
|
22
|
+
<%= indent arg.doc_description(transport: :rest, is_rpc_param: true), "# " %>
|
23
23
|
<%- end -%>
|
24
24
|
<%- end -%>
|
25
25
|
<%- end -%>
|