test-words-api-client-sdk 1.0.1 → 1.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: 995a22d939c12682754e8227af16d99aca3c73cd8e43b14e8af467ee328b360b
|
|
4
|
+
data.tar.gz: 01f297aadb4c62a106b150cf742905e4a0e15f333f9b89b150915559856e35e7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3a96ecf3946e8e893ac72131052c93beb9c391b19309148b63ed6a0a685f0d14bd97a6aa313f52b35eedd6465a025abb46bb3b595a20a8336f3d85923c8d6c5b
|
|
7
|
+
data.tar.gz: 8861151a85c9fabd984ec014e621fc7e740212f0c2d48acf2b2667cc939584cc85f668f2987285652c19fb749ddcc7cbc9eee7af3a5b3acfb0e28c180e2a6800
|
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.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', '1.0.
|
|
19
|
+
gem 'test-words-api-client-sdk', '1.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/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.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/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.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/1.0.
|
|
49
|
+
| `custom_header_authentication_credentials` | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.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/1.0.
|
|
65
|
+
* [`RapidAPI-Key (Custom Header Signature)`](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.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/1.0.
|
|
69
|
+
* [AP Is](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.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/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.2/doc/utility-classes.md)
|
|
74
|
+
* [HttpResponse](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.2/doc/http-response.md)
|
|
75
|
+
* [HttpRequest](https://www.github.com/sufyankhanrao/test-words-api-ruby-sdk/tree/1.0.2/doc/http-request.md)
|
|
76
76
|
|