mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-12-11 13:12:45 +00:00
[ruby] document the *_with_http_info methods (#8094)
This commit is contained in:
@@ -9,27 +9,44 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
## call_123_test_special_tags
|
||||
|
||||
> Client call_123_test_special_tags(client)
|
||||
> <Client> call_123_test_special_tags(client)
|
||||
|
||||
To test special tags
|
||||
|
||||
To test special tags and operation ID starting with number
|
||||
|
||||
### Example
|
||||
### Examples
|
||||
|
||||
```ruby
|
||||
# load the gem
|
||||
require 'petstore'
|
||||
|
||||
api_instance = Petstore::AnotherFakeApi.new
|
||||
client = Petstore::Client.new # Client | client model
|
||||
|
||||
begin
|
||||
#To test special tags
|
||||
# To test special tags
|
||||
result = api_instance.call_123_test_special_tags(client)
|
||||
p result
|
||||
rescue Petstore::ApiError => e
|
||||
puts "Exception when calling AnotherFakeApi->call_123_test_special_tags: #{e}"
|
||||
puts "Error when calling AnotherFakeApi->call_123_test_special_tags: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
#### Using the call_123_test_special_tags_with_http_info variant
|
||||
|
||||
This returns an Array which contains the response data, status code and headers.
|
||||
|
||||
> <Array(<Client>, Integer, Hash)> call_123_test_special_tags_with_http_info(client)
|
||||
|
||||
```ruby
|
||||
begin
|
||||
# To test special tags
|
||||
data, status_code, headers = api_instance.call_123_test_special_tags_with_http_info(client)
|
||||
p status_code # => 2xx
|
||||
p headers # => { ... }
|
||||
p data # => <Client>
|
||||
rescue Petstore::ApiError => e
|
||||
puts "Error when calling AnotherFakeApi->call_123_test_special_tags_with_http_info: #{e}"
|
||||
end
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user