Skip to content

Commit 76a64d0

Browse files
committed
Add missed comments
1 parent 693fda9 commit 76a64d0

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

generator/src/main/resources/line-bot-sdk-ruby-rbs-generator/api.pebble

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,12 @@ module Line
4949
) -> void
5050
{%- for op in operations.operation %}
5151

52+
{% if op.nickname == "issue_stateless_channel_token" -%}
53+
# @deprecated
54+
# This is deprecated.
55+
# Please use {{ '{' }}#issue_stateless_channel_token_by_jwt_assertion_with_http_info} or {{ '{' }}#issue_stateless_channel_token_by_client_secret_with_http_info} instead.
56+
#
57+
{% endif -%}
5258
# {{ op.notes }}
5359
# This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
5460
# This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -73,6 +79,9 @@ module Line
7379
{%- endif %}
7480
{%- endfor %}
7581
# @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
82+
{% if op.nickname == "issue_stateless_channel_token" -%}
83+
%a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion_with_http_info or #issue_stateless_channel_token_by_client_secret_with_http_info instead}
84+
{% endif -%}
7685
def {{op.nickname}}_with_http_info: (
7786
{%- for param in op.allParams %}
7887
{{ param.required ? '' : '?' }}{{param.paramName}}: {{ formatDataType(param) }}{{ param.required ? '' : '?' }}{{ loop.last ? '' : ', ' -}}
@@ -84,6 +93,12 @@ module Line
8493
| [String?, Integer, Hash[untyped, untyped]] # otherwise
8594
)
8695

96+
{% if op.nickname == "issue_stateless_channel_token" -%}
97+
# @deprecated
98+
# This is deprecated.
99+
# Please use {{ '{' }}#issue_stateless_channel_token_by_jwt_assertion} or {{ '{' }}#issue_stateless_channel_token_by_client_secret} instead.
100+
#
101+
{% endif -%}
87102
# {{ op.notes }}
88103
# This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
89104
# When you want to get HTTP status code or response headers, use {{ '{#' }}{{op.nickname}}_with_http_info} instead of this.
@@ -108,6 +123,9 @@ module Line
108123
{%- endif %}
109124
{%- endfor %}
110125
# @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
126+
{% if op.nickname == "issue_stateless_channel_token" -%}
127+
%a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion or #issue_stateless_channel_token_by_client_secret instead}
128+
{% endif -%}
111129
def {{op.nickname}}: (
112130
{%- for param in op.allParams %}
113131
{{ param.required ? '' : '?' }}{{param.paramName}}: {{ formatDataType(param) }}{{ param.required ? '' : '?' }}{{ loop.last ? '' : ', ' -}}

sig/line/bot/v2/channel_access_token/api/channel_access_token_client.rbs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,10 @@ module Line
147147
| String? # otherwise
148148
)
149149

150+
# @deprecated
151+
# This is deprecated.
152+
# Please use {#issue_stateless_channel_token_by_jwt_assertion_with_http_info} or {#issue_stateless_channel_token_by_client_secret_with_http_info} instead.
153+
#
150154
# Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
151155
# This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
152156
# This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -159,6 +163,7 @@ module Line
159163
# @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
160164
# @return [Array(Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse, Integer, Hash{String => String})] when HTTP status code is 200
161165
# @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
166+
%a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion_with_http_info or #issue_stateless_channel_token_by_client_secret_with_http_info instead}
162167
def issue_stateless_channel_token_with_http_info: (
163168
?grant_type: String?,
164169
?client_assertion_type: String?,
@@ -170,6 +175,10 @@ module Line
170175
| [String?, Integer, Hash[untyped, untyped]] # otherwise
171176
)
172177

178+
# @deprecated
179+
# This is deprecated.
180+
# Please use {#issue_stateless_channel_token_by_jwt_assertion} or {#issue_stateless_channel_token_by_client_secret} instead.
181+
#
173182
# Issues a new stateless channel access token, which doesn't have max active token limit unlike the other token types. The newly issued token is only valid for 15 minutes but can not be revoked until it naturally expires.
174183
# This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
175184
# When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_with_http_info} instead of this.
@@ -182,6 +191,7 @@ module Line
182191
# @see https://developers.line.biz/en/reference/messaging-api/#issue-stateless-channel-access-token
183192
# @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] when HTTP status code is 200
184193
# @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
194+
%a{deprecated: Use #issue_stateless_channel_token_by_jwt_assertion or #issue_stateless_channel_token_by_client_secret instead}
185195
def issue_stateless_channel_token: (
186196
?grant_type: String?,
187197
?client_assertion_type: String?,

0 commit comments

Comments
 (0)