test-words-api-client-sdk 3.0.1 → 3.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -10
- 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: 8749ac5c2cc40619d44645aedc5e75e30debaec9b1c91b600f5ac226bc6d06c3
|
|
4
|
+
data.tar.gz: e6058d665ac223f37ebf4103cbafb17de030516f9d008a4941305a9e4b8a8b88
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c8e2921849d954e8aca91ac1c770168c1f115c007f8c036405a7247582fbecf31344479460aa91141a3f8df7e62a8c6cc26d41ef5f16403bfe61ba6d371f0ef8
|
|
7
|
+
data.tar.gz: 56f926d7b712fdd84601be1070c31522b9c98b783d72d1a895d231a4ee3b472dd7e9b7fb618cd163b3c1626c9493a33cf1eec714274b73e1958bffc0f42cd7ce
|
data/README.md
CHANGED
|
@@ -10,16 +10,16 @@ Words API lets you retrieve information about English words, including definitio
|
|
|
10
10
|
Install the gem from the command line:
|
|
11
11
|
|
|
12
12
|
```ruby
|
|
13
|
-
gem install test-words-api-client-sdk -v 3.0.
|
|
13
|
+
gem install test-words-api-client-sdk -v 3.0.2
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Or add the gem to your Gemfile and run `bundle`:
|
|
17
17
|
|
|
18
18
|
```ruby
|
|
19
|
-
gem 'test-words-api-client-sdk', '3.0.
|
|
19
|
+
gem 'test-words-api-client-sdk', '3.0.2'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/3.0.
|
|
22
|
+
For additional gem details, see the [RubyGems page for the test-words-api-client-sdk gem](https://rubygems.org/gems/test-words-api-client-sdk/versions/3.0.2).
|
|
23
23
|
|
|
24
24
|
## Test the SDK
|
|
25
25
|
|
|
@@ -31,7 +31,7 @@ rake
|
|
|
31
31
|
|
|
32
32
|
## Initialize the API Client
|
|
33
33
|
|
|
34
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
34
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/client.md)
|
|
35
35
|
|
|
36
36
|
The following parameters are configurable for the API Client:
|
|
37
37
|
|
|
@@ -46,7 +46,7 @@ The following parameters are configurable for the API Client:
|
|
|
46
46
|
| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
|
47
47
|
| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
|
48
48
|
| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
|
49
|
-
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
49
|
+
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
|
|
50
50
|
|
|
51
51
|
The API client can be initialized as follows:
|
|
52
52
|
|
|
@@ -62,15 +62,15 @@ client = WordsApi::Client.new(
|
|
|
62
62
|
|
|
63
63
|
This API uses the following authentication schemes.
|
|
64
64
|
|
|
65
|
-
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
65
|
+
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/auth/custom-header-signature.md)
|
|
66
66
|
|
|
67
67
|
## List of APIs
|
|
68
68
|
|
|
69
|
-
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
69
|
+
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/controllers/ap-is.md)
|
|
70
70
|
|
|
71
71
|
## Classes Documentation
|
|
72
72
|
|
|
73
|
-
* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
74
|
-
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
75
|
-
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.
|
|
73
|
+
* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/utility-classes.md)
|
|
74
|
+
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/http-response.md)
|
|
75
|
+
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/3.0.2/doc/http-request.md)
|
|
76
76
|
|