Sync comment between code and rbs (line#556)

Resolve line#534

When jumping to RBS in the IDE, there are few comments. Having comments
would be helpful. It doesn't have to be YARD; RDoc might be preferable,
but having information is the priority. This change synchronizes with
the code comments. There are no other changes.

Author: Yang-33

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

@@ -104,6 +104,9 @@ module Line
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::{{ packageName | camelize }}::{{ model.model.classname }}] Instance of the class
           def self.create(args) # steep:ignore
             {%- if model.model.vendorExtensions.get("x-children") != null and model.model.vendorExtensions.get("x-discriminator-property") != null %}
             klass = detect_class(type: args[:{{ model.model.vendorExtensions.get("x-discriminator-property") }}])

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

@@ -9,6 +9,33 @@ module Line
       module {{ packageName | camelize }}
         class Api{{ operations.classname.indexOf('Blob') != -1 ? 'Blob' : '' }}Client
           @http_client: HttpClient
+          # Initializes a new {Line::Bot::V2::{{ packageName | camelize }}::Api{{ operations.classname.indexOf('Blob') != -1 ? 'Blob' : '' }}Client} instance.
+          #
+          # @param base_url [String] The base URL for requests (optional).
+          #   Defaults to '{{endpoint(operations.classname)}}' if none is provided.
+          #   You can override this for testing or to use a mock server.
+            {%- if packageName == 'module_attach' %}
+          # @param channel_id [String] The channel ID for Basic authentication.
+          # @param channel_secret [String] The channel secret for Basic authentication.
+            {%- elseif packageName != 'channel_access_token' %}
+          # @param channel_access_token [String] The channel access token for authorization.
+            {%- endif %}
+          # @param http_options [Hash] HTTP options (same as Net::HTTP options).
+          #   See: https://docs.ruby-lang.org/en/3.4/Net/HTTP.html to understand the options.
+          #
+          # @example
+          #   @client ||= Line::Bot::V2::{{ packageName | camelize }}::Api{{ operations.classname.indexOf('Blob') != -1 ? 'Blob' : '' }}Client.new(
+            {%- if packageName == 'module_attach' %}
+          #     channel_id: "YOUR_CHANNEL_ID",
+          #     channel_secret: "YOUR_CHANNEL_SECRET",
+            {%- elseif packageName != 'channel_access_token' %}
+          #     channel_access_token: "YOUR_CHANNEL_ACCESS_TOKEN",
+            {%- endif %}
+          #     http_options: {
+          #       open_timeout: 5,
+          #       read_timeout: 5,
+          #     }
+          #   )
           def initialize: (
             ?base_url: String?
             {%- if packageName == 'channel_access_token' -%}
@@ -23,19 +50,29 @@ module Line
           {%- for op in operations.operation %}
 
           # {{ op.notes }}
+          # This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
+          # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
           #
           {% for param in op.allParams -%}
-          # @param {{ param.paramName }} {{ param.description }}
+          # @param {{param.paramName}} [{{ param.dataType }}{{ param.required ? '' : ', nil' }}] {{param.description}}
           {% endfor -%}
           {% if op.isDeprecated -%}
-           # @deprecated
+          # @deprecated
           {% endif -%}
           {% if op.externalDocs.description != null -%}
           # {{op.externalDocs.description}}
           {% endif -%}
           {% if op.externalDocs.url != null -%}
           # @see {{op.externalDocs.url}}
-          {% endif -%}
+          {%- endif %}
+          {%- for response in op.responses %}
+          {%- if response.content['application/json'].schema.complexType != null %}
+          # @return [Array(Line::Bot::V2::{{ packageName | camelize }}::{{ response.content['application/json'].schema.complexType }}, Integer, Hash{String => String})] when HTTP status code is {{ response.code }}
+          {%- else %}
+          # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is {{ response.code }}
+          {%- endif %}
+          {%- endfor %}
+          # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
           def {{op.nickname}}_with_http_info: (
             {%- for param in op.allParams %}
             {{ param.required ? '' : '?' }}{{param.paramName}}: {{ param.dataType }}{{ param.required ? '' : '?' }}{{ loop.last ? '' : ', ' -}}
@@ -48,19 +85,29 @@ module Line
           )
 
           # {{ op.notes }}
+          # This requests to <code>{{ op.httpMethod }} {{ endpoint(operations.classname) }}{{ op.path }}</code>
+          # When you want to get HTTP status code or response headers, use {{ '{#' }}{{op.nickname}}_with_http_info} instead of this.
           #
           {% for param in op.allParams -%}
-           # @param {{ param.paramName }} {{ param.description }}
+          # @param {{param.paramName}} [{{ param.dataType }}{{ param.required ? '' : ', nil' }}] {{param.description}}
           {% endfor -%}
           {% if op.isDeprecated -%}
-           # @deprecated
+          # @deprecated
           {% endif -%}
           {% if op.externalDocs.description != null -%}
           # {{op.externalDocs.description}}
           {% endif -%}
           {% if op.externalDocs.url != null -%}
           # @see {{op.externalDocs.url}}
-          {% endif -%}
+          {%- endif %}
+          {%- for response in op.responses %}
+          {%- if response.content['application/json'].schema.complexType != null %}
+          # @return [Line::Bot::V2::{{ packageName | camelize }}::{{ response.content['application/json'].schema.complexType }}] when HTTP status code is {{ response.code }}
+          {%- else %}
+          # @return [String, nil] when HTTP status code is {{ response.code }}
+          {%- endif %}
+          {%- endfor %}
+          # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
           def {{op.nickname}}: (
             {%- for param in op.allParams %}
             {{ param.required ? '' : '?' }}{{param.paramName}}: {{ param.dataType }}{{ param.required ? '' : '?' }}{{ loop.last ? '' : ', ' -}}

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

@@ -36,6 +36,29 @@ module Line
           {% endif -%}
           {% endif -%}
           {% endfor %}
+
+          {# @param #}
+          {%- for variable in model.model.vars -%}
+          {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name -%}
+          {% if variable.openApiType == 'array' -%}
+          {% if variable.items.isModel -%}
+          # @param {{ variable.name }} [{{ "Array[#{variable.items.openApiType}, Hash[Symbol, untyped]]" }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }}
+          {% elseif variable.items.allowableValues != null -%}
+          # @param {{ variable.name }} [Array[{% for value in variable.items.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : ',' }}{% endfor -%}]{% if not variable.required %},nil{% endif -%}] {{ variable.description }}
+          {% else -%}
+          # @param {{ variable.name }} [{{ variable.items.openApiType ? "Array[#{typeMapping[variable.items.openApiType]}]" : 'Array[untyped]' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }}
+          {% endif -%}
+          {% elseif variable.isModel -%}
+          # @param {{ variable.name }} [{{ variable.openApiType }}, Hash[Symbol, untyped]{% if not variable.required %}, nil{% endif -%}] {{ variable.description }}
+          {% else -%}
+          {% if variable.allowableValues != null -%}
+          # @param {{ variable.name }} [String{% if not variable.required %},nil{% endif -%}] ({% for value in variable.allowableValues.values %}'{{ value }}'{{ loop.last ? '' : '|' }}{% endfor %}) {{ variable.description }}
+          {% else -%}
+          # @param {{ variable.name }} [{{ typeMapping[variable.openApiType] ? typeMapping[variable.openApiType] : 'untyped' }}{% if not variable.required %},nil{% endif -%}] {{ variable.description }}
+          {% endif -%}
+          {% endif -%}
+          {% endif -%}
+          {% endfor -%}
           def initialize: (
             {% for variable in model.model.vars -%}
             {% if model.model.vendorExtensions.get("x-selector").propertyName != variable.name -%}
@@ -63,10 +86,16 @@ module Line
             **untyped dynamic_attributes
           ) -> void
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::{{ packageName | camelize }}::{{ model.model.classname }}] Instance of the class
           def self.create: (Hash[Symbol, untyped]) -> {{ model.model.classname }}
 
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
           def ==: (untyped other) -> bool
 
+          # @return [Integer] Hash code of the object
           def hash: () -> Integer
           {%- if model.model.vendorExtensions.get("x-children") != null %}
 

lib/line/bot/v2/channel_access_token/model/channel_access_token_key_ids_response.rb

@@ -39,6 +39,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::ChannelAccessTokenKeyIdsResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/channel_access_token/model/error_response.rb

@@ -44,6 +44,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::ErrorResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/channel_access_token/model/issue_channel_access_token_response.rb

@@ -57,6 +57,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueChannelAccessTokenResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/channel_access_token/model/issue_short_lived_channel_access_token_response.rb

@@ -51,6 +51,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueShortLivedChannelAccessTokenResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/channel_access_token/model/issue_stateless_channel_access_token_response.rb

@@ -51,6 +51,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::IssueStatelessChannelAccessTokenResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/channel_access_token/model/verify_channel_access_token_response.rb

@@ -50,6 +50,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::ChannelAccessToken::VerifyChannelAccessTokenResponse] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end

lib/line/bot/v2/insight/model/age_tile.rb

@@ -43,6 +43,9 @@ def initialize(
             end
           end
 
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::Insight::AgeTile] Instance of the class
           def self.create(args) # steep:ignore
             return new(**args) # steep:ignore
           end