test-words-api-client-sdk 1.0.3 → 1.0.4
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: a5d7fd23f2d3dc099e4a2c449437e4dc506f761dfdcf822ef5c7dd7a982feef8
|
|
4
|
+
data.tar.gz: e45663f351734cda4104fcbd400f3330e67c1156cf6eb3269f06db8ee6f12129
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d51a264d704f4bf7a342987309daafea7355815b4c6c1d7defab5f66b4176d5b6a30ae168c820b335873a1f04060cb137d4ea6f6c4185af6139a27a734a40780
|
|
7
|
+
data.tar.gz: 85dc6235782bb03afa64cb59475d05d2c5ad4b5052858fa74891541a03c484179818cbc54eefa961cb7d0c1afd5e92c42b0cb590cb6866b72bd4cee7e28e07fe
|
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 1.0.
|
|
13
|
+
gem install test-words-api-client-sdk -v 1.0.4
|
|
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', '1.0.
|
|
19
|
+
gem 'test-words-api-client-sdk', '1.0.4'
|
|
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/1.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/1.0.4).
|
|
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/1.0.
|
|
34
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/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/1.0.
|
|
49
|
+
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/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/1.0.
|
|
65
|
+
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/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/1.0.
|
|
69
|
+
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/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/1.0.
|
|
74
|
-
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.
|
|
75
|
-
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.
|
|
73
|
+
* [Utility Classes](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/doc/utility-classes.md)
|
|
74
|
+
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/doc/http-response.md)
|
|
75
|
+
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.4/doc/http-request.md)
|
|
76
76
|
|