Skip to content

Commit 286a30b

Browse files
committed
Add in-code docs
1 parent 5c2e49c commit 286a30b

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ module Line
5454
end
5555
{%- for op in operations.operation %}
5656

57+
{% if op.nickname == "issue_stateless_channel_token" -%}
58+
# @deprecated
59+
# This is deprecated.
60+
# Please use {{ '{' }}Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_jwt_assertion_with_http_info} or {{ '{' }}Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_client_secret_with_http_info} instead.
61+
#
62+
{% endif -%}
5763
# {{ op.notes }}
5864
# This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
5965
# This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -132,6 +138,12 @@ module Line
132138
end
133139
end
134140

141+
{% if op.nickname == "issue_stateless_channel_token" -%}
142+
# @deprecated
143+
# This is deprecated.
144+
# Please use {{ '{' }}Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_jwt_assertion} or {{ '{' }}Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_client_secret} instead.
145+
#
146+
{% endif -%}
135147
# {{ op.notes }}
136148
# This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
137149
# When you want to get HTTP status code or response headers, use {{ '{#' }}{{op.nickname}}_with_http_info} instead of this.

lib/line/bot/v2/channel_access_token/api/channel_access_token_client.rb

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,10 @@ def issue_channel_token_by_jwt(
237237
response_body
238238
end
239239

240+
# @deprecated
241+
# This is deprecated.
242+
# Please use {Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_jwt_assertion_with_http_info} or {Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_client_secret_with_http_info} instead.
243+
#
240244
# 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.
241245
# This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
242246
# This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -284,6 +288,10 @@ def issue_stateless_channel_token_with_http_info( # steep:ignore MethodBodyTypeM
284288
end
285289
end
286290

291+
# @deprecated
292+
# This is deprecated.
293+
# Please use {Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_jwt_assertion} or {Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenClient#issue_stateless_channel_token_by_client_secret} instead.
294+
#
287295
# 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.
288296
# This requests to <code>POST https://api.line.me/oauth2/v3/token</code>
289297
# When you want to get HTTP status code or response headers, use {#issue_stateless_channel_token_with_http_info} instead of this.

0 commit comments

Comments
 (0)